diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index 8a293a131c..9449b8ed85 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -13,14 +13,13 @@ ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -ROBOTS: NOINDEX, NOFOLLOW description: "Learn about using the Exchange Online V2 module in scripts and other long-running tasks with modern authentication and app-only authentication." --- # App-only authentication for unattended scripts in the EXO V2 module > [!NOTE] -> This feature and the required `2.0.3` version of the EXO V2 module are now Generally Available. For instructions on how to install or update to this version of the module, see [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). +> The features and procedures described in this article require version 2.0.3 or later of the EXO V2 module. For instructions on how to install or update to this version of the module, see [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). Auditing and reporting scenarios in Exchange Online often involve scripts that run unattended. In most cases, these unattended scripts access Exchange Online PowerShell using Basic authentication (a username and password). Even when the connection to Exchange Online PowerShell uses modern authentication, the credentials are stored in a local file or a secret vault that's accessed at run-time. @@ -31,7 +30,7 @@ The following examples show how to use the Exchange Online PowerShell V2 module - Connect using a local certificate: ```powershell - Connect-ExchangeOnline -CertificateFilePath "C:\Users\johndoe\Desktop\automation-cert.pfx" -CertificatePassword (ConvertTo-SecureString -String "" -AsPlainText -Force) -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + Connect-ExchangeOnline -CertificateFilePath "C:\Users\johndoe\Desktop\automation-cert.pfx" -CertificatePassword (ConvertTo-SecureString -String "" -AsPlainText -Force) -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" ``` - Connect using a certificate thumbprint: @@ -41,7 +40,7 @@ The following examples show how to use the Exchange Online PowerShell V2 module ``` When you use the _CertificateThumbPrint_ parameter, the certificate needs to be installed on the computer where you are running the command. The certificate should be installed in the user certificate store. - + - Connect using a certificate object: ```powershell @@ -50,34 +49,42 @@ The following examples show how to use the Exchange Online PowerShell V2 module When you use the _Certificate_ parameter, the certificate does not need to be installed on the computer where you are running the command. This parameter is applicable for scenarios where the certificate object is stored remotely and fetched at runtime during script execution. +> [!TIP] +> +> - In the **Connect-ExchangeOnline** commands, be sure to use an `.onmicrosoft.com` domain in the _Organization_ parameter value. Otherwise, you might encounter cryptic permission issues when you run commands in the app context. +> +> - App-only authentication does not support delegation. Unattended scripting in delegation scenarios is supported with the Secure App Model. For more information, go [here](https://docs.microsoft.com/powershell/partnercenter/multi-factor-auth#exchange). + ## How does it work? The EXO V2 module uses the Active Directory Authentication Library to fetch an app-only token using the application Id, tenant Id (organization), and certificate thumbprint. The application object provisioned inside Azure AD has a Directory Role assigned to it, which is returned in the access token. Exchange Online configures the session RBAC using the directory role information that's available in the token. -## Setup app-only authentication +## Set up app-only authentication An initial onboarding is required for authentication using application objects. Application and service principal are used interchangeably, but an application is like a class object while a service principal is like an instance of the class. You can learn more about this at [Application and service principal objects in Azure Active Directory](https://docs.microsoft.com/azure/active-directory/develop/app-objects-and-service-principals). For a detailed visual flow about creating applications in Azure AD, see . -1. Register the application in Azure AD at . +1. [Register the application in Azure AD](#step-1-register-the-application-in-azure-ad). -2. Assign permissions to access Exchange Online. +2. [Assign Exchange Online API permissions to the application](#step-2-assign-api-permissions-to-the-application). An application object has the default permission `User.Read`. For the application object to access Exchange Online resources, it needs to have the Application permission `Exchange.ManageAsApp`. -3. Attach a certificate. +3. [Generate a self-signed certificate](#step-3-generate-a-self-signed-certificate) - For app-only authentication in Azure AD, you typically use a certificate to request access. Anyone who has the certificate and its private key can use the app, and the permissions granted to the app. - Create and configure a self-signed X.509 certificate, which will be used to authenticate your Application against Azure AD, while requesting the app-only access token. - - This is similar to generating a password for user accounts. The certificate can be self-signed as well. See the [Appendix](#step-3-generate-a-self-signed-certificate) section later in this topic for instructions for generating certificates in PowerShell. - + - This is similar to generating a password for user accounts. The certificate can be self-signed as well. See the [Appendix](#step-3-generate-a-self-signed-certificate) section later in this article for instructions for generating certificates in PowerShell. + > [!NOTE] > Cryptography: Next Generation (CNG) certificates are not supported for app-only authentication with Exchange. CNG certificates are created by default in modern Windows versions. You must use a certificate from a CSP key provider. The [Appendix](#step-3-generate-a-self-signed-certificate) section covers two supported methods to create a CSP certificate. -4. Assign RBAC roles +4. [Attach the certificate to the Azure AD application](#step-4-attach-the-certificate-to-the-azure-ad-application) + +5. [Assign Azure AD roles to the application](#step-5-assign-azure-ad-roles-to-the-application) The application needs to have the appropriate RBAC roles assigned. Because the apps are provisioned in Azure AD, you can use any of the built-in roles. The following roles are supported: @@ -91,98 +98,147 @@ For a detailed visual flow about creating applications in Azure AD, see and sign in with your Azure AD account. +1. Open the Azure AD portal at . 2. Under **Manage Azure Active Directory**, click **View**. -3. Under **Manage**, select **App registrations** and then click **New registration**. + ![Click View in the Azure AD portal under Manage Azure Active Directory](media/exo-app-only-auth-manage-ad-view.png) + +3. On the **Overview** page that opens, under **Manage**, select **App registrations**. -4. In the **Register an application** page that appears, configure the following settings: + ![Select App registrations](media/exo-app-only-auth-select-app-registrations.png) - - **Name**: Enter something descriptive. +4. On the **App registrations** page that opens, click **New registration**. - - **Supported account types**: Select **Accounts in this organizational directory only (\ only - Single tenant)**. + ![Select New registration on the App registrations page](media/exo-app-only-auth-new-app-registration.png) - - **Redirect URI (optional)**: In the first box, select **Web**. In the second box, enter the URI where the access token is sent. + On the **Register an application** page that opens, configure the following settings: + + - **Name**: Enter something descriptive. For example, ExO PowerShell CBA. + + - **Supported account types**: Verify that **Accounts in this organizational directory only (\ only - Single tenant)** is selected. + + - **Redirect URI (optional)**: In the first box, verify that **Web** is selected. In the second box, enter the URI where the access token is sent. Note that you can't create credentials for [native applications](https://docs.microsoft.com/azure/active-directory/manage-apps/application-proxy-configure-native-client-application), because you can't use that type for automated applications. - ![Register an application](media/app-only-auth-register-app.png) + ![Register an application](media/exo-app-only-auth-register-app.png) When you're finished, click **Register**. - Leave the page that appears open. You'll use it in the next step. +5. Leave the app page that you return to open. You'll use it in the next step. ## Step 2: Assign API permissions to the application -You need to assign the API permission `Exchange.ManageAsApp` so the application can manage Exchange Online. API permissions are required because they have consent flow enabled, which allows auditing (directory roles don't have consent flow). +> [!NOTE] +> The procedures in this section replace any default permissions that were automatically configured for the new app. The app doesn't need the default permissions that were replaced. -1. Select **API permissions**. +1. On the app page under **Management**, select **Manifest**. -2. In the **Configured permissions** page that appears, click **Add permission**. + ![Select Manifest on the application properties page](media/exo-app-only-auth-select-manifest.png) -3. In the flyout that appears, select **Exchange**. +2. On the **Manifest** page that opens, find the `requiredResourceAccess` entry (on or about line 44). - ![Select Exchange API permssions](media/app-only-auth-exchange-api-perms.png) + Modify the `resourceAppId`, `resourceAccess`, `id`, and `type` values as shown in the following code snippet: -4. In the flyout that appears, click **Application permissions**. + ```json + "requiredResourceAccess": [ + { + "resourceAppId": "00000002-0000-0ff1-ce00-000000000000", + "resourceAccess": [ + { + "id": "dc50a0fb-09a3-484d-be87-e023b12c6440", + "type": "Role" + } + ] + } + ], + ``` -5. In the **Select permissions** section that appears on the page, expand **Exchange** and select **Exchange.ManageAsApp** + When you're finished, click **Save**. - ![Select Exchange.ManageAsApp permssions](media/app-only-auth-exchange-manageasapp.png) +3. Still on the **Manifest** page, under **Management**, select **API permissions**. - When you're finished, click **Add permissions**. + ![Select API permissions on the application properties page](media/exo-app-only-auth-select-api-permissions.png) -6. Back on the **Configured permissions** page that appears, click **Grant admin consent for \**, and select **Yes** in the dialog that appears. + On the **API permissions** page that opens, do the following steps: -7. Close the flyout when you're finished. + - **API / Permissions name**: Verify the value **Exchange.ManageAsApp** is shown. + + - **Status**: The current incorrect value is **Not granted for \**, and this value needs to be changed. + + ![Original incorrect API permissions](media/exo-app-only-auth-original-permissions.png) + + Select **Grant admin consent for \**, read the confirmation dialog that opens, and then click **Yes**. + + The **Status** value should now be **Granted for \**. + + ![Admin consent granted](media/exo-app-only-auth-admin-consent-granted.png) + +4. Close the current **API permissions** page (not the browser tab) to return to the **App registrations** page. You'll use it in an upcoming step. ## Step 3: Generate a self-signed certificate Create a self-signed x.509 certificate using one of the following methods: -- (Recommended) Use the [New-SelfSignedCertificate](https://docs.microsoft.com/powershell/module/pkiclient/new-selfsignedcertificate), [Export-Certificate](https://docs.microsoft.com/powershell/module/pkiclient/export-certificate) and [Export-PfxCertificate](https://docs.microsoft.com/powershell/module/pkiclient/export-pfxcertificate) cmdlets to request a self-signed certificate and export it to `.cer` and `.pfx`. +- (Recommended) Use the [New-SelfSignedCertificate](https://docs.microsoft.com/powershell/module/pkiclient/new-selfsignedcertificate), [Export-Certificate](https://docs.microsoft.com/powershell/module/pkiclient/export-certificate) and [Export-PfxCertificate](https://docs.microsoft.com/powershell/module/pkiclient/export-pfxcertificate) cmdlets in an elevated (run as administrator) Windows PowerShell session to request a self-signed certificate and export it to `.cer` and `.pfx` (SHA1 by default). -```powershell -# Create certificate -$mycert = New-SelfSignedCertificate -DnsName "example.com" -CertStoreLocation "cert:\LocalMachine\My" -NotAfter (Get-Date).AddYears(1) -KeySpec KeyExchange + ```powershell + # Create certificate + $mycert = New-SelfSignedCertificate -DnsName "contoso.org" -CertStoreLocation "cert:\LocalMachine\My" -NotAfter (Get-Date).AddYears(1) -KeySpec KeyExchange -# Export certificate to .pfx file -$mycert | Export-PfxCertificate -FilePath mycert.pfx -Password $(ConvertTo-SecureString -String "1234" -Force -AsPlainText) + # Export certificate to .pfx file + $mycert | Export-PfxCertificate -FilePath mycert.pfx -Password $(ConvertTo-SecureString -String "P@s$w0rd1234" -AsPlainText -Force) -# Export certificate to .cer file -$mycert | Export-Certificate -FilePath mycert.cer -``` + # Export certificate to .cer file + $mycert | Export-Certificate -FilePath mycert.cer + ``` -- Use the [Create-SelfSignedCertificate script](https://github.com/SharePoint/PnP-Partner-Pack/blob/master/scripts/Create-SelfSignedCertificate.ps1). Note that this script generates SHA1 certificates. +- Use the [Create-SelfSignedCertificate script](https://github.com/SharePoint/PnP-Partner-Pack/blob/master/scripts/Create-SelfSignedCertificate.ps1) script to generate SHA1 certificates. ```powershell - .\Create-SelfSignedCertificate.ps1 -CommonName "MyCompanyName" -StartDate 2020-04-01 -EndDate 2022-04-01 + .\Create-SelfSignedCertificate.ps1 -CommonName "MyCompanyName" -StartDate 2021-01-06 -EndDate 2022-01-06 ``` ## Step 4: Attach the certificate to the Azure AD application After you register the certificate with your application, you can use the public key (`.pfx` file) or the thumbprint for authentication. -1. In the Azure AD portal under **Manage Azure Active Directory**, click **View**. +1. On the **Apps registration** page from the end of [Step 2](#step-2-assign-api-permissions-to-the-application), select your application. -2. Under **Manage**, select **App registrations**. + If you need to get back to **Apps registration** page, do the following steps: -3. On the **App registrations** page that appears, select your application. + 1. Open the Azure AD portal at . + 2. Under **Manage Azure Active Directory**, click **View**. + 3. Under **Manage**, select **App registrations**. -4. Under **Manage**, select **Certificates & secrets**. + ![Apps registration page where you select your app](media/exo-app-only-auth-app-registration-page.png) -5. On the **Certificates & secrets** page that opens, click **Upload certificate**. +2. On the application page that opens, under **Manage**, select **Certificates & secrets**. - ![Click Upload certificate](media/app-only-auth-upload-cert.png) + ![Select Certificates & Secrets on the application properties page](media/exo-app-only-auth-select-certificates-and-secrets.png) -6. In the dialog that appears, browse to the self-signed certificate (`.cer` file) you created in the previous step, and then click **Add**. +3. On the **Certificates & secrets** page that opens, click **Upload certificate**. -## Step 5: Assign a role to the application + ![Select Upload certificate on the Certificates & secrets page](media/exo-app-only-auth-select-upload-certificate.png) + + In the dialog that opens, browse to the self-signed certificate (`.cer` file) that you created in [Step 3](#step-3-generate-a-self-signed-certificate). + + ![Browse to the certificate and then click Add](media/exo-app-only-auth-upload-certificate-dialog.png) + + When you're finished, click **Add**. + + The certificate is now shown in the **Certificates** section. + + ![Application page showing that the certificate was added](media/exo-app-only-auth-certificate-successfully-added.png) + +4. Close the current **Certificates & secrets** page, and then the **App registrations** page to return to the main page. You'll use it in the next step. + +## Step 5: Assign Azure AD roles to the application Azure AD has more than 50 admin roles available. For app-only authentication in Exchange Online, we currently support the previously mentioned roles: @@ -194,12 +250,30 @@ Azure AD has more than 50 admin roles available. For app-only authentication in - Exchange administrator - Global Reader -1. In the Azure AD portal under **Manage Azure Active Directory**, click **View**. +For general instructions about assigning roles in Azure AD, see [View and assign administrator roles in Azure Active Directory](https://docs.microsoft.com/azure/active-directory/roles/manage-roles-portal). + +1. On the Azure AD portal at , under **Manage Azure Active Directory**, click **View**. + + ![View in the Azure AD portal under Manage Azure Active Directory](media/exo-app-only-auth-manage-ad-view.png) + +2. On the **Overview** page that opens, under **Manage**, select **Roles and administrators**. + + ![Select Roles and administrators from the overview page](media/exo-app-only-auth-select-roles-and-administrators.png) + +3. On the **Roles and administrators** page that opens, find and select one of the supported roles by _clicking on the name of the role_ (not the check box) in the results. + + ![Find and select a supported role by clicking on the role name](media/exo-app-only-auth-find-and-select-supported-role.png) + +4. On the **Assignments** page that opens, click **Add assignments**. + + ![Select Add assignments on the role assignments page](media/exo-app-only-auth-role-assignments-click-add-assignments.png) + +5. In the **Add assignments** flyout that opens, find and select the app that you created in [Step 1](#step-1-register-the-application-in-azure-ad). -2. Under **Manage**, select **Roles and administrators**. + ![Find and select your app on the Add assignments flyout](media/exo-app-only-auth-find-add-select-app-for-assignment.png) -3. Select one of the supported roles. On the **Assignments** page that appears, click **Add assignments** + When you're finished, click **Add**. -4. In the **Add assignments** flyout that appears, find and select the application, and then click **Add**. +6. Back on the **Assignments** page, verify that the app has been assigned to the role. - ![Add a role assignment](media/app-only-auth-role-assignment.png) + ![The role assignments page after to added the app to the role](media/exo-app-only-auth-app-assigned-to-role.png) diff --git a/exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md b/exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md index 048bbaba47..f7441b1ed5 100644 --- a/exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md +++ b/exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md @@ -16,7 +16,7 @@ description: "Use remote PowerShell to connect to a standalone Exchange Online P # Bssic auth - Connect to Exchange Online Protection PowerShell > [!NOTE] -> The connection instructions in this topic [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163) due to the security concerns around Basic authentication. Instead, you should use the Exchange Online PowerShell V2 module (the EXO V2 module) to connect to Exchange Online Protection PowerShell. For instructions, see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). +> The connection instructions in this article [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163) due to the security concerns around Basic authentication. Instead, you should use the Exchange Online PowerShell V2 module (the EXO V2 module) to connect to Exchange Online Protection PowerShell. For instructions, see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). In standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes, standalone EOP PowerShell allows you to manage your EOP organization from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to EOP. It's a simple three-step process where you enter your Microsoft 365 credentials, provide the required connection settings, and then import the EOP cmdlets into your local Windows PowerShell session so that you can use them. @@ -30,7 +30,9 @@ The following introductory video shows you how to connect to and use Exchange On - Estimated time to complete: 5 minutes -- **The procedures in this topic are only for EOP organizations that don't have Exchange Online mailboxes** (for example, you have a standalone EOP subscription that protects your on-premises email environment). If you have a Microsoft 365 subscription includes Exchange Online mailboxes, you can't connect to Exchange Online Protection PowerShell. The same features are available in [Exchange Online PowerShell](exchange-online-powershell.md). +- **The procedures in this article are only for EOP organizations that don't have Exchange Online mailboxes** (for example, you have a standalone EOP subscription that protects your on-premises email environment). If you have a Microsoft 365 subscription includes Exchange Online mailboxes, you can't connect to Exchange Online Protection PowerShell. The same features are available in [Exchange Online PowerShell](exchange-online-powershell.md). + +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in standalone EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/feature-permissions-in-eop). - You can use the following versions of Windows: @@ -42,7 +44,7 @@ The following introductory video shows you how to connect to and use Exchange On - Windows 7 Service Pack 1 (SP1)\* - Windows Server 2008 R2 SP1\* - \* This version of Windows has reached end of support, and is now only supported when running in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). + \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: @@ -61,7 +63,7 @@ The following introductory video shows you how to connect to and use Exchange On **Note**: You must temporarily enable WinRM to run the following commands. You can enable it by running the command: `winrm quickconfig`. To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - + ```dos winrm get winrm/config/client/auth ``` @@ -140,7 +142,7 @@ If you receive errors, check the following requirements: ## See also -The cmdlets that you use in this topic are Windows PowerShell cmdlets. For more information about these cmdlets, see the following topics. +The cmdlets that you use in this article are Windows PowerShell cmdlets. For more information about these cmdlets, see the following articles. - [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential) - [New-PSSession](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssession) diff --git a/exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md b/exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md index 4ee56d02dd..6dc8c97c0f 100644 --- a/exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md +++ b/exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md @@ -19,7 +19,7 @@ description: "Learn how to use remote PowerShell to connect to Exchange Online w # Basic auth - Connect to Exchange Online PowerShell > [!NOTE] -> The connection instructions in this topic [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163) due to the security concerns around Basic authentication. Instead, you should use the Exchange Online PowerShell V2 module (the EXO V2 module) to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). +> The connection instructions in this article [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163) due to the security concerns around Basic authentication. Instead, you should use the Exchange Online PowerShell V2 module (the EXO V2 module) to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). Exchange Online PowerShell allows you to manage your Exchange Online settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to Exchange Online. It's a simple three-step process where you enter your Microsoft 365 credentials, provide the required connection settings, and then import the Exchange Online cmdlets into your local Windows PowerShell session so that you can use them. @@ -33,7 +33,9 @@ The following introductory video shows you how to connect to and use Exchange On - Estimated time to complete: 5 minutes -- If your on-premises Exchange organization has Exchange Enterprise CAL with Services licenses, you can use the instructions in this topic to connect to your EOP organization. +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in Exchange Online](https://docs.microsoft.com/exchange/permissions-exo/permissions-exo). + +- If your on-premises Exchange organization has Exchange Enterprise CAL with Services licenses, you can use the instructions in this article to connect to your EOP organization. - You can use the following versions of Windows: @@ -45,7 +47,7 @@ The following introductory video shows you how to connect to and use Exchange On - Windows 7 Service Pack 1 (SP1)* - Windows Server 2008 R2 SP1* - \* This version of Windows has reached end of support, and is now only supported when running in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). + \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: @@ -64,7 +66,7 @@ The following introductory video shows you how to connect to and use Exchange On **Note**: You must temporarily enable WinRM to run the following commands. You can enable it by running the command: `winrm quickconfig`. To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - + ```dos winrm get winrm/config/client/auth ``` @@ -144,7 +146,7 @@ If you receive errors, check the following requirements: ## See also -The cmdlets that you use in this topic are Windows PowerShell cmdlets. For more information about these cmdlets, see the following topics. +The cmdlets that you use in this article are Windows PowerShell cmdlets. For more information about these cmdlets, see the following articles. - [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential) - [New-PSSession](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssession) diff --git a/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md b/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md index 72c5ed177e..45dfa3aeea 100644 --- a/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md @@ -17,28 +17,28 @@ description: "Learn how to connect to Security & Compliance Center PowerShell." # Basic auth - Connect to Security & Compliance Center PowerShell > [!NOTE] -> The connection instructions in this topic [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163) due to the security concerns around Basic authentication. Instead, you should use the Exchange Online PowerShell V2 module (the EXO V2 module) to connect to Security & Compliance Center PowerShell. For instructions, see [Connect to Security & Compliance Center PowerShell](connect-to-scc-powershell.md). +> The connection instructions in this article [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163) due to the security concerns around Basic authentication. Instead, you should use the Exchange Online PowerShell V2 module (the EXO V2 module) to connect to Security & Compliance Center PowerShell. For instructions, see [Connect to Security & Compliance Center PowerShell](connect-to-scc-powershell.md). Security & Compliance Center PowerShell allows you to manage your Security & Compliance Center settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to the Security & Compliance Center. It's a simple three-step process where you enter your Microsoft 365 credentials, provide the required connection settings, and then import the Security & Compliance Center cmdlets into your local Windows PowerShell session so that you can use them. > [!NOTE] -> The procedures in this topic won't work if: -> +> The procedures in this article won't work if: +> > - Your account uses multi-factor authentication (MFA). -> +> > - Your organization uses federated authentication. -> +> > - A location condition in an Azure Active Directory conditional access policy restricts your access to trusted IPs. -> +> > In these scenarios, you need to download and use the Exchange Online PowerShell V2 module (EXO V2 module) to connect to Security & Compliance Center PowerShell. For instructions, see [Connect to Security & Compliance Center PowerShell using the EXO V2 module](connect-to-scc-powershell.md). -> +> > Some features in the Security & Compliance Center (for example, mailbox archiving) link to existing functionality in Exchange Online. To use PowerShell with these features, you need to connect to Exchange Online PowerShell instead of Security & Compliance Center PowerShell. For instructions, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). ## What do you need to know before you begin? - Estimated time to complete: 5 minutes -- Microsoft 365 global admins have access to the Security & Compliance Center, but everyone else needs to have their access configured for them. For details, see [Give users access to the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/grant-access-to-the-security-and-compliance-center). +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - You can use the following versions of Windows: @@ -50,7 +50,7 @@ Security & Compliance Center PowerShell allows you to manage your Security & Com - Windows 7 Service Pack 1 (SP1)* - Windows Server 2008 R2 SP1* - \* This version of Windows has reached end of support, and is now only supported when running in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). + \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: @@ -145,7 +145,7 @@ If you receive errors, check the following requirements: ## See also -The cmdlets that you use in this topic are Windows PowerShell cmdlets. For more information about these cmdlets, see the following topics. +The cmdlets that you use in this article are Windows PowerShell cmdlets. For more information about these cmdlets, see the following articles. - [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential) - [New-PSSession](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssession) diff --git a/exchange/docs-conceptual/cmdlet-property-sets.md b/exchange/docs-conceptual/cmdlet-property-sets.md index 5366db8364..785ad7b3b8 100644 --- a/exchange/docs-conceptual/cmdlet-property-sets.md +++ b/exchange/docs-conceptual/cmdlet-property-sets.md @@ -18,7 +18,7 @@ description: "Admins can lear about the property sets that are available in the # Property sets in Exchange Online PowerShell V2 cmdlets -This topic describes the property sets that are available in the **Get-EXO\*** cmdlets in the [Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). For more information about property sets, see [Properties and property sets in the EXO V2 module](exchange-online-powershell-v2.md#properties-and-property-sets-in-the-exo-v2-module). +This article describes the property sets that are available in the **Get-EXO\*** cmdlets in the [Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). For more information about property sets, see [Properties and property sets in the EXO V2 module](exchange-online-powershell-v2.md#properties-and-property-sets-in-the-exo-v2-module). For more information about filtering in the EXO V2 module, see [Filters in the EXO V2 module](filters-v2.md). @@ -30,13 +30,13 @@ The available property sets for the **Get-EXOCasMailbox** cmdlet and the propert |PropertySet|Properties| |---|---| -|**Minimum**|ActiveSyncEnabled
DisplayName
ECPEnabled
EmailAddresses
EwsEnabled
ExchangeVersion
Guid
Identity
ImapEnabled
MAPIEnabled
Name
OWAEnabled
OrganizationId
PopEnabled
PrimarySmtpAddress
ServerLegacyDN| -|**ActiveSync**|ActiveSyncAllowedDeviceIDs
ActiveSyncBlockedDeviceIDs
ActiveSyncEnabled
ActiveSyncMailboxPolicy
ActiveSyncMailboxPolicyIsDefaulted
ActiveSyncSuppressReadReceipt
ExternalDirectoryObjectId
Guid
HasActiveSyncDevicePartnership
Identity
Name
OrganizationId| -|**Ews**|EwsAllowMacOutlook
EwsAllowOutlook
EwsEnabled
ExternalDirectoryObjectId
Guid
Identity
Name
OrganizationId| -|**Imap**|ExternalDirectoryObjectId
Guid
Identity
ImapEnableExactRFC822Size
ImapEnabled
ImapForceICalForCalendarRetrievalOption
ImapMessagesRetrievalMimeFormat
ImapSuppressReadReceipt
ImapUseProtocolDefaults
Name
OrganizationId| -|**Mapi**|ExternalDirectoryObjectId
Guid
Identity
MAPIBlockOutlookExternalConnectivity
MAPIBlockOutlookNonCachedMode
MAPIBlockOutlookRpcHttp
MAPIBlockOutlookVersions
MAPIEnabled
MapiHttpEnabled
Name
OrganizationId| -|**Pop**|ExternalDirectoryObjectId
Guid
Identity
Name
OrganizationId
PopEnableExactRFC822Size
PopEnabled
PopMessagesRetrievalMimeFormat
PopSuppressReadReceipt
PopUseProtocolDefaults| -|**ProtocolSettings**|ExternalDirectoryObjectId
ExternalImapSettings
ExternalPopSettings
ExternalSmtpSettings
Guid
Identity
InternalImapSettings
InternalPopSettings
InternalSmtpSettings
Name
OrganizationId| +|**Minimum**|ActiveSyncEnabled
DisplayName
ECPEnabled
EmailAddresses
EwsEnabled
ExchangeVersion
Guid
Identity
ImapEnabled
MAPIEnabled
Name
OWAEnabled
OrganizationId
PopEnabled
PrimarySmtpAddress
ServerLegacyDN| +|**ActiveSync**|ActiveSyncAllowedDeviceIDs
ActiveSyncBlockedDeviceIDs
ActiveSyncEnabled
ActiveSyncMailboxPolicy
ActiveSyncMailboxPolicyIsDefaulted
ActiveSyncSuppressReadReceipt
ExternalDirectoryObjectId
Guid
HasActiveSyncDevicePartnership
Identity
Name
OrganizationId| +|**Ews**|EwsAllowMacOutlook
EwsAllowOutlook
EwsEnabled
ExternalDirectoryObjectId
Guid
Identity
Name
OrganizationId| +|**Imap**|ExternalDirectoryObjectId
Guid
Identity
ImapEnableExactRFC822Size
ImapEnabled
ImapForceICalForCalendarRetrievalOption
ImapMessagesRetrievalMimeFormat
ImapSuppressReadReceipt
ImapUseProtocolDefaults
Name
OrganizationId| +|**Mapi**|ExternalDirectoryObjectId
Guid
Identity
MAPIBlockOutlookExternalConnectivity
MAPIBlockOutlookNonCachedMode
MAPIBlockOutlookRpcHttp
MAPIBlockOutlookVersions
MAPIEnabled
MapiHttpEnabled
Name
OrganizationId| +|**Pop**|ExternalDirectoryObjectId
Guid
Identity
Name
OrganizationId
PopEnableExactRFC822Size
PopEnabled
PopMessagesRetrievalMimeFormat
PopSuppressReadReceipt
PopUseProtocolDefaults| +|**ProtocolSettings**|ExternalDirectoryObjectId
ExternalImapSettings
ExternalPopSettings
ExternalSmtpSettings
Guid
Identity
InternalImapSettings
InternalPopSettings
InternalSmtpSettings
Name
OrganizationId| | **Note**: The following **Get-CasMailbox** parameters aren't available on **Get-EXOCasMailbox**: @@ -55,27 +55,25 @@ For more information, see: The available property sets for the **Get-EXOMailbox** cmdlet and the properties they contain are described in the following table: -**** - |PropertySet|Properties| -||| -|**Minimum**|Alias
DisplayName
DistinguishedName
EmailAddresses
ExchangeVersion
ExternalDirectoryObjectId
Guid
Id
Name
OrganizationId
PrimarySmtpAddress
RecipientType
RecipientTypeDetails
UserPrincipalName| -|**AddressList**|AddressBookPolicy
AddressListMembership
ExternalDirectoryObjectId
GeneratedOfflineAddressBooks
HiddenFromAddressListsEnabled
OfflineAddressBook| -|**Archive**|ArchiveDatabase
ArchiveDomain
ArchiveGuid
ArchiveName
ArchiveQuota
ArchiveRelease
ArchiveState
ArchiveStatus
ArchiveWarningQuota
AutoExpandingArchiveEnabled
DisabledArchiveDatabase
DisabledArchiveGuid
ExternalDirectoryObjectId
JournalArchiveAddress| -|**Audit**|AuditAdmin
AuditDelegate
AuditEnabled
AuditLogAgeLimit
AuditOwner
DefaultAuditSet
ExternalDirectoryObjectId| -|**Custom**|CustomAttribute1
CustomAttribute2
CustomAttribute3
CustomAttribute4
CustomAttribute5
CustomAttribute6
CustomAttribute7
CustomAttribute8
CustomAttribute9
CustomAttribute10
CustomAttribute11
CustomAttribute12
CustomAttribute13
CustomAttribute14
CustomAttribute15
ExtensionCustomAttribute1
ExtensionCustomAttribute2
ExtensionCustomAttribute3
ExtensionCustomAttribute4
ExtensionCustomAttribute5
ExternalDirectoryObjectId| -|**Delivery**|AcceptMessagesOnlyFrom
AcceptMessagesOnlyFromDLMembers
AcceptMessagesOnlyFromSendersOrMembers
DeliverToMailboxAndForward
DowngradeHighPriorityMessagesEnabled
ExternalDirectoryObjectId
ForwardingAddress
ForwardingSmtpAddress
GrantSendOnBehalfTo
MaxBlockedSenders
MaxReceiveSize
MaxSafeSenders
MaxSendSize
MessageCopyForSendOnBehalfEnabled
MessageCopyForSentAsEnabled
MessageRecallProcessingEnabled
MessageTrackingReadStatusEnabled
RecipientLimits
RejectMessagesFrom
RejectMessagesFromDLMembers
RejectMessagesFromSendersOrMembers
RulesQuota| -|**Hold**|ComplianceTagHoldApplied
DelayHoldApplied
ExternalDirectoryObjectId
InPlaceHolds
InactiveMailboxRetireTime
LitigationHoldDate
LitigationHoldDuration
LitigationHoldEnabled
LitigationHoldOwner| -|**Moderation**|BypassModerationFromSendersOrMembers
ExternalDirectoryObjectId
ModeratedBy
ModerationEnabled
SendModerationNotifications| -|**Move**|ExternalDirectoryObjectId
MailboxMoveBatchName
MailboxMoveFlags
MailboxMoveRemoteHostName
MailboxMoveSourceMDB
MailboxMoveStatus
MailboxMoveTargetMDB| -|**Policy**|AddressBookPolicy
DataEncryptionPolicy
EmailAddressPolicyEnabled
ExternalDirectoryObjectId
ManagedFolderMailboxPolicy
PoliciesExcluded
PoliciesIncluded
RemoteAccountPolicy
RetentionPolicy
RetentionUrl
RoleAssignmentPolicy
SharingPolicy
ThrottlingPolicy| -|**PublicFolder**|DefaultPublicFolderMailbox
EffectivePublicFolderMailbox
ExternalDirectoryObjectId
IsExcludedFromServingHierarchy
IsHierarchyReady
IsHierarchySyncEnabled
IsRootPublicFolderMailbox| -|**Quota**|ArchiveQuota
ArchiveWarningQuota
CalendarLoggingQuota
ExternalDirectoryObjectId
IssueWarningQuota
ProhibitSendQuota
ProhibitSendReceiveQuota
RecoverableItemsQuota
RecoverableItemsWarningQuota
RulesQuota
UseDatabaseQuotaDefaults| -|**Resource**|ExternalDirectoryObjectId
IsResource
ResourceCapacity
ResourceCustom
ResourceType
RoomMailboxAccountEnabled| -|**Retention**|EndDateForRetentionHold
ExternalDirectoryObjectId
OrphanSoftDeleteTrackingTime
RetainDeletedItemsFor
RetainDeletedItemsUntilBackup
RetentionComment
RetentionHoldEnabled
RetentionPolicy
RetentionUrl
SingleItemRecoveryEnabled
StartDateForRetentionHold
UseDatabaseRetentionDefaults| -|**SCL**|AntispamBypassEnabled
ExternalDirectoryObjectId
SCLDeleteEnabled
SCLDeleteThreshold
SCLJunkEnabled
SCLJunkThreshold
SCLQuarantineEnabled
SCLQuarantineThreshold
SCLRejectEnabled
SCLRejectThreshold| -|**SoftDelete**|ExternalDirectoryObjectId
IncludeInGarbageCollection
IsInactiveMailbox
IsSoftDeletedByDisable
IsSoftDeletedByRemove
WhenSoftDeleted| -|**StatisticsSeed**|ArchiveDatabaseGuid
DatabaseGuid
ExchangeGuid
ExternalDirectoryObjectId| +|---|---| +|**Minimum**|Alias
DisplayName
DistinguishedName
EmailAddresses
ExchangeVersion
ExternalDirectoryObjectId
Guid
Id
Name
OrganizationId
PrimarySmtpAddress
RecipientType
RecipientTypeDetails
UserPrincipalName| +|**AddressList**|AddressBookPolicy
AddressListMembership
ExternalDirectoryObjectId
GeneratedOfflineAddressBooks
HiddenFromAddressListsEnabled
OfflineAddressBook| +|**Archive**|ArchiveDatabase
ArchiveDomain
ArchiveGuid
ArchiveName
ArchiveQuota
ArchiveRelease
ArchiveState
ArchiveStatus
ArchiveWarningQuota
AutoExpandingArchiveEnabled
DisabledArchiveDatabase
DisabledArchiveGuid
ExternalDirectoryObjectId
JournalArchiveAddress| +|**Audit**|AuditAdmin
AuditDelegate
AuditEnabled
AuditLogAgeLimit
AuditOwner
DefaultAuditSet
ExternalDirectoryObjectId| +|**Custom**|CustomAttribute1
CustomAttribute2
CustomAttribute3
CustomAttribute4
CustomAttribute5
CustomAttribute6
CustomAttribute7
CustomAttribute8
CustomAttribute9
CustomAttribute10
CustomAttribute11
CustomAttribute12
CustomAttribute13
CustomAttribute14
CustomAttribute15
ExtensionCustomAttribute1
ExtensionCustomAttribute2
ExtensionCustomAttribute3
ExtensionCustomAttribute4
ExtensionCustomAttribute5
ExternalDirectoryObjectId| +|**Delivery**|AcceptMessagesOnlyFrom
AcceptMessagesOnlyFromDLMembers
AcceptMessagesOnlyFromSendersOrMembers
DeliverToMailboxAndForward
DowngradeHighPriorityMessagesEnabled
ExternalDirectoryObjectId
ForwardingAddress
ForwardingSmtpAddress
GrantSendOnBehalfTo
MaxBlockedSenders
MaxReceiveSize
MaxSafeSenders
MaxSendSize
MessageCopyForSendOnBehalfEnabled
MessageCopyForSentAsEnabled
MessageRecallProcessingEnabled
MessageTrackingReadStatusEnabled
RecipientLimits
RejectMessagesFrom
RejectMessagesFromDLMembers
RejectMessagesFromSendersOrMembers
RulesQuota| +|**Hold**|ComplianceTagHoldApplied
DelayHoldApplied
ExternalDirectoryObjectId
InPlaceHolds
InactiveMailboxRetireTime
LitigationHoldDate
LitigationHoldDuration
LitigationHoldEnabled
LitigationHoldOwner| +|**Moderation**|BypassModerationFromSendersOrMembers
ExternalDirectoryObjectId
ModeratedBy
ModerationEnabled
SendModerationNotifications| +|**Move**|ExternalDirectoryObjectId
MailboxMoveBatchName
MailboxMoveFlags
MailboxMoveRemoteHostName
MailboxMoveSourceMDB
MailboxMoveStatus
MailboxMoveTargetMDB| +|**Policy**|AddressBookPolicy
DataEncryptionPolicy
EmailAddressPolicyEnabled
ExternalDirectoryObjectId
ManagedFolderMailboxPolicy
PoliciesExcluded
PoliciesIncluded
RemoteAccountPolicy
RetentionPolicy
RetentionUrl
RoleAssignmentPolicy
SharingPolicy
ThrottlingPolicy| +|**PublicFolder**|DefaultPublicFolderMailbox
EffectivePublicFolderMailbox
ExternalDirectoryObjectId
IsExcludedFromServingHierarchy
IsHierarchyReady
IsHierarchySyncEnabled
IsRootPublicFolderMailbox| +|**Quota**|ArchiveQuota
ArchiveWarningQuota
CalendarLoggingQuota
ExternalDirectoryObjectId
IssueWarningQuota
ProhibitSendQuota
ProhibitSendReceiveQuota
RecoverableItemsQuota
RecoverableItemsWarningQuota
RulesQuota
UseDatabaseQuotaDefaults| +|**Resource**|ExternalDirectoryObjectId
IsResource
ResourceCapacity
ResourceCustom
ResourceType
RoomMailboxAccountEnabled| +|**Retention**|EndDateForRetentionHold
ExternalDirectoryObjectId
OrphanSoftDeleteTrackingTime
RetainDeletedItemsFor
RetainDeletedItemsUntilBackup
RetentionComment
RetentionHoldEnabled
RetentionPolicy
RetentionUrl
SingleItemRecoveryEnabled
StartDateForRetentionHold
UseDatabaseRetentionDefaults| +|**SCL**|AntispamBypassEnabled
ExternalDirectoryObjectId
SCLDeleteEnabled
SCLDeleteThreshold
SCLJunkEnabled
SCLJunkThreshold
SCLQuarantineEnabled
SCLQuarantineThreshold
SCLRejectEnabled
SCLRejectThreshold| +|**SoftDelete**|ExternalDirectoryObjectId
IncludeInGarbageCollection
IsInactiveMailbox
IsSoftDeletedByDisable
IsSoftDeletedByRemove
WhenSoftDeleted| +|**StatisticsSeed**|ArchiveDatabaseGuid
DatabaseGuid
ExchangeGuid
ExternalDirectoryObjectId| | **Note**: The following **Get-Mailbox** parameters aren't available on **Get-EXOMailbox**: @@ -98,9 +96,9 @@ The available property sets for the **Get-EXOMailboxStatistics** cmdlet and the **** |PropertySet|Properties| -||| -|**Minimum**|DeletedItemCount
DisplayName
ItemCount
MailboxGuid
TotalDeletedItemSize
TotalItemSize| -|**All**|AssociatedItemCount
AttachmentTableAvailableSize
AttachmentTableTotalSize
DatabaseIssueWarningQuota
DatabaseName
DatabaseProhibitSendQuota
DatabaseProhibitSendReceiveQuota
DeletedItemCount
DisconnectDate
DisconnectReason
DisplayName
DumpsterMessagesPerFolderCountReceiveQuota
DumpsterMessagesPerFolderCountWarningQuota
ExternalDirectoryOrganizationId
FastIsEnabled
FolderHierarchyChildrenCountReceiveQuota
FolderHierarchyChildrenCountWarningQuota
FolderHierarchyDepthReceiveQuota
FolderHierarchyDepthWarningQuota
FoldersCountReceiveQuota
FoldersCountWarningQuota
IsAbandonedMoveDestination
IsArchiveMailbox
IsDatabaseCopyActive
IsHighDensityShard
IsMoveDestination
IsQuarantined
ItemCount
LastLoggedOnUserAccount
LastLogoffTime
LastLogonTime
LegacyDN
MailboxGuid
MailboxMessagesPerFolderCountReceiveQuota
MailboxMessagesPerFolderCountWarningQuota
MailboxType
MailboxTypeDetail
MessageTableAvailableSize
MessageTableTotalSize
NamedPropertiesCountQuota
NeedsToMove
OtherTablesAvailableSize
OtherTablesTotalSize
OwnerADGuid
QuarantineClients
QuarantineDescription
QuarantineEnd
QuarantineFileVersion
QuarantineLastCrash
ResourceUsageRollingAvgDatabaseReads
ResourceUsageRollingAvgRop
ResourceUsageRollingClientTypes
ServerName
StorageLimitStatus
SystemMessageCount
SystemMessageSize
SystemMessageSizeShutoffQuota
SystemMessageSizeWarningQuota
TotalDeletedItemSize
TotalItemSize| +|---|---| +|**Minimum**|DeletedItemCount
DisplayName
ItemCount
MailboxGuid
TotalDeletedItemSize
TotalItemSize| +|**All**|AssociatedItemCount
AttachmentTableAvailableSize
AttachmentTableTotalSize
DatabaseIssueWarningQuota
DatabaseName
DatabaseProhibitSendQuota
DatabaseProhibitSendReceiveQuota
DeletedItemCount
DisconnectDate
DisconnectReason
DisplayName
DumpsterMessagesPerFolderCountReceiveQuota
DumpsterMessagesPerFolderCountWarningQuota
ExternalDirectoryOrganizationId
FastIsEnabled
FolderHierarchyChildrenCountReceiveQuota
FolderHierarchyChildrenCountWarningQuota
FolderHierarchyDepthReceiveQuota
FolderHierarchyDepthWarningQuota
FoldersCountReceiveQuota
FoldersCountWarningQuota
IsAbandonedMoveDestination
IsArchiveMailbox
IsDatabaseCopyActive
IsHighDensityShard
IsMoveDestination
IsQuarantined
ItemCount
LastLoggedOnUserAccount
LastLogoffTime
LastLogonTime
LegacyDN
MailboxGuid
MailboxMessagesPerFolderCountReceiveQuota
MailboxMessagesPerFolderCountWarningQuota
MailboxType
MailboxTypeDetail
MessageTableAvailableSize
MessageTableTotalSize
NamedPropertiesCountQuota
NeedsToMove
OtherTablesAvailableSize
OtherTablesTotalSize
OwnerADGuid
QuarantineClients
QuarantineDescription
QuarantineEnd
QuarantineFileVersion
QuarantineLastCrash
ResourceUsageRollingAvgDatabaseReads
ResourceUsageRollingAvgRop
ResourceUsageRollingClientTypes
ServerName
StorageLimitStatus
SystemMessageCount
SystemMessageSize
SystemMessageSizeShutoffQuota
SystemMessageSizeWarningQuota
TotalDeletedItemSize
TotalItemSize| | For more information, see: @@ -115,12 +113,12 @@ The available property sets for the **Get-EXORecipient** cmdlet and the properti **** |PropertySet|Properties| -||| -|**Minimum**|ExchangeVersion
ExternalDirectoryObjectID
Name
OrganizationId
RecipientType
RecipientTypeDetails| -|**Archive**|ArchiveDatabase
ArchiveGuid
ArchiveRelease
ArchiveState
ArchiveStatus| -|**Custom**|CustomAttribute1
CustomAttribute2
CustomAttribute3
CustomAttribute4
CustomAttribute5
CustomAttribute6
CustomAttribute7
CustomAttribute8
CustomAttribute9
CustomAttribute10
CustomAttribute11
CustomAttribute12
CustomAttribute13
CustomAttribute14
CustomAttribute15
ExtensionCustomAttribute1
ExtensionCustomAttribute2
ExtensionCustomAttribute3
ExtensionCustomAttribute4
ExtensionCustomAttribute5| -|**MailboxMove**|MailboxMoveBatchName
MailboxMoveFlags
MailboxMoveRemoteHostName
MailboxMoveSourceMDB
MailboxMoveStatus
MailboxMoveTargetMDB| -|**Policy**|ActiveSyncMailboxPolicy
ActiveSyncMailboxPolicyIsDefaulted
AddressBookPolicy
EmailAddressPolicyEnabled
ManagedFolderMailboxPolicy
OwaMailboxPolicy
PoliciesExcluded
PoliciesIncluded
RetentionPolicy
SharingPolicy
ShouldUseDefaultRetentionPolicy
UMMailboxPolicy| +|---|---| +|**Minimum**|ExchangeVersion
ExternalDirectoryObjectID
Name
OrganizationId
RecipientType
RecipientTypeDetails| +|**Archive**|ArchiveDatabase
ArchiveGuid
ArchiveRelease
ArchiveState
ArchiveStatus| +|**Custom**|CustomAttribute1
CustomAttribute2
CustomAttribute3
CustomAttribute4
CustomAttribute5
CustomAttribute6
CustomAttribute7
CustomAttribute8
CustomAttribute9
CustomAttribute10
CustomAttribute11
CustomAttribute12
CustomAttribute13
CustomAttribute14
CustomAttribute15
ExtensionCustomAttribute1
ExtensionCustomAttribute2
ExtensionCustomAttribute3
ExtensionCustomAttribute4
ExtensionCustomAttribute5| +|**MailboxMove**|MailboxMoveBatchName
MailboxMoveFlags
MailboxMoveRemoteHostName
MailboxMoveSourceMDB
MailboxMoveStatus
MailboxMoveTargetMDB| +|**Policy**|ActiveSyncMailboxPolicy
ActiveSyncMailboxPolicyIsDefaulted
AddressBookPolicy
EmailAddressPolicyEnabled
ManagedFolderMailboxPolicy
OwaMailboxPolicy
PoliciesExcluded
PoliciesIncluded
RetentionPolicy
SharingPolicy
ShouldUseDefaultRetentionPolicy
UMMailboxPolicy| | **Note**: The following **Get-Recipient** parameters aren't available on **Get-EXORecipient**: diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 2141c6848c..6314715721 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -19,7 +19,7 @@ description: "Learn how to use the Exchange Online PowerShell V2 module to conne The Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module) uses modern authentication and works with multi-factor authentication (MFA) for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the EXO V2 module, see [About the Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). -**This topic contains instructions for how to connect to Exchange Online PowerShell using the EXO V2 module with or without MFA.** +**This article contains instructions for how to connect to Exchange Online PowerShell using the EXO V2 module with or without MFA.** To use the older, less secure remote PowerShell connection instructions that [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163), see [Basic auth - Connect to Exchange Online PowerShell](basic-auth-connect-to-exo-powershell.md). @@ -27,9 +27,11 @@ To use the older Exchange Online Remote PowerShell Module to connect to Exchange ## What do you need to know before you begin? -- The requirements for installing and using the EXO V2 module are described in [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). The rest of the instructions in the topic assume that you've already installed the module. +- The requirements for installing and using the EXO V2 module are described in [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). The rest of the instructions in the article assume that you've already installed the module. -- If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for Exchange Online Protection (EOP), your EOP PowerShell connection instructions are the same as Exchange Online PowerShell as described in this topic. +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in Exchange Online](https://docs.microsoft.com/exchange/permissions-exo/permissions-exo). + +- If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for Exchange Online Protection (EOP), your EOP PowerShell connection instructions are the same as Exchange Online PowerShell as described in this article. > [!TIP] > Having problems? Ask in the [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542) forum. diff --git a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md index 77c9268cd8..26aad04d6b 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md @@ -19,17 +19,19 @@ description: "Learn how to use the Exchange Online PowerShell V2 module to conne The Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module) uses modern authentication and works with multi-factor authentication (MFA) for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the EXO V2 module, see [About the Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). -**This topic contains instructions for how to connect to Exchange Online Protection PowerShell using the EXO V2 module with or without using MFA.** +**This article contains instructions for how to connect to Exchange Online Protection PowerShell using the EXO V2 module with or without using MFA.** To use the older, less secure remote PowerShell connection instructions that [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163), see [Basic auth - Connect to Exchange Online Protection PowerShell](basic-auth-connect-to-eop-powershell.md). ## What do you need to know before you begin? -- **The procedures in this topic are only for Microsoft 365 organizations that don't have Exchange Online mailboxes**. For example, you have a standalone EOP subscription that protects your on-premises email environment. If your Microsoft 365 subscription includes Exchange Online mailboxes, you can't connect to EOP PowerShell; instead, you [connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). +- **The procedures in this article are only for Microsoft 365 organizations that don't have Exchange Online mailboxes**. For example, you have a standalone EOP subscription that protects your on-premises email environment. If your Microsoft 365 subscription includes Exchange Online mailboxes, you can't connect to EOP PowerShell; instead, you [connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). - If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for EOP, your EOP PowerShell connection instructions are the same as Exchange Online PowerShell. Use the Exchange Online PowerShell connection instructions in [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) instead of the instructions in this topic. + If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for EOP, your EOP PowerShell connection instructions are the same as Exchange Online PowerShell. Use the Exchange Online PowerShell connection instructions in [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) instead of the instructions in this article. -- The requirements for installing and using the EXO V2 module are described in [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). The rest of the instructions in the topic assume that you've already installed the module. +- The requirements for installing and using the EXO V2 module are described in [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). The rest of the instructions in the article assume that you've already installed the module. + +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in standalone EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/feature-permissions-in-eop). > [!TIP] > Having problems? Ask for help in the [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351) forum. diff --git a/exchange/docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md b/exchange/docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md index 4ee2c5b657..2889dc75b0 100644 --- a/exchange/docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md @@ -19,15 +19,17 @@ description: "Use Windows PowerShell on a local computer to connect to an Exchan If you don't have the Exchange management tools installed on your local computer, you can use Windows PowerShell to create a remote PowerShell session to an Exchange server. It's a simple three-step process, where you enter your credentials, provide the required connection settings, and then import the Exchange cmdlets into your local Windows PowerShell session so that you can use them. > [!NOTE] -> +> > - We recommend that you use the Exchange Management Shell on any computer that you use to extensively administer Exchange servers. You get the Exchange Management Shell by installing the Exchange management tools. For more information, see [Install the Exchange Server Management Tools](https://docs.microsoft.com/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools) and [Open the Exchange Management Shell](open-the-exchange-management-shell.md). For more information about the Exchange Management Shell, see [Exchange Server PowerShell (Exchange Management Shell)](exchange-management-shell.md). -> +> > - The **Get-ExchangeCertificate** cmdlet does not fully support remote PowerShell. We recommend that you use the Exchange Management Shell instead to get all the properties of this cmdlet. ## What do you need to know before you begin? - Estimated time to complete: less than 5 minutes +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Exchange Server permissions](https://docs.microsoft.com/exchange/permissions/permissions). + - You can use the following versions of Windows: - Windows 10 @@ -38,7 +40,7 @@ If you don't have the Exchange management tools installed on your local computer - Windows 7 Service Pack 1 (SP1)* - Windows Server 2008 R2 SP1* - \* This version of Windows has reached end of support, and is now only supported when running in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). + \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: @@ -100,7 +102,7 @@ If you receive errors, check the following requirements: ## See also -The cmdlets that you use in this topic are Windows PowerShell cmdlets. For more information about these cmdlets, see the following topics. +The cmdlets that you use in this article are Windows PowerShell cmdlets. For more information about these cmdlets, see the following articles. - [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential) - [New-PSSession](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssession) diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index d2638c8df9..91e96dba31 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -19,7 +19,7 @@ description: "Learn how to use the Exchange Online PowerShell V2 module to conne The Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module) uses modern authentication and works with multi-factor authentication (MFA) for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the EXO V2 module, see [About the Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). -**This topic contains instructions for how to connect to Security & Compliance Center PowerShell using the EXO V2 module with or without MFA.** +**This article contains instructions for how to connect to Security & Compliance Center PowerShell using the EXO V2 module with or without MFA.** To use the older, less secure remote PowerShell connection instructions that [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163), see [Basic auth - Connect to Security & Compliance Center PowerShell](basic-auth-connect-to-scc-powershell.md). @@ -27,7 +27,9 @@ To use the older Exchange Online Remote PowerShell Module to connect to Security ## What do you need to know before you begin? -- The requirements for installing and using the EXO V2 module are described in [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). The rest of the instructions in the topic assume that you've already installed the module. +- The requirements for installing and using the EXO V2 module are described in [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). The rest of the instructions in the article assume that you've already installed the module. + +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). ## Connect to Security & Compliance PowerShell using MFA and modern authentication diff --git a/exchange/docs-conceptual/control-remote-powershell-access-to-exchange-servers.md b/exchange/docs-conceptual/control-remote-powershell-access-to-exchange-servers.md index cad982f2e3..7d27b4ef4c 100644 --- a/exchange/docs-conceptual/control-remote-powershell-access-to-exchange-servers.md +++ b/exchange/docs-conceptual/control-remote-powershell-access-to-exchange-servers.md @@ -28,7 +28,7 @@ For additional management tasks related to remote PowerShell, see [Connect to Ex - For detailed information about OPath filter syntax in Exchange, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). -- You need to be assigned permissions before you can perform this procedure or procedures. To see what permissions you need, see the "Remote PowerShell" entry in the [Exchange infrastructure and PowerShell permissions](https://docs.microsoft.com/Exchange/permissions/feature-permissions/infrastructure-permissions) topic. +- You need to be assigned permissions before you can perform this procedure or procedures. To see what permissions you need, see the "Remote PowerShell" entry in the [Exchange infrastructure and PowerShell permissions](https://docs.microsoft.com/Exchange/permissions/feature-permissions/infrastructure-permissions) article. > [!TIP] > Having problems? Ask for help in the [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) forums. @@ -91,7 +91,7 @@ $ | foreach {Set-User -RemotePowerShellEnabled $false This example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their user principal name (UPN). The text file must contain one UPN on each line like this: -> akol@contoso.com
tjohnston@contoso.com
kakers@contoso.com +> akol@contoso.com
tjohnston@contoso.com
kakers@contoso.com After you populate the text file with the user accounts you want to update, run the following commands: diff --git a/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md b/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md index 05bad6f3ab..baf832dab6 100644 --- a/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md @@ -21,7 +21,7 @@ Exchange Online PowerShell enables you to manage your Exchange Online organizati - Estimated time to complete each procedure: less than 5 minutes -- Microsoft 365 global admins have access to Exchange Online PowerShell, and can use the procedures in this topic to configure Exchange Online PowerShell access for other users. For more information about permissions in Exchange Online, see [Feature Permissions in Exchange Online](https://docs.microsoft.com/exchange/permissions-exo/feature-permissions). +- Microsoft 365 global admins have access to Exchange Online PowerShell, and can use the procedures in this article to configure Exchange Online PowerShell access for other users. For more information about permissions in Exchange Online, see [Feature Permissions in Exchange Online](https://docs.microsoft.com/exchange/permissions-exo/feature-permissions). - You can only use Exchange Online PowerShell to perform this procedure. To connect to Exchange Online PowerShell, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). @@ -90,7 +90,7 @@ $ | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false This example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their accounts. The text file must contain one account on each line as follows: -> akol@contoso.com
tjohnston@contoso.com
kakers@contoso.com +> akol@contoso.com
tjohnston@contoso.com
kakers@contoso.com After you populate the text file with the user accounts you want to update, run the following commands: diff --git a/exchange/docs-conceptual/exchange-cmdlet-syntax.md b/exchange/docs-conceptual/exchange-cmdlet-syntax.md index cc8231c080..84b003f449 100644 --- a/exchange/docs-conceptual/exchange-cmdlet-syntax.md +++ b/exchange/docs-conceptual/exchange-cmdlet-syntax.md @@ -14,13 +14,13 @@ description: "Learn about the structure and syntax of cmdlets in Exchange PowerS # Exchange cmdlet syntax -Exchange cmdlet reference topics use a standardized method that describes key aspects about the cmdlet. For example: +Exchange cmdlet reference articles use a standardized method that describes key aspects about the cmdlet. For example: - Parameters that are available on the cmdlet. - Values that each parameter accepts. - Parameters that can be used together, and parameters that need to be used separately. -This topic explains these conventions, and also the syntax that's required to run commands in Exchange PowerShell. +This article explains these conventions, and also the syntax that's required to run commands in Exchange PowerShell. ## Command conventions in Exchange PowerShell @@ -30,7 +30,7 @@ Exchange PowerShell help follows conventions that indicate what's required or op |---|---| |`-`|A hyphen indicates a parameter. For example, `-Identity`.| |`< >`|Angle brackets indicate the possible values for a parameter. For example, `-Location ` or -Enabled \<$true \| $false\>.| -|`[ ]`|Square brackets indicate optional parameters and their values. For example, `[-WhatIf]` or `[-ResultSize ]`.
Parameter-value pairs that aren't enclosed in square brackets are required. For example, `-Password `.
If the parameter name itself is enclosed in square brackets, that indicates the parameter is a _positional_ parameter (you can use the parameter value without specifying the parameter), and positional parameters can be required or optional.
For example, `Get-Mailbox [[-Identity] ]` means the _Identity_ parameter is positional (because it's enclosed in square brackets) and optional (because the whole parameter-value pair is enclosed in square brackets), so you can use `Get-Mailbox -Identity ` or `Get-Mailbox `. Similarly, `Set-Mailbox [-Identity] ` means the _Identity_ parameter is positional (because it's enclosed in square brackets) and required (because the whole parameter-value pair is not enclosed in square brackets), so you can use `Set-Mailbox -Identity ` or `Set-Mailbox `.| +|`[ ]`|Square brackets indicate optional parameters and their values. For example, `[-WhatIf]` or `[-ResultSize ]`.

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

If the parameter name itself is enclosed in square brackets, that indicates the parameter is a _positional_ parameter (you can use the parameter value without specifying the parameter), and positional parameters can be required or optional.

For example, `Get-Mailbox [[-Identity] ]` means the _Identity_ parameter is positional (because it's enclosed in square brackets) and optional (because the whole parameter-value pair is enclosed in square brackets), so you can use `Get-Mailbox -Identity ` or `Get-Mailbox `. Similarly, `Set-Mailbox [-Identity] ` means the _Identity_ parameter is positional (because it's enclosed in square brackets) and required (because the whole parameter-value pair is not enclosed in square brackets), so you can use `Set-Mailbox -Identity ` or `Set-Mailbox `.| |`|`|Pipe symbols in parameter values indicate a choice between values. For example, -Enabled \<$true \| $false\> indicates the _Enabled_ parameter can have the value `$true` or `$false`.| | @@ -111,7 +111,7 @@ The following table shows the valid operators that you can use in an Exchange co |`=`|The equal sign is used as an assignment character. The value on the right side of the equal sign is assigned to the variable on the left side of the equal sign. The following characters are also assignment characters:

  • `+=`: Add the value on the right side of the equal sign to the current value that's contained in the variable on the left side of the equal sign.
  • `-=`: Subtract the value on the right side of the equal sign from the current value that's contained in the variable on the left side of the equal sign.
  • `*=`: Multiply the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
  • `/=`: Divide the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
  • `%=`: Modify the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
| |`:`|A colon can be used to separate a parameter's name from the parameter's value. For example, `-Enabled:$True`. Using a colon is optional with all parameter types except switch parameters. For more information about switch parameters, see [about_Parameters](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters).| |`!`|The exclamation point is a logical NOT operator. When it is used with the equal ( = ) sign, the combined pair (`!=`) means "not equal to."| -|`[ ]`|Brackets are used to specify the index value of an array position. Index values are offsets that start at zero. For example, `$Red[9]` refers to the tenth index position in the array, `$Red`.
Brackets can also be used to assign a type to a variable (for example, `$A=[XML] "value"`). The following variable types are available: `Array`, `Bool`, `Byte`, `Char`, `Char[]`, `Decimal`, `Double`, `Float`, `Int`, `Int[]`, `Long`, `Long[]`, `RegEx`, `Single`, `ScriptBlock`, `String`, `Type`, and `XML.`| +|`[ ]`|Brackets are used to specify the index value of an array position. Index values are offsets that start at zero. For example, `$Red[9]` refers to the tenth index position in the array, `$Red`.

Brackets can also be used to assign a type to a variable (for example, `$A=[XML] "value"`). The following variable types are available: `Array`, `Bool`, `Byte`, `Char`, `Char[]`, `Decimal`, `Double`, `Float`, `Int`, `Int[]`, `Long`, `Long[]`, `RegEx`, `Single`, `ScriptBlock`, `String`, `Type`, and `XML.`| |`{ }`|Braces are used to include an expression in a command. For example, Get-Process \| Where {$\_.HandleCount -gt 400}| |`|`|The pipe symbol is used when one cmdlet pipes a result to another cmdlet. For example, Get-Mailbox -Server SRV1 \| Set-Mailbox -ProhibitSendQuota 2GB.| |`>`|The right-angle bracket is used to send the output of a command to a file, and the contents of the file are overwritten. For example, `Get-TransportRulePredicate > "C:\My Documents\Output.txt"`.| diff --git a/exchange/docs-conceptual/exchange-management-shell.md b/exchange/docs-conceptual/exchange-management-shell.md index 46b4ab52f1..48dc6b6e78 100644 --- a/exchange/docs-conceptual/exchange-management-shell.md +++ b/exchange/docs-conceptual/exchange-management-shell.md @@ -9,7 +9,7 @@ ms.topic: article ms.service: exchange-powershell localization_priority: Normal ms.assetid: 925ad66f-2f05-4269-9923-c353d9c19312 -description: "Learn about Exchange Server PowerShell, also known as the Exchange Management Shell. This topic describes how PowerShell works on Exchange servers, and provides links to other topics that can help you learn how to use the Exchange Management Shell." +description: "Learn about Exchange Server PowerShell, also known as the Exchange Management Shell. This article describes how PowerShell works on Exchange servers, and provides links to other articles that can help you learn how to use the Exchange Management Shell." --- # Exchange Server PowerShell (Exchange Management Shell) @@ -18,7 +18,7 @@ The Exchange Management Shell is built on Windows PowerShell technology and prov The Exchange Management Shell also provides a robust and flexible scripting platform. Visual Basic scripts that required many lines of code can be replaced by Exchange Management Shell commands that use as little as one line of code. The Exchange Management Shell provides this flexibility because it uses an object model that's based on the Microsoft .NET Framework. This object model enables Exchange cmdlets to apply the output from one command to subsequent commands. -To start using the Exchange Management Shell immediately, see the [Exchange Management Shell documentation](#exchange-management-shell-documentation) section later in this topic. +To start using the Exchange Management Shell immediately, see the [Exchange Management Shell documentation](#exchange-management-shell-documentation) section later in this article. ## How the Exchange Management Shell works on all Exchange server roles except Edge Transport @@ -40,7 +40,7 @@ A benefit of remote PowerShell is that you can use Windows PowerShell on a local - A supported version of the .NET Framework. - A supported version of the Windows Management Framework (WMF), which includes WinRM and Windows PowerShell. -For details, see the following topics: +For details, see the following articles: - [Exchange 2019 system requirements](https://docs.microsoft.com/Exchange/plan-and-deploy/system-requirements?view=exchserver-2019&preserve-view=true) - [Exchange 2016 system requirements](https://docs.microsoft.com/Exchange/plan-and-deploy/system-requirements?view=exchserver-2016&preserve-view=true) @@ -63,11 +63,11 @@ For more information about Edge Transport servers, see [Edge Transport Servers]( ## Exchange Management Shell documentation -The following table provides links to topics that can help you learn about and use the Exchange Management Shell. +The following table provides links to articles that can help you learn about and use the Exchange Management Shell. **** -|Topic|Description| +|Article|Description| |---|---| |[Open the Exchange Management Shell](open-the-exchange-management-shell.md)|Find and open the Exchange Management Shell on an Exchange server or a computer that has the Exchange management tools installed.| |[Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md)|Use Windows PowerShell on a local computer to connect to an Exchange server.| @@ -75,5 +75,5 @@ The following table provides links to topics that can help you learn about and u |[Find the permissions required to run any Exchange cmdlet](find-exchange-cmdlet-permissions.md)|Find the permissions you need to run a specific cmdlet, or one or more parameters on the cmdlet.| |[Exchange cmdlet syntax](exchange-cmdlet-syntax.md)|Learn about the structure and syntax of cmdlets in Exchange PowerShell.| |[Recipient filters in Exchange Management Shell commands](recipient-filters.md)|Learn about recipient filters in the Exchange Management Shell.| -|[Use Update-ExchangeHelp to update Exchange PowerShell help topics on Exchange servers](use-update-exchangehelp.md)|Learn how to use Update-ExchangeHelp to update help for Exchange cmdlet reference topics on Exchange servers.| +|[Use Update-ExchangeHelp to update Exchange PowerShell help articles on Exchange servers](use-update-exchangehelp.md)|Learn how to use Update-ExchangeHelp to update help for Exchange cmdlet reference articles on Exchange servers.| | diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index dc89beb09f..e7857b6429 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -20,7 +20,7 @@ description: "Admins can learn about the installation, maintenance, and design o The Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module) uses modern authentication and works with multi-factor authentication (MFA) for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. -For connection instructions using the EXO V2 module, see the following topics: +For connection instructions using the EXO V2 module, see the following articles: - [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) @@ -28,7 +28,7 @@ For connection instructions using the EXO V2 module, see the following topics: - [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md) -The rest of this topic explains how the module works, how to install and maintain the module, and the optimized Exchange Online cmdlets that are available in the module. +The rest of this article explains how the module works, how to install and maintain the module, and the optimized Exchange Online cmdlets that are available in the module. ## Report bugs and issues for the EXO V2 module @@ -42,7 +42,7 @@ Connect-ExchangeOnline -EnableErrorReporting -LogDirectoryPath or
[New-PSSession](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssession)| +|[Connect-ExchangeOnline](https://docs.microsoft.com/powershell/module/exchange/connect-exchangeonline)|[Connect-EXOPSSession](v1-module-mfa-connect-to-exo-powershell.md)

or

[New-PSSession](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssession)| |[Connect-IPPSSession](https://docs.microsoft.com/powershell/module/exchange/connect-ippssession)|[Connect-IPPSSession](v1-module-mfa-connect-to-scc-powershell.md)| |[Disconnect-ExchangeOnline](https://docs.microsoft.com/powershell/module/exchange/disconnect-exchangeonline)|[Remove-PSSession](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/remove-pssession)| | @@ -106,9 +106,9 @@ The procedures in this section explain how to install, update, and uninstall the - Windows 7 Service Pack 1 (SP1)\*\* - Windows Server 2008 R2 SP1\*\* - \* The `2.0.4-Preview2` version of the module supports PowerShell 7 in Linux and Windows. For more information, see the [PowerShell Core support in the EXO V2 module](#powershell-core-support-in-the-exo-v2-module) section later in this topic. + \* The `2.0.4-Preview2` version of the module supports PowerShell 7 in Linux and Windows. For more information, see the [PowerShell Core support in the EXO V2 module](#powershell-core-support-in-the-exo-v2-module) section later in this article. - \*\* This version of Windows has reached end of support, and is now only supported when running in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then the Windows Management Framework 5.1. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). + \*\* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then the Windows Management Framework 5.1. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). - Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: @@ -127,7 +127,7 @@ The procedures in this section explain how to install, update, and uninstall the **Note**: You must temporarily enable WinRM to run the following commands. You can enable it by running the command: `winrm quickconfig`. To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - + ```dos winrm get winrm/config/client/auth ``` @@ -251,7 +251,7 @@ The `2.0.4-Preview2` version supports PowerShell 7 in Linux and Windows environm - PowerShell 7 in MacOS is not supported. - The Preview version of the module works with Windows PowerShell 5.1. -To install the `2.0.4-Preview2` version of the module, see the [Install and maintain the EXO V2 module](#install-and-maintain-the-exo-v2-module) section in this topic. +To install the `2.0.4-Preview2` version of the module, see the [Install and maintain the EXO V2 module](#install-and-maintain-the-exo-v2-module) section in this article. For more information about PowerShell 7, see [Announcing PowerShell 7.0](https://devblogs.microsoft.com/powershell/announcing-PowerShell-7-0/). @@ -362,7 +362,7 @@ For more information about filtering in the EXO V2 module, see [Filters in the E - You can now use `FolderId` as an identity parameter in **Get-EXOMailboxFolderPermission**. You can get the `FolderId` value using **Get-MailboxFolder**. For example: `Get-MailboxFolderPermission -Identity :` - + `Get-MailboxFolderPermission -Identity :\` - Improved reliability of **Get-EXOMailboxStatistics** as certain request routing errors which led to failures have been resolved. diff --git a/exchange/docs-conceptual/exchange-online-powershell.md b/exchange/docs-conceptual/exchange-online-powershell.md index 19442a2b07..bee35d873c 100644 --- a/exchange/docs-conceptual/exchange-online-powershell.md +++ b/exchange/docs-conceptual/exchange-online-powershell.md @@ -15,13 +15,13 @@ description: "Learn about using PowerShell in Exchange Online" # Exchange Online PowerShell -Exchange Online PowerShell is the administrative interface that enables you to manage your Microsoft Exchange Online organization from the command line. For example, you can use Exchange Online PowerShell to configure mail flow rules (also known as transport rules) and connectors. The following topics provide information about using Exchange Online PowerShell: +Exchange Online PowerShell is the administrative interface that enables you to manage your Microsoft Exchange Online organization from the command line. For example, you can use Exchange Online PowerShell to configure mail flow rules (also known as transport rules) and connectors. The following articles provide information about using Exchange Online PowerShell: - To create a remote PowerShell session to your Exchange Online organization that supports both modern authentication and multi-factor authentication (MFA), see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). - To prevent or allow PowerShell access to your Exchange Online organization, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). -- To learn about the structure and layout of the cmdlet reference topics in Exchange Online PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). +- To learn about the structure and layout of the cmdlet reference articles in Exchange Online PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). - To find the permissions that you need to run a specific cmdlet, or one or more parameters on a cmdlet, see [Find the permissions required to run any Exchange cmdlet](find-exchange-cmdlet-permissions.md). diff --git a/exchange/docs-conceptual/exchange-online-protection-powershell.md b/exchange/docs-conceptual/exchange-online-protection-powershell.md index a496200060..d92d2940e9 100644 --- a/exchange/docs-conceptual/exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/exchange-online-protection-powershell.md @@ -19,10 +19,10 @@ Exchange Online Protection PowerShell is the administrative interface that enabl > [!NOTE] > Exchange Online Protection PowerShell is only used in *standalone* EOP organizations. For example, your Microsoft 365 subscription only includes EOP (no Exchange mailboxes), and you use it to protect your on-premises email environment. If you have a Microsoft 365 subscription that includes Exchange Online mailboxes (E3, E5, etc.), you can't use Exchange Online Protection PowerShell; the same features are available in [Exchange Online PowerShell](exchange-online-powershell.md). -The following topics provide information about using Exchange Online Protection PowerShell: +The following articles provide information about using Exchange Online Protection PowerShell: - To create a remote PowerShell session to your standalone Exchange Online Protection organization that supports both modern authentication and multi-factor authentication (MFA), see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). -- To learn about the structure and layout of the cmdlet reference topics in Exchange Online Protection PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). +- To learn about the structure and layout of the cmdlet reference articles in Exchange Online Protection PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). - For a sample script that lets admins who manage multiple organizations apply configuration settings to all of their organizations, see [Sample script for applying EOP settings to multiple tenants](https://docs.microsoft.com/microsoft-365/security/office-365-security/sample-script-for-applying-eop-settings-to-multiple-tenants). diff --git a/exchange/docs-conceptual/filter-properties.md b/exchange/docs-conceptual/filter-properties.md index a40e9c06dd..7ccb7f8500 100644 --- a/exchange/docs-conceptual/filter-properties.md +++ b/exchange/docs-conceptual/filter-properties.md @@ -36,7 +36,7 @@ You use the _Filter_ parameter to create OPATH filters based on the properties o For more information about recipients filters in Exchange PowerShell, see [Recipient filters in Exchange PowerShell commands](recipient-filters.md). > [!NOTE] -> The _Filter_ parameter is also available on other cmdlets (for example, **Get-MailboxStatistics**, **Get-Queue**, and **Get-Message**). However, the property values that are accepted by the _Filter_ parameter on these cmdlets aren't similar to the user and group properties that are described in this topic. +> The _Filter_ parameter is also available on other cmdlets (for example, **Get-MailboxStatistics**, **Get-Queue**, and **Get-Message**). However, the property values that are accepted by the _Filter_ parameter on these cmdlets aren't similar to the user and group properties that are described in this article. ## Filterable properties @@ -64,241 +64,241 @@ The properties that have been _confirmed_ to work with the _Filter_ parameter in |Property name|LDAP display name|Available on cmdlets|Value|Comments| |---|---|---|---|---| -|_AcceptMessagesOnlyFrom_|_authOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_AcceptMessagesOnlyFromDLMembers_|_dLMemSubmitPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"`. or `Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'contoso.com/Users/Marketing Department'"`.
To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName` or `Get-DynamicDistributionGroup -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_ActiveSyncAllowedDeviceIDs_|_msExchMobileAllowedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `$null`|A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: `Get-MobileDevice -Mailbox | Format-List`.
After you have the device ID value, you can use it in the filter. For example, `Get-CasMailbox -Filter "(ActiveSyncAllowedDeviceIDs -like 'text1*') -or (ActiveSyncAllowedDeviceIDs -eq 'text2'"`.| -|_ActiveSyncBlockedDeviceIDs_|_msExchMobileBlockedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `$null`|A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: `Get-MobileDevice -Mailbox | Format-List`.
After you have the device ID value, you can use it in a filter. For example, `Get-CasMailbox -Filter "(ActiveSyncBlockedDeviceIDs -like 'text1*') -or (ActiveSyncBlockedDeviceIDs -eq 'text2'"`.| +|_AcceptMessagesOnlyFrom_|_authOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_AcceptMessagesOnlyFromDLMembers_|_dLMemSubmitPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"`. or `Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'contoso.com/Users/Marketing Department'"`.
To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName` or `Get-DynamicDistributionGroup -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_ActiveSyncAllowedDeviceIDs_|_msExchMobileAllowedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `$null`|A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: `Get-MobileDevice -Mailbox | Format-List`.
After you have the device ID value, you can use it in the filter. For example, `Get-CasMailbox -Filter "(ActiveSyncAllowedDeviceIDs -like 'text1*') -or (ActiveSyncAllowedDeviceIDs -eq 'text2'"`.| +|_ActiveSyncBlockedDeviceIDs_|_msExchMobileBlockedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `$null`|A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: `Get-MobileDevice -Mailbox | Format-List`.
After you have the device ID value, you can use it in a filter. For example, `Get-CasMailbox -Filter "(ActiveSyncBlockedDeviceIDs -like 'text1*') -or (ActiveSyncBlockedDeviceIDs -eq 'text2'"`.| |_ActiveSyncEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CasMailbox -Filter 'ActiveSyncEnable -eq $false'`.| -|_ActiveSyncMailboxPolicy_|_msExchMobileMailboxPolicyLink_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the ActiveSync mailbox policy. For example, `Get-CASMailbox -Filter "ActiveSyncMailboxPolicy -eq 'CN=Default,CN=Mobile Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of ActiveSync mailbox policies by running this command: `Get-MobileDeviceMailboxPolicy | Format-List Name,DistinguishedName`.
**Note**: For the default assignment of the default ActiveSync mailbox policy (named Default) to a mailbox, the value of the **ActiveSyncMailboxPolicy** property is blank (`$null`).| +|_ActiveSyncMailboxPolicy_|_msExchMobileMailboxPolicyLink_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the ActiveSync mailbox policy. For example, `Get-CASMailbox -Filter "ActiveSyncMailboxPolicy -eq 'CN=Default,CN=Mobile Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of ActiveSync mailbox policies by running this command: `Get-MobileDeviceMailboxPolicy | Format-List Name,DistinguishedName`.
**Note**: For the default assignment of the default ActiveSync mailbox policy (named Default) to a mailbox, the value of the **ActiveSyncMailboxPolicy** property is blank (`$null`).| |_ActiveSyncSuppressReadReceipt_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CasMailbox -Filter 'ActiveSyncSuppressReadReceipt -eq $true'`.| -|_AddressBookPolicy_|_msExchAddressBookPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the address book policy. For example, `Get-Mailbox -Filter "AddressBookPolicy -eq 'CN=Contoso ABP,CN=AddressBook Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of address book policies by running this command: `Get-AddressBookPolicy | Format-List Name,DistinguishedName`.| -|_AddressListMembership_|_showInAddressBook_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name of the address list. For example, `Get-MailContact -Filter "AddressListMembership -eq 'CN=All Contacts,CN=All Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of address lists by running this command: `Get-AddressList | Format-List Name,DistinguishedName`.| +|_AddressBookPolicy_|_msExchAddressBookPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the address book policy. For example, `Get-Mailbox -Filter "AddressBookPolicy -eq 'CN=Contoso ABP,CN=AddressBook Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of address book policies by running this command: `Get-AddressBookPolicy | Format-List Name,DistinguishedName`.| +|_AddressListMembership_|_showInAddressBook_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name of the address list. For example, `Get-MailContact -Filter "AddressListMembership -eq 'CN=All Contacts,CN=All Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of address lists by running this command: `Get-AddressList | Format-List Name,DistinguishedName`.| |_AdminDisplayName_|_adminDisplayName_|**Get-SecurityPrincipal**|String (wildcards accepted) or `$null`|For example, `Get-SecurityPrincipal -Filter 'AdminDisplayName -ne $null' | Format-Table -Auto Name,AdminDisplayName`.| -|_AdministrativeUnits_|_msExchAdministrativeUnitLink_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-User -Filter 'AdministrativeUnits -ne $null'`.| -|_AggregatedMailboxGuids_|_msExchAlternateMailboxes_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'AggregatedMailboxGuids -ne $null'`.| -|_Alias_|_mailNickname_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-Recipient -Filter "Alias -like 'smith*'"`.| -|_AllowUMCallsFromNonUsers_|_msExchUMListInDirectorySearch_|**Get-Contact**
**Get-LinkedUser**
**Get-UMMailbox**
**Get-User**|`None` (0) or `SearchEnabled` (1)|For example, `Get-User -Filter "AllowUMCallsFromNonUsers -ne 'SearchEnabled'"`.| -|_ArbitrationMailbox_|_msExchArbitrationMailbox_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the arbitration mailbox. For example, `Get-DistributionGroup -Filter "ArbitrationMailbox -eq 'CN=SystemMailbox"1f05a927-2e8f-4cbb-9039-2cfb8b95e486",CN=Users,DC=contoso,DC=com'"`.
You can find the distinguished names of arbitration mailboxes by running this command: `Get-Mailbox -Arbitration | Format-List Name,DistinguishedName`.| -|_ArchiveDatabase_|_msExchArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the archive mailbox database. For example, `Get-Mailbox -Filter "ArchiveMailbox -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| +|_AdministrativeUnits_|_msExchAdministrativeUnitLink_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-User -Filter 'AdministrativeUnits -ne $null'`.| +|_AggregatedMailboxGuids_|_msExchAlternateMailboxes_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'AggregatedMailboxGuids -ne $null'`.| +|_Alias_|_mailNickname_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-Recipient -Filter "Alias -like 'smith*'"`.| +|_AllowUMCallsFromNonUsers_|_msExchUMListInDirectorySearch_|**Get-Contact**
**Get-LinkedUser**
**Get-UMMailbox**
**Get-User**|`None` (0) or `SearchEnabled` (1)|For example, `Get-User -Filter "AllowUMCallsFromNonUsers -ne 'SearchEnabled'"`.| +|_ArbitrationMailbox_|_msExchArbitrationMailbox_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the arbitration mailbox. For example, `Get-DistributionGroup -Filter "ArbitrationMailbox -eq 'CN=SystemMailbox"1f05a927-2e8f-4cbb-9039-2cfb8b95e486",CN=Users,DC=contoso,DC=com'"`.
You can find the distinguished names of arbitration mailboxes by running this command: `Get-Mailbox -Arbitration | Format-List Name,DistinguishedName`.| +|_ArchiveDatabase_|_msExchArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the archive mailbox database. For example, `Get-Mailbox -Filter "ArchiveMailbox -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| |_ArchiveDomain_|_msExchArchiveAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This property is used in on-premises Exchange environments to identify the Exchange Online organization that holds the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveDomain -like 'contoso.onmicrosoft.com*'"`.| -|_ArchiveGuid_|_msExchArchiveGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the GUID of the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveMailbox -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"`.
You can find the GUID of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID`.| -|_ArchiveName_|_msExchArchiveName_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This filter requires the name of the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveName -like 'In-Place Archive*'"`.
You can find the names of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveName`.| -|_ArchiveQuota_|_msExchArchiveQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ArchiveQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ArchiveQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ArchiveQuota - ''"`. For example, `Get-Mailbox | where "$_.ArchiveQuota -gt '85GB'"`.| -|_ArchiveRelease_|_msExchArchiveRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.|For example, `Get-Recipient -Filter 'ArchiveRelease -ne $null'`.| -|_ArchiveState_|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0), `Local` (1), `HostedProvisioned` (2), `HostedPending` (3), or `OnPremise` (4).|For example, `Get-Recipient -Filter "ArchiveState -eq 'HostedProvisioned'"`.| -|_ArchiveStatus_|_msExchArchiveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0) or `Active` (1).|For example, `Get-Recipient -Filter "ArchiveStatus -eq 'Active'"`.| -|_ArchiveWarningQuota_|_msExchArchiveWarnQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ArchiveWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ArchiveWarningQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ArchiveWarningQuota - ''"`. For example, `Get-Mailbox | where "$_.ArchiveWarningQuota -gt '85GB'"`.| -|_AssistantName_|_msExchAssistantName_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "AssistantName -like 'Julia*'"`.| +|_ArchiveGuid_|_msExchArchiveGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the GUID of the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveMailbox -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"`.
You can find the GUID of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID`.| +|_ArchiveName_|_msExchArchiveName_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This filter requires the name of the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveName -like 'In-Place Archive*'"`.
You can find the names of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveName`.| +|_ArchiveQuota_|_msExchArchiveQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ArchiveQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ArchiveQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ArchiveQuota - ''"`. For example, `Get-Mailbox | where "$_.ArchiveQuota -gt '85GB'"`.| +|_ArchiveRelease_|_msExchArchiveRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.|For example, `Get-Recipient -Filter 'ArchiveRelease -ne $null'`.| +|_ArchiveState_|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0), `Local` (1), `HostedProvisioned` (2), `HostedPending` (3), or `OnPremise` (4).|For example, `Get-Recipient -Filter "ArchiveState -eq 'HostedProvisioned'"`.| +|_ArchiveStatus_|_msExchArchiveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0) or `Active` (1).|For example, `Get-Recipient -Filter "ArchiveStatus -eq 'Active'"`.| +|_ArchiveWarningQuota_|_msExchArchiveWarnQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ArchiveWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ArchiveWarningQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ArchiveWarningQuota - ''"`. For example, `Get-Mailbox | where "$_.ArchiveWarningQuota -gt '85GB'"`.| +|_AssistantName_|_msExchAssistantName_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "AssistantName -like 'Julia*'"`.| |_AuditEnabled_|_msExchMailboxAuditEnable_|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'AuditEnabled -eq $true'`.| -|_AuditLogAgeLimit_|_msExchMailboxAuditLogAgeLimit_|**Get-Mailbox**
**Get-UnifiedGroup**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.|You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: `Get-Mailbox | where "$_.AuditLogAgeLimit - ''"`. For example, `Get-Mailbox | where "$_.AuditLogAgeLimit -gt '60.00:00:00'"`.| +|_AuditLogAgeLimit_|_msExchMailboxAuditLogAgeLimit_|**Get-Mailbox**
**Get-UnifiedGroup**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.|You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: `Get-Mailbox | where "$_.AuditLogAgeLimit - ''"`. For example, `Get-Mailbox | where "$_.AuditLogAgeLimit -gt '60.00:00:00'"`.| |_AuthenticationPolicy_|_msExchAuthPolicyLink_|**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "AuthenticationPolicy -eq 'CN=Block Basic Auth,CN=Auth Policies,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR11B009,DC=PROD,DC=OUTLOOK,DC=COM'"`.| |_BlockedSendersHash_|_msExchBlockedSendersHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.|Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'BlockedSendersHash -ne $null'.`| -|_c_|_c_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String (wildcards accepted) or `$null`|This filter requires the ISO 3166-1 two-letter country code for the user (for example, `US` for the United States). This property is used together with the _co_ and _countryCode_ properties to define the user's country in Active Directory.
For example, `Get-User -Filter "c -eq 'US'"`.| -|_CalendarLoggingQuota_|_msExchCalendarLoggingQuota_|**Get-Mailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "CalendarLoggingQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "CalendarLoggingQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.CalendarLoggingQuota - ''"`. For example, `Get-Mailbox | where "$_.CalendarLoggingQuota -gt '10GB'"`.| +|_c_|_c_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String (wildcards accepted) or `$null`|This filter requires the ISO 3166-1 two-letter country code for the user (for example, `US` for the United States). This property is used together with the _co_ and _countryCode_ properties to define the user's country in Active Directory.
For example, `Get-User -Filter "c -eq 'US'"`.| +|_CalendarLoggingQuota_|_msExchCalendarLoggingQuota_|**Get-Mailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "CalendarLoggingQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "CalendarLoggingQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.CalendarLoggingQuota - ''"`. For example, `Get-Mailbox | where "$_.CalendarLoggingQuota -gt '10GB'"`.| |_CalendarRepairDisabled_|_msExchCalendarRepairDisabled_|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'CalendarRepairDisabled -eq $true'`.| -|_CertificateSubject_|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`|The X509 certificate that's published for the user account (visible on the **Published Certificates** tab in Active Directory Users and Computers).
For example, `Get-User -Filter "CertificateSubject -eq 'X509:C=US,O=InternetCA,CN=APublicCertificateAuthorityC=US,O=Fabrikam,OU=Sales,CN=Jeff Smith`')| -|_City_|_l_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "City -eq 'Redmond'"`.| -|_Company_|_company_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Company -like 'Contoso*'"`.| -|_ComplianceTagHoldApplied_|n/a|**Get-Mailbox**
**Get-MailUser**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'ComplianceTagHoldApplied -eq $true'`.| -|_ConsumerNetID_|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter 'ConsumerNetID -ne $null'`.| -|_CountryCode_|_countryCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|Integer|This filter requires the ISO 3166-1 three-digit country code for the user (for example, `840` for the United States). This property is used together with the _c_ and _co_ properties to define the user's country in Active Directory.
For example, `Get-User -Filter "countryCode -eq 796"`.| -|_CountryOrRegion_|_co_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String|This filter requires the ISO 3166-1 country name for the user (for example, `United States`). You can select an available value in Active Directory Users and Computers ( **Address** tab > **Country/region** field), or the Exchange admin center (user properties > **Contact information** tab > **Country/Region** field).
When you select a user's country in Active Directory Users and Computers or the EAC, the corresponding values for the _co_ and _countryCode_ properties are automatically configured.
For example, `Get-User -Filter "CountryOrRegion -like 'United*'"`.| -|_CustomAttribute1_ to _CustomAttribute15_|_extensionAttribute1_ to _extensionAttribute15_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "CustomAttribute8 -like 'audited*'"`.| -|_Database_|_homeMDB_|**Get-Mailbox**
**Get-Recipient**|String|This filter requires the distinguished name of the mailbox database. For example, `Get-Mailbox -Filter "Database -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| -|_DefaultPublicFolderMailbox_|_msExchPublicFolderMailbox_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the public folder mailbox. For example, `Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'CN=PF Mailbox01,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'contoso.com/Users/PF Mailbox01'"`.
To find the distinguished names of public folder mailboxes, run this command: `Get-Mailbox -PublicFolder | Format-List Name,DistinguishedName`.| -|_DeletedItemFlags_|_deletedItemFlags_|**Get-Mailbox**
**Get-SecurityPrincipal**|`DatabaseDefault` (0), `RetainUntilBackupOrCustomPeriod` (3), or `RetainForCustomPeriod` (5).|For example, `Get-Mailbox -Filter "DeletedItemFlags -ne 'DatabaseDefault'"`.| -|_DeliverToMailboxAndForward_|_deliverAndRedirect_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-MailPublicFolder**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'DeliverToMailboxAndForward -eq $true'`.| -|_Department_|_department_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "Department -like 'Engineering*'"`.| -|_DirectReports_|_directReports_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the direct report. For example, `Get-User -Filter "DirectReports -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "DirectReports -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a direct report, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_DisabledArchiveDatabase_|_msExchDisabledArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the disabled archive mailbox database. For example, `Get-Mailbox -Filter "DisabledArchiveDatabase -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| -|_DisabledArchiveGuid_|_msExchDisabledArchiveDatabaseGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the GUID of the disabled archive mailbox. For example, `Get-Mailbox -Filter "DisabledArchiveGuid -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"`.
You can find the GUID of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID`.| -|_DisplayName_|_displayName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-Recipient -Filter "DisplayName -like 'Julia*'"`.| -|_DistinguishedName_|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|This filter requires the distinguished name of the recipient. For example, `Get-Mailbox -Filter "DistinguishedName -eq 'CN=Basho Kato,CN=Users,DC=contoso,DC=com'"`.
You can find the distinguished names of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,DistinguishedName`.| +|_CertificateSubject_|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`|The X509 certificate that's published for the user account (visible on the **Published Certificates** tab in Active Directory Users and Computers).
For example, `Get-User -Filter "CertificateSubject -eq 'X509:C=US,O=InternetCA,CN=APublicCertificateAuthorityC=US,O=Fabrikam,OU=Sales,CN=Jeff Smith`')| +|_City_|_l_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "City -eq 'Redmond'"`.| +|_Company_|_company_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Company -like 'Contoso*'"`.| +|_ComplianceTagHoldApplied_|n/a|**Get-Mailbox**
**Get-MailUser**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'ComplianceTagHoldApplied -eq $true'`.| +|_ConsumerNetID_|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter 'ConsumerNetID -ne $null'`.| +|_CountryCode_|_countryCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|Integer|This filter requires the ISO 3166-1 three-digit country code for the user (for example, `840` for the United States). This property is used together with the _c_ and _co_ properties to define the user's country in Active Directory.
For example, `Get-User -Filter "countryCode -eq 796"`.| +|_CountryOrRegion_|_co_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String|This filter requires the ISO 3166-1 country name for the user (for example, `United States`). You can select an available value in Active Directory Users and Computers ( **Address** tab > **Country/region** field), or the Exchange admin center (user properties > **Contact information** tab > **Country/Region** field).
When you select a user's country in Active Directory Users and Computers or the EAC, the corresponding values for the _co_ and _countryCode_ properties are automatically configured.
For example, `Get-User -Filter "CountryOrRegion -like 'United*'"`.| +|_CustomAttribute1_ to _CustomAttribute15_|_extensionAttribute1_ to _extensionAttribute15_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "CustomAttribute8 -like 'audited*'"`.| +|_Database_|_homeMDB_|**Get-Mailbox**
**Get-Recipient**|String|This filter requires the distinguished name of the mailbox database. For example, `Get-Mailbox -Filter "Database -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| +|_DefaultPublicFolderMailbox_|_msExchPublicFolderMailbox_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the public folder mailbox. For example, `Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'CN=PF Mailbox01,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'contoso.com/Users/PF Mailbox01'"`.
To find the distinguished names of public folder mailboxes, run this command: `Get-Mailbox -PublicFolder | Format-List Name,DistinguishedName`.| +|_DeletedItemFlags_|_deletedItemFlags_|**Get-Mailbox**
**Get-SecurityPrincipal**|`DatabaseDefault` (0), `RetainUntilBackupOrCustomPeriod` (3), or `RetainForCustomPeriod` (5).|For example, `Get-Mailbox -Filter "DeletedItemFlags -ne 'DatabaseDefault'"`.| +|_DeliverToMailboxAndForward_|_deliverAndRedirect_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-MailPublicFolder**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'DeliverToMailboxAndForward -eq $true'`.| +|_Department_|_department_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "Department -like 'Engineering*'"`.| +|_DirectReports_|_directReports_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the direct report. For example, `Get-User -Filter "DirectReports -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "DirectReports -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a direct report, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_DisabledArchiveDatabase_|_msExchDisabledArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the disabled archive mailbox database. For example, `Get-Mailbox -Filter "DisabledArchiveDatabase -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| +|_DisabledArchiveGuid_|_msExchDisabledArchiveDatabaseGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the GUID of the disabled archive mailbox. For example, `Get-Mailbox -Filter "DisabledArchiveGuid -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"`.
You can find the GUID of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID`.| +|_DisplayName_|_displayName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-Recipient -Filter "DisplayName -like 'Julia*'"`.| +|_DistinguishedName_|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|This filter requires the distinguished name of the recipient. For example, `Get-Mailbox -Filter "DistinguishedName -eq 'CN=Basho Kato,CN=Users,DC=contoso,DC=com'"`.
You can find the distinguished names of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,DistinguishedName`.| |_EcpEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter 'EcpEnabled -eq $false'`.| -|_EmailAddresses_|_proxyAddresses_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-Recipient -Filter "EmailAddresses -like 'marketing*'"`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"EmailAddresses -eq 'lila@fabrikam.com'"` returns a match, `"EmailAddresses -like 'lila*'"` won't return a match, but or `"EmailAddresses -like 'smtp:lila*'"` will return a match.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_EmailAddressPolicyEnabled_|n/a|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter 'EmailAddressPolicyEnabled -eq $false'`.| -|_EntryId_|_msExchPublicFolderEntryId_|**Get-MailPublicFolder**|String (wildcards accepted)|For example, `Get-MailPublicFolder -Filter "EntryId -like '60000*'"`.
You can find the entry IDs of mail-enabled public folders by running this command: `Get-MailPublicFolder | Format-List Name,EntryId`.| +|_EmailAddresses_|_proxyAddresses_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-Recipient -Filter "EmailAddresses -like 'marketing*'"`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"EmailAddresses -eq 'lila@fabrikam.com'"` returns a match, `"EmailAddresses -like 'lila*'"` won't return a match, but or `"EmailAddresses -like 'smtp:lila*'"` will return a match.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_EmailAddressPolicyEnabled_|n/a|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter 'EmailAddressPolicyEnabled -eq $false'`.| +|_EntryId_|_msExchPublicFolderEntryId_|**Get-MailPublicFolder**|String (wildcards accepted)|For example, `Get-MailPublicFolder -Filter "EntryId -like '60000*'"`.
You can find the entry IDs of mail-enabled public folders by running this command: `Get-MailPublicFolder | Format-List Name,EntryId`.| |_EwsApplicationAccessPolicy_|_msExchEwsApplicationAccessPolicy_|**Get-CASMailbox**|`EnforceAllowList`, `EnforceBlockList`. or `$null`|For example, `Get-CASMailbox -Filter 'EwsApplicationAccessPolicy -ne $null'`.| |_EwsEnabled_|_msExchEwsEnabled_|**Get-CASMailbox**|0 (disabled), 1 (enabled) or `$null`.|For example, `Get-CASMailbox -Filter "EwsEnabled -eq 1"`.| -|_ExchangeGuid_|_msExchMailboxGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String|For example, `Get-Mailbox -Filter "ExchangeGuid -eq 'c80a753d-bd4a-4e19-804a-6344d833ecd8'"`.
To find the Exchange GUID of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,ExchangeGuid`.
Note that an object's Exchange GUID value is different than its GUID value. Also, the Exchange GUID value for non-mailboxes (mail contacts, mail users, distribution groups, dynamic distribution groups, mail-enabled security groups, and mail-enabled public folders) is `00000000-0000-0000-0000-000000000000`.| -|_ExchangeUserAccountControl_|_msExchUserAccountControl_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`None` (0) or `AccountDisabled` (2)|For example, `Get-Mailbox -Filter "ExchangeUserAccountControl -eq 'AccountDisabled'"`.| -|_ExchangeVersion_|_msExchVersion_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|Integer|This property contains the earliest version of Exchange that you can use to manage the recipient. The property values that you see are different than the values that you need to use in the filter. To see the **ExchangeVersion** property values, run this command: `Get-Recipient | Format-Table Name,RecipientType,ExchangeVersion`.
For the Exchange 2010 value `0.10 (14.0.100.0)`, use the value 44220983382016 in the filter.
For the Exchange 2013 or Exchange 2016 value `0.20 (15.0.0.0)`, use the value 88218628259840 in the filter.
For example, `Get-Recipient -Filter "ExchangeVersion -lt 88218628259840"`.| -|_ExpansionServer_|_msExchExpansionServerName_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Recipient**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "ExpansionServer -like 'Mailbox01*'"`.
For an exact match, you need to use the **ExchangeLegacyDN** value of the server. For example, `Get-Recipient -Filter "ExpansionServer -eq '/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01'"`
You can find the **ExchangeLegacyDN** value by running this command: `Get-ExchangeServer | Format-List Name,ExchangeLegacyDN`.| -|_ExtensionCustomAttribute1_ to _ExtensionCustomAttribute5_|_msExchExtensionCustomAttribute1_ to _msExchExtensionCustomAttribute5_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "ExtensionCustomAttribute8 -like 'audited*'"`.| -|_ExternalDirectoryObjectId_|_msExchExternalDirectoryObjectId_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-Recipient -Filter 'ExternalDirectoryObjectId -ne $null'`.| -|_ExternalEmailAddress_|_targetAddress_|**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "ExternalEmailAddress -like '@fabrikam.com*'"`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ExternalEmailAddress -eq 'lila@fabrikam.com'"` returns a match, `"ExternalEmailAddress -like 'lila*'"` won't return a match, but `"ExternalEmailAddress -like 'smtp:lila*'"` will return a match.| +|_ExchangeGuid_|_msExchMailboxGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String|For example, `Get-Mailbox -Filter "ExchangeGuid -eq 'c80a753d-bd4a-4e19-804a-6344d833ecd8'"`.
To find the Exchange GUID of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,ExchangeGuid`.
Note that an object's Exchange GUID value is different than its GUID value. Also, the Exchange GUID value for non-mailboxes (mail contacts, mail users, distribution groups, dynamic distribution groups, mail-enabled security groups, and mail-enabled public folders) is `00000000-0000-0000-0000-000000000000`.| +|_ExchangeUserAccountControl_|_msExchUserAccountControl_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`None` (0) or `AccountDisabled` (2)|For example, `Get-Mailbox -Filter "ExchangeUserAccountControl -eq 'AccountDisabled'"`.| +|_ExchangeVersion_|_msExchVersion_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|Integer|This property contains the earliest version of Exchange that you can use to manage the recipient. The property values that you see are different than the values that you need to use in the filter. To see the **ExchangeVersion** property values, run this command: `Get-Recipient | Format-Table Name,RecipientType,ExchangeVersion`.
For the Exchange 2010 value `0.10 (14.0.100.0)`, use the value 44220983382016 in the filter.
For the Exchange 2013 or Exchange 2016 value `0.20 (15.0.0.0)`, use the value 88218628259840 in the filter.
For example, `Get-Recipient -Filter "ExchangeVersion -lt 88218628259840"`.| +|_ExpansionServer_|_msExchExpansionServerName_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Recipient**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "ExpansionServer -like 'Mailbox01*'"`.
For an exact match, you need to use the **ExchangeLegacyDN** value of the server. For example, `Get-Recipient -Filter "ExpansionServer -eq '/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01'"`
You can find the **ExchangeLegacyDN** value by running this command: `Get-ExchangeServer | Format-List Name,ExchangeLegacyDN`.| +|_ExtensionCustomAttribute1_ to _ExtensionCustomAttribute5_|_msExchExtensionCustomAttribute1_ to _msExchExtensionCustomAttribute5_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "ExtensionCustomAttribute8 -like 'audited*'"`.| +|_ExternalDirectoryObjectId_|_msExchExternalDirectoryObjectId_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-Recipient -Filter 'ExternalDirectoryObjectId -ne $null'`.| +|_ExternalEmailAddress_|_targetAddress_|**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "ExternalEmailAddress -like '@fabrikam.com*'"`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ExternalEmailAddress -eq 'lila@fabrikam.com'"` returns a match, `"ExternalEmailAddress -like 'lila*'"` won't return a match, but `"ExternalEmailAddress -like 'smtp:lila*'"` will return a match.| |_ExternalOofOptions_|_msExchExternalOOFOptions_|**Get-Mailbox**|`External` (0) or `InternalOnly` (1)|For example, `Get-Mailbox -Filter "ExternalOofOptions -eq 'External'"`.| -|_Fax_|_facsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Fax -like '206*'"`.| -|_FirstName_|_givenName_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "FirstName -like 'Chris*'"`.| -|_ForwardingAddress_|_altRecipient_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the forwarding recipient. For example, `Get-Mailbox -Filter "ForwardingAddress -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "ForwardingAddress -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a forwarding recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.| -|_ForwardingSmtpAddress_|_msExchGenericForwardingAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "ForwardingSmtpAddress -like '@fabrikam.com*'"`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ForwardingSmtpAddress -eq 'lila@fabrikam.com'"` returns a match, `"ForwardingSmtpAddress -like 'lila*'"` won't return a match, but `"ForwardingSmtpAddress -like 'smtp:lila*'"` will return a match.| -|_GeneratedOfflineAddressBooks_|_msExchOABGeneratingMailboxBL_|**Get-Mailbox**|String or `$null`|This property is only meaningful on arbitration mailboxes, so you need to use the _Arbitration_ switch in the filter command. Also, This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter "GeneratedOfflineAddressBooks -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of offline address books by running this command: `Get-OfflineAddressBook | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_GrantSendOnBehalfTo_|_publicDelegates_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the mail-enabled security principal (mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter "GrantSendOnBehalfTo -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "GrantSendOnBehalfTo -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_Fax_|_facsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Fax -like '206*'"`.| +|_FirstName_|_givenName_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "FirstName -like 'Chris*'"`.| +|_ForwardingAddress_|_altRecipient_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the forwarding recipient. For example, `Get-Mailbox -Filter "ForwardingAddress -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "ForwardingAddress -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a forwarding recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.| +|_ForwardingSmtpAddress_|_msExchGenericForwardingAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "ForwardingSmtpAddress -like '@fabrikam.com*'"`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ForwardingSmtpAddress -eq 'lila@fabrikam.com'"` returns a match, `"ForwardingSmtpAddress -like 'lila*'"` won't return a match, but `"ForwardingSmtpAddress -like 'smtp:lila*'"` will return a match.| +|_GeneratedOfflineAddressBooks_|_msExchOABGeneratingMailboxBL_|**Get-Mailbox**|String or `$null`|This property is only meaningful on arbitration mailboxes, so you need to use the _Arbitration_ switch in the filter command. Also, This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter "GeneratedOfflineAddressBooks -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of offline address books by running this command: `Get-OfflineAddressBook | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_GrantSendOnBehalfTo_|_publicDelegates_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the mail-enabled security principal (mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter "GrantSendOnBehalfTo -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "GrantSendOnBehalfTo -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| |_GroupMemberCount_|_n/a_|**Get-UnifiedGroup**|Integer|For example, `Get-UnifiedGroup -Filter "GroupMemberCount -gt 100"`.| |_GroupExternalMemberCount_|_n/a_|**Get-UnifiedGroup**|Integer|For example, `Get-UnifiedGroup -Filter "GroupExternalMemberCount -gt 0"`.| -|_GroupType_|_groupType_|**Get-DistributionGroup**
**Get-Group**
**Get-UnifiedGroup**|`None` (0), `Global` (2), `DomainLocal` (4), `BuiltinLocal` (5), `Universal` (8), or `SecurityEnabled` (-2147483648).|Distribution groups have the value `Universal`, and mail-enabled security groups have the value `Universal, SecurityEnabled`. You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-DistributionGroup -Filter "GroupType -eq 'Universal,SecurityEnabled'"` returns the same results as `Get-DistributionGroup -Filter "GroupType -eq 'SecurityEnabled,Universal'"`.
This multivalued property will only return a match if the property *equals* the specified value.| -|_Guid_|_objectGuid_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|For example, `Get-Recipient -Filter "Guid -eq '8a68c198-be28-4a30-83e9-bffb760c65ba'"`.
You can find the GUIDs of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,Guid`.
Note that an object's GUID value is different than its Exchange GUID value.| -|_HasActiveSyncDevicePartnership_|n/a|**Get-CASMailbox**
**Get-Recipient**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter 'HasActiveSyncDevicePartnership -eq $true'`.| -|_HiddenFromAddressListsEnabled_|_msExchHideFromAddressLists_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter 'HiddenFromAddressListsEnabled -eq $true'`.| +|_GroupType_|_groupType_|**Get-DistributionGroup**
**Get-Group**
**Get-UnifiedGroup**|`None` (0), `Global` (2), `DomainLocal` (4), `BuiltinLocal` (5), `Universal` (8), or `SecurityEnabled` (-2147483648).|Distribution groups have the value `Universal`, and mail-enabled security groups have the value `Universal, SecurityEnabled`. You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-DistributionGroup -Filter "GroupType -eq 'Universal,SecurityEnabled'"` returns the same results as `Get-DistributionGroup -Filter "GroupType -eq 'SecurityEnabled,Universal'"`.
This multivalued property will only return a match if the property *equals* the specified value.| +|_Guid_|_objectGuid_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|For example, `Get-Recipient -Filter "Guid -eq '8a68c198-be28-4a30-83e9-bffb760c65ba'"`.
You can find the GUIDs of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,Guid`.
Note that an object's GUID value is different than its Exchange GUID value.| +|_HasActiveSyncDevicePartnership_|n/a|**Get-CASMailbox**
**Get-Recipient**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter 'HasActiveSyncDevicePartnership -eq $true'`.| +|_HiddenFromAddressListsEnabled_|_msExchHideFromAddressLists_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter 'HiddenFromAddressListsEnabled -eq $true'`.| |_HiddenGroupMembershipEnabled_|_hideDLMembership_|**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-UnifiedGroup -Filter 'HiddenGroupMembershipEnabled -eq $true'`.| -|_HomePhone_|_homePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "HomePhone -like '206*'"`.| -|_Id_|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMMailbox**
**Get-User**
**Get-SecurityPrincipal**
**Get-UnifiedGroup**|String|This filter requires the distinguished name or canonical distinguished name of the recipient. For example, `Get-Mailbox -Filter "Id -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "Id -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.| +|_HomePhone_|_homePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "HomePhone -like '206*'"`.| +|_Id_|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMMailbox**
**Get-User**
**Get-SecurityPrincipal**
**Get-UnifiedGroup**|String|This filter requires the distinguished name or canonical distinguished name of the recipient. For example, `Get-Mailbox -Filter "Id -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "Id -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.| |_IgnoreMissingFolderLink_|n/a|**Get-MailPublicFolder**|Boolean (`$true` or `$false`)|For example, `Get-MailPublicFolder -Filter 'IgnoreMissingFolderLink -eq $true'`.| |_ImapEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter 'ImapEnabled -eq $false'`.| -|_ImmutableId_|_msExchGenericImmutableId_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'ImmutableId -ne $null'`.| +|_ImmutableId_|_msExchGenericImmutableId_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'ImmutableId -ne $null'`.| |_IncludeInGarbageCollection_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IncludeInGarbageCollection -eq $true'`.| -|_Initials_|_initials_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Initials -like 'B.'"`.| -|_InPlaceHolds_|_msExchUserHoldPolicies_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String|This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter "InPlaceHolds -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"`.
To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: `Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_InPlaceHoldsRaw_|n/a|**Get-LinkedUser**
**Get-User**|String|This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter "InPlaceHoldsRaw -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"`.
To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: `Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_IsDirSynced_|_msExchIsMSODirsynced_|**Get-Contact**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter 'IsDirSynced -eq $true'`.| +|_Initials_|_initials_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Initials -like 'B.'"`.| +|_InPlaceHolds_|_msExchUserHoldPolicies_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String|This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter "InPlaceHolds -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"`.
To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: `Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_InPlaceHoldsRaw_|n/a|**Get-LinkedUser**
**Get-User**|String|This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter "InPlaceHoldsRaw -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"`.
To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: `Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_IsDirSynced_|_msExchIsMSODirsynced_|**Get-Contact**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter 'IsDirSynced -eq $true'`.| |_IsExcludedFromServingHierarchy_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsExcludedFromServingHierarchy -eq $true'`.| |_IsHierarchyReady_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsHierarchyReady -eq $false'`.| |_IsHierarchySyncEnabled_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsHierarchySyncEnabled -eq $false'`.| |_IsInactiveMailbox_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsInactiveMailbox -eq $false'`.| -|_IsLinked_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsLinked -eq $true'`.| +|_IsLinked_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsLinked -eq $true'`.| |_IsMailboxEnabled_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsMailboxEnabled -eq $false'`.| |_IsResource_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsResource -eq $true'`.| -|_IsSecurityPrincipal_|n/a|**Get-LinkedUser**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter 'IsSecurityPrincipal -eq $false'`.| +|_IsSecurityPrincipal_|n/a|**Get-LinkedUser**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter 'IsSecurityPrincipal -eq $false'`.| |_IsShared_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsShared -eq $true'`.| -|_IsSoftDeletedByDisable_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsSoftDeletedByDisable -eq $true'`.| -|_IsSoftDeletedByRemove_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsSoftDeletedByRemove -eq $true'`.| -|_IssueWarningQuota_|_mDBStorageQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "IssueWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "IssueWarningQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.IssueWarningQuota - ''`". For example, `Get-Mailbox | where "$_.IssueWarningQuota -lt '50GB'"`.| -|_JournalArchiveAddress_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String|This property uses an SMTP email address. For example, `Get-Mailbox -Filter "JournalArchiveAddress -eq 'michelle@contoso.com'"`.| -|_LanguagesRaw_|_msExchUserCulture_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This property is named **Languages** in the properties of a mailbox, and it contains the language preference for the mailbox in the format `-`. For example, United States English is `en-US`. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo).
You can specify multiple values separated by commas, but the order matters. For example, `Get-Mailbox -Filter "LanguagesRaw -eq 'en-US,es-MX'"` returns different results than `Get-Mailbox -Filter "LanguagesRaw -eq 'es-MX,en-US'"`.
For single values, this multivalued property will return a match if the property _contains_ the specified value.| -|_LastExchangeChangedTime_|_msExchLastExchangeChangedTime_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Mailbox -Filter 'LastExchangeChangedTime -ne $null'`.| -|_LegacyExchangeDN_|_legacyExchangeDN_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-User -Filter "LegacyExchangeDN -like 'Osca*'"`.
You can find LegacyExchangeDN values for users by running this command: `Get-User | Format-List Name,LegacyExchangeDN`| -|_LitigationHoldDate_|_msExchLitigationHoldDate_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Mailbox -Filter "LitigationHoldDate -gt '8/13/2017'"`.| -|_LitigationHoldEnabled_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'LitigationHoldEnabled -eq $true'`.| -|_LitigationHoldOwner_|_msExchLitigationHoldOwner_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This property uses the user principal name of the litigation hold owner. For example, `Get-Mailbox -Filter "LitigationHoldOwner -eq 'agruber@contoso.com'"`.| -|_LastName_|_sn_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "LastName -like 'Martin*'"`.| -|_MailboxContainerGUID_|_msExchMailboxContainerGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'MailboxContainerGUID -ne $null'`.| -|_MailboxMoveBatchName_|_msExchMailboxMoveBatchName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This property includes the name of the migration batch. For example, `Get-Mailbox -Filter "MailboxMoveBatchName -like 'LocalMove 01*'"`.
You can find the names of migration batches by running the **Get-MigrationBatch** command. Note that migration batches that you create in the Exchange admin center use the naming convention `MigrationService:`.| -|_MailboxMoveFlags_|_msExchMailboxMoveFlags_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _Flags_ parameter in [Get-MoveRequest](https://docs.microsoft.com/powershell/module/exchange/get-moverequest).|For example, `Get-Mailbox -Filter "MailboxMoveFlags -ne 'None'"`.
You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-Recipient -Filter "MailboxMoveFlags -eq 'IntraOrg,Pull'"` returns the same results as `Get-Recipient -Filter "MailboxMoveFlags -eq 'Pull,IntraOrg'"`.
This multivalued property will only return a match if the property *equals* the specified value.| -|_MailboxMoveRemoteHostName_|_msExchMailboxMoveRemoteHostName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'MailboxMoveRemoteHostName -ne $null'`.| -|_MailboxMoveSourceMDB_|_msExchMailboxMoveSourceMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the source mailbox database. For example, `Get-Mailbox -Filter "MailboxMoveSourceMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| -|_MailboxMoveStatus_|_msExchMailboxMoveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _MoveStatus_ parameter in [Get-MoveRequest](https://docs.microsoft.com/powershell/module/exchange/get-moverequest).|For example, `Get-Mailbox -Filter "MailboxMoveStatus -eq 'Completed'"`.| -|_MailboxMoveTargetMDB_|_msExchMailboxMoveTargetMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the target mailbox database. For example, `Get-Mailbox -Filter "MailboxMoveTargetMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| -|_MailboxPlan_|_msExchParentPlanLink_|**Get-Mailbox**|String or `$null`|Mailbox plans correspond to Microsoft 365 license types. The availability of a license plans is determined by the selections that you make when you enroll your domain.
For example, `Get-Mailbox -Filter 'MailboxPlan -ne $null'`.| -|_MailboxRelease_|_msExchMailboxRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.|For example, `Get-Recipient -Filter 'MailboxRelease -ne $null'`.| -|_MailTipTranslations_|_msExchSenderHintTranslations_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|When you use this property in a filter, you need to account for the leading and trailing HTML tags. For example, `Get-DistributionGroup -Filter "MailTipTranslations -like 'is not monitored.*'"`.| -|_ManagedBy_|_managedBy_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group owner (a mail-enabled security principal, which is a mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter "ManagedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "ManagedBy -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_ManagedFolderMailboxPolicy_|_msExchMailboxTemplateLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|Managed folder mailbox policies aren't available in Exchange 2013 or later.
For example, `Get-Mailbox -Filter 'ManagedFolderMailboxPolicy -eq $null'`.
This filter requires the distinguished name of the managed folder mailbox policy. For example, `Get-Mailbox -Filter "ManagedFolderMailboxPolicy -eq 'CN=MFM Inbox Policy,CN=ELC Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of managed folder mailbox policies on Exchange 2010 servers by running this command: `Get-ManagedFolderMailboxPolicy | Format-List Name,DistinguishedName`.| -|_Manager_|_manager_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the manager (a mailbox or mail user). For example, `Get-User -Filter "Manager -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "Manager -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a manager, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName.`| +|_IsSoftDeletedByDisable_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsSoftDeletedByDisable -eq $true'`.| +|_IsSoftDeletedByRemove_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsSoftDeletedByRemove -eq $true'`.| +|_IssueWarningQuota_|_mDBStorageQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "IssueWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "IssueWarningQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.IssueWarningQuota - ''`". For example, `Get-Mailbox | where "$_.IssueWarningQuota -lt '50GB'"`.| +|_JournalArchiveAddress_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String|This property uses an SMTP email address. For example, `Get-Mailbox -Filter "JournalArchiveAddress -eq 'michelle@contoso.com'"`.| +|_LanguagesRaw_|_msExchUserCulture_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This property is named **Languages** in the properties of a mailbox, and it contains the language preference for the mailbox in the format `-`. For example, United States English is `en-US`. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo).
You can specify multiple values separated by commas, but the order matters. For example, `Get-Mailbox -Filter "LanguagesRaw -eq 'en-US,es-MX'"` returns different results than `Get-Mailbox -Filter "LanguagesRaw -eq 'es-MX,en-US'"`.
For single values, this multivalued property will return a match if the property _contains_ the specified value.| +|_LastExchangeChangedTime_|_msExchLastExchangeChangedTime_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Mailbox -Filter 'LastExchangeChangedTime -ne $null'`.| +|_LegacyExchangeDN_|_legacyExchangeDN_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-User -Filter "LegacyExchangeDN -like 'Osca*'"`.
You can find LegacyExchangeDN values for users by running this command: `Get-User | Format-List Name,LegacyExchangeDN`| +|_LitigationHoldDate_|_msExchLitigationHoldDate_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Mailbox -Filter "LitigationHoldDate -gt '8/13/2017'"`.| +|_LitigationHoldEnabled_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'LitigationHoldEnabled -eq $true'`.| +|_LitigationHoldOwner_|_msExchLitigationHoldOwner_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This property uses the user principal name of the litigation hold owner. For example, `Get-Mailbox -Filter "LitigationHoldOwner -eq 'agruber@contoso.com'"`.| +|_LastName_|_sn_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "LastName -like 'Martin*'"`.| +|_MailboxContainerGUID_|_msExchMailboxContainerGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'MailboxContainerGUID -ne $null'`.| +|_MailboxMoveBatchName_|_msExchMailboxMoveBatchName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This property includes the name of the migration batch. For example, `Get-Mailbox -Filter "MailboxMoveBatchName -like 'LocalMove 01*'"`.
You can find the names of migration batches by running the **Get-MigrationBatch** command. Note that migration batches that you create in the Exchange admin center use the naming convention `MigrationService:`.| +|_MailboxMoveFlags_|_msExchMailboxMoveFlags_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _Flags_ parameter in [Get-MoveRequest](https://docs.microsoft.com/powershell/module/exchange/get-moverequest).|For example, `Get-Mailbox -Filter "MailboxMoveFlags -ne 'None'"`.
You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-Recipient -Filter "MailboxMoveFlags -eq 'IntraOrg,Pull'"` returns the same results as `Get-Recipient -Filter "MailboxMoveFlags -eq 'Pull,IntraOrg'"`.
This multivalued property will only return a match if the property *equals* the specified value.| +|_MailboxMoveRemoteHostName_|_msExchMailboxMoveRemoteHostName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'MailboxMoveRemoteHostName -ne $null'`.| +|_MailboxMoveSourceMDB_|_msExchMailboxMoveSourceMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the source mailbox database. For example, `Get-Mailbox -Filter "MailboxMoveSourceMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| +|_MailboxMoveStatus_|_msExchMailboxMoveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _MoveStatus_ parameter in [Get-MoveRequest](https://docs.microsoft.com/powershell/module/exchange/get-moverequest).|For example, `Get-Mailbox -Filter "MailboxMoveStatus -eq 'Completed'"`.| +|_MailboxMoveTargetMDB_|_msExchMailboxMoveTargetMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the target mailbox database. For example, `Get-Mailbox -Filter "MailboxMoveTargetMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| +|_MailboxPlan_|_msExchParentPlanLink_|**Get-Mailbox**|String or `$null`|Mailbox plans correspond to Microsoft 365 license types. The availability of a license plans is determined by the selections that you make when you enroll your domain.
For example, `Get-Mailbox -Filter 'MailboxPlan -ne $null'`.| +|_MailboxRelease_|_msExchMailboxRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.|For example, `Get-Recipient -Filter 'MailboxRelease -ne $null'`.| +|_MailTipTranslations_|_msExchSenderHintTranslations_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|When you use this property in a filter, you need to account for the leading and trailing HTML tags. For example, `Get-DistributionGroup -Filter "MailTipTranslations -like 'is not monitored.*'"`.| +|_ManagedBy_|_managedBy_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group owner (a mail-enabled security principal, which is a mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter "ManagedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "ManagedBy -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_ManagedFolderMailboxPolicy_|_msExchMailboxTemplateLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|Managed folder mailbox policies aren't available in Exchange 2013 or later.
For example, `Get-Mailbox -Filter 'ManagedFolderMailboxPolicy -eq $null'`.
This filter requires the distinguished name of the managed folder mailbox policy. For example, `Get-Mailbox -Filter "ManagedFolderMailboxPolicy -eq 'CN=MFM Inbox Policy,CN=ELC Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of managed folder mailbox policies on Exchange 2010 servers by running this command: `Get-ManagedFolderMailboxPolicy | Format-List Name,DistinguishedName`.| +|_Manager_|_manager_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the manager (a mailbox or mail user). For example, `Get-User -Filter "Manager -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "Manager -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a manager, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName.`| |_MAPIEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter 'MAPIEnabled -eq $false'`.| -|_MasterAccountSid_|_msExchMasterAccountSid_|**Get-Mailbox**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String or `$null`|For example, `Get-Mailbox -Filter 'MasterAccountSid -ne $null'`.
This value is blank ( `$null`) for mailboxes with associated user accounts, and `S-1-5-10` (Self) for mailboxes without associated user accounts (for example, shared mailboxes, resource mailboxes, discovery search mailboxes, arbitration mailboxes, and public folder mailboxes).| +|_MasterAccountSid_|_msExchMasterAccountSid_|**Get-Mailbox**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String or `$null`|For example, `Get-Mailbox -Filter 'MasterAccountSid -ne $null'`.
This value is blank ( `$null`) for mailboxes with associated user accounts, and `S-1-5-10` (Self) for mailboxes without associated user accounts (for example, shared mailboxes, resource mailboxes, discovery search mailboxes, arbitration mailboxes, and public folder mailboxes).| |_MaxBlockedSenders_|_msExchMaxBlockedSenders_|**Get-Mailbox**|Integer or `$null`|For example, `Get-Mailbox -Filter "MaxBlockedSenders -gt 0"`.| -|_MaxReceiveSize_|_delivContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "MaxReceiveSize -eq 'Unlimited'"` or `Get-Mailbox -Filter "MaxReceiveSize -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.MaxReceiveSize - ''"`. For example, `Get-Mailbox | where "$_.MaxReceiveSize -gt '50GB'"`.| +|_MaxReceiveSize_|_delivContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "MaxReceiveSize -eq 'Unlimited'"` or `Get-Mailbox -Filter "MaxReceiveSize -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.MaxReceiveSize - ''"`. For example, `Get-Mailbox | where "$_.MaxReceiveSize -gt '50GB'"`.| |_MaxSafeSenders_|_msExchMaxSafeSenders_|**Get-Mailbox**|Integer or `$null`|For example, `Get-Mailbox -Filter "MaxSafeSenders -gt 0"`.| -|_MaxSendSize_|_submissionContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "MaxSendSize -eq 'Unlimited'"` or `Get-Mailbox -Filter "MaxSendSize -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.MaxReceiveSize - ''"`. For example, `Get-Mailbox | where "$_.MaxSendSize -gt '50GB'"`.| +|_MaxSendSize_|_submissionContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "MaxSendSize -eq 'Unlimited'"` or `Get-Mailbox -Filter "MaxSendSize -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.MaxReceiveSize - ''"`. For example, `Get-Mailbox | where "$_.MaxSendSize -gt '50GB'"`.| |_MemberDepartRestriction_|_msExchGroupDepartRestriction_|**Get-DistributionGroup**|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|For example, `Get-DistributionGroup -Filter "MemberDepartRestriction -eq 'ApprovalRequired'"`.| |_MemberJoinRestriction_|_msExchGroupDepartRestriction_|**Get-DistributionGroup**|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|For example, `Get-DistributionGroup -Filter "MemberJoinRestriction -eq 'ApprovalRequired'"`.| -|_MemberOfGroup_|_memberOf_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the distribution group or mail-enabled security group. For example, `Get-User -Filter "MemberOfGroup -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "MemberOfGroup -eq 'contoso.com/Users/Marketing Group'"`.
To find the distinguished name of a group, replace _\_ with the name, alias, or email address of the group, and run this command: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_Members_|_member_|**Get-DistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-SecurityPrincipal**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group member. For example, `Get-Group -Filter "Members -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "Members -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a group member, replace _\_ with the name, alias, or email address of the group member, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_MobilePhone_|_mobile_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "MobilePhone -like '555*'"`.| -|_ModeratedBy_|_msExchModeratedByLink_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String|This filter requires the distinguished name or canonical distinguished name of the group moderator (a mail-enabled security principal, which is a mailbox, mail-user, or mail-enabled security group). For example, `Get-DistributionGroup -Filter "ModeratedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "ModeratedBy -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_ModerationEnabled_|_msExchEnableModeration_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'ModerationEnabled -eq $true'`.| -|_Name_|_name_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-User -Filter "Name -like 'Laura*'"`.| -|_NetID_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|String or `$null`|This property is populated for Exchange Online mailboxes in hybrid environments. A sample value is `1003BFFD9A0CFA03`.
For example, `Get-User -Filter 'NetId -ne $null'`.| -|_Notes_|_info_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Notes -like 'Events Team*'"`.| -|_ObjectCategory_|_objectCategory_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|This filter requires the canonical distinguished name of the object. The value uses the syntax `/Configuration/Schema/`.
Valid _\_ values are: `Person` for mailboxes, mail users, and mail contacts, `Group` for distribution groups, mail-enabled security groups and Microsoft 365 Groups, `ms-Exch-Public-Folder` for mail-enabled public folders, and `ms-Exch-Dynamic-Distribution-List` for dynamic distribution groups.
For example, `Get-Recipient -Filter "ObjectCategory -eq 'contoso.com/Configuration/Schema/Group'"`.| -|_ObjectClass_|_objectClass_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|The value of this property is `top, person, organizationalPerson, user` for mailboxes and mail users, `top, person, organizationalPerson, contact` for mail contacts, `top, group` for distribution groups, mail-enabled security groups and Microsoft 365 Groups, `msExchDynamicDistributionList` for dynamic distribution groups and `top, publicFolder` for mail-enabled public folders
For example, `Get-Recipient -Filter "ObjectClass -eq 'Contact'"`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_Office_|_physicalDeliveryOfficeName_|**Get-Contact**
**Get-LinkedUser**
**Get-Mailbox**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Office -like '22*'"`.| -|_OfflineAddressBook_|_msExchUseOAB_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter "OfflineAddressBook -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`
You can find the distinguished names of offline address books by running this command: `Get-OfflineAddressBook | Format-List Name,DistinguishedName`.| +|_MemberOfGroup_|_memberOf_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the distribution group or mail-enabled security group. For example, `Get-User -Filter "MemberOfGroup -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "MemberOfGroup -eq 'contoso.com/Users/Marketing Group'"`.
To find the distinguished name of a group, replace _\_ with the name, alias, or email address of the group, and run this command: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_Members_|_member_|**Get-DistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-SecurityPrincipal**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group member. For example, `Get-Group -Filter "Members -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "Members -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a group member, replace _\_ with the name, alias, or email address of the group member, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_MobilePhone_|_mobile_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "MobilePhone -like '555*'"`.| +|_ModeratedBy_|_msExchModeratedByLink_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String|This filter requires the distinguished name or canonical distinguished name of the group moderator (a mail-enabled security principal, which is a mailbox, mail-user, or mail-enabled security group). For example, `Get-DistributionGroup -Filter "ModeratedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "ModeratedBy -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_ModerationEnabled_|_msExchEnableModeration_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'ModerationEnabled -eq $true'`.| +|_Name_|_name_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-User -Filter "Name -like 'Laura*'"`.| +|_NetID_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|String or `$null`|This property is populated for Exchange Online mailboxes in hybrid environments. A sample value is `1003BFFD9A0CFA03`.
For example, `Get-User -Filter 'NetId -ne $null'`.| +|_Notes_|_info_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Notes -like 'Events Team*'"`.| +|_ObjectCategory_|_objectCategory_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|This filter requires the canonical distinguished name of the object. The value uses the syntax `/Configuration/Schema/`.
Valid _\_ values are: `Person` for mailboxes, mail users, and mail contacts, `Group` for distribution groups, mail-enabled security groups and Microsoft 365 Groups, `ms-Exch-Public-Folder` for mail-enabled public folders, and `ms-Exch-Dynamic-Distribution-List` for dynamic distribution groups.
For example, `Get-Recipient -Filter "ObjectCategory -eq 'contoso.com/Configuration/Schema/Group'"`.| +|_ObjectClass_|_objectClass_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|The value of this property is `top, person, organizationalPerson, user` for mailboxes and mail users, `top, person, organizationalPerson, contact` for mail contacts, `top, group` for distribution groups, mail-enabled security groups and Microsoft 365 Groups, `msExchDynamicDistributionList` for dynamic distribution groups and `top, publicFolder` for mail-enabled public folders
For example, `Get-Recipient -Filter "ObjectClass -eq 'Contact'"`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_Office_|_physicalDeliveryOfficeName_|**Get-Contact**
**Get-LinkedUser**
**Get-Mailbox**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Office -like '22*'"`.| +|_OfflineAddressBook_|_msExchUseOAB_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter "OfflineAddressBook -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`
You can find the distinguished names of offline address books by running this command: `Get-OfflineAddressBook | Format-List Name,DistinguishedName`.| |_OnPremisesObjectId_|n/a|**Get-MailPublicFolder**|String or `$null`|For example, `Get-MailPublicFolder -Filter 'OnPremisesObjectId -ne $null'`.| |_OperatorNumber_|_msExchUMOperatorNumber_|**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-UMMailbox -Filter "OperatorNumber -eq 5"`.| -|_OtherFax_|_otherFacsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "OtherFax -like '206*'"`.| -|_OtherHomePhone_|_otherHomePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "OtherHomePhone -like '206*'"`.| -|_OtherTelephone_|_otherTelephone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "OtherTelephone -like '206*'"`.| +|_OtherFax_|_otherFacsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "OtherFax -like '206*'"`.| +|_OtherHomePhone_|_otherHomePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "OtherHomePhone -like '206*'"`.| +|_OtherTelephone_|_otherTelephone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "OtherTelephone -like '206*'"`.| |_OWAEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|The filter operates backwards. For example, `Get-CASMailbox -Filter 'OWAEnabled -eq $true'` returns mailboxes where the **OWAEnabled** property is `False`, and `Get-CASMailbox -Filter 'OWAEnabled -eq $false'` returns mailboxes where the **OWAEnabled** property is `True`| |_OWAforDevicesEnabled_|_msExchOmaAdminWirelessEnable_|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter 'OWAForDevicesEnabled -eq $true'`.| -|_OWAMailboxPolicy_|_msExchOWAPolicy_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the Outlook on the web mailbox policy (formerly known as an Outlook Web App mailbox policy). For example, `Get-CASMailbox -Filter "OWAMailboxPolicy -eq 'CN=Default,CN=OWA Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com`'".
You can find the distinguished names of Outlook on the web mailbox policies by running this command: `Get-OwaMailboxPolicy | Format-List Name,DistinguishedName`.| -|_Pager_|_pager_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Pager -like '206*'"`.| -|_PersistedCapabilities_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|Typically, the value of this property something other than `$null` (blank) for Microsoft 365 accounts and mailboxes. For more information about the valid property values, see [Capability enumeration](https://docs.microsoft.com/previous-versions/office/exchange-server-api/ff441134(v=exchg.150)).
For example, `Get-Mailbox -Filter 'PersistedCapabilities -ne $null'`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_Phone_|_telephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Phone -like '206*'"`.| +|_OWAMailboxPolicy_|_msExchOWAPolicy_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the Outlook on the web mailbox policy (formerly known as an Outlook Web App mailbox policy). For example, `Get-CASMailbox -Filter "OWAMailboxPolicy -eq 'CN=Default,CN=OWA Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com`'".
You can find the distinguished names of Outlook on the web mailbox policies by running this command: `Get-OwaMailboxPolicy | Format-List Name,DistinguishedName`.| +|_Pager_|_pager_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Pager -like '206*'"`.| +|_PersistedCapabilities_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|Typically, the value of this property something other than `$null` (blank) for Microsoft 365 accounts and mailboxes. For more information about the valid property values, see [Capability enumeration](https://docs.microsoft.com/previous-versions/office/exchange-server-api/ff441134(v=exchg.150)).
For example, `Get-Mailbox -Filter 'PersistedCapabilities -ne $null'`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_Phone_|_telephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Phone -like '206*'"`.| |_PhoneProviderId_|_msExchUMPhoneProvider_|**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-UMMailbox -Filter "PhoneProviderId -like '206*'"`.| -|_PhoneticDisplayName_|_msDS-PhoneticDisplayName_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-MailPublicFolder**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "PhoneticDisplayName -like 'Lila*'"`.| -|_PoliciesExcluded_|_msExchPoliciesExcluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-Recipient -Filter 'PoliciesExcluded -ne $null'`.| -|_PoliciesIncluded_|_msExchPoliciesIncluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-Recipient -Filter 'PoliciesIncluded -eq $null'`.| +|_PhoneticDisplayName_|_msDS-PhoneticDisplayName_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-MailPublicFolder**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "PhoneticDisplayName -like 'Lila*'"`.| +|_PoliciesExcluded_|_msExchPoliciesExcluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-Recipient -Filter 'PoliciesExcluded -ne $null'`.| +|_PoliciesIncluded_|_msExchPoliciesIncluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-Recipient -Filter 'PoliciesIncluded -eq $null'`.| |_PopEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter 'POPEnabled -eq $false'`.| -|_PostalCode_|_postalCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "PostalCode -eq 90210"`.| -|_PostOfficeBox_|_postOfficeBox_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "PostOfficeBox -like '555*'"`.| -|_PreviousRecipientTypeDetails_|_msExchPreviousRecipientTypeDetails_|**Get-LinkedUser**
**Get-User**|String or `$null`|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](https://docs.microsoft.com/powershell/module/exchange/get-recipient).
For example, `Get-User -Filter 'PreviousRecipientTypeDetails -ne $null'`.| -|_PrimarySmtpAddress_|n/a|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)|Don't use the _PrimarySmtpAddress_ property; use the _EmailAddresses_ property instead. Any filter that uses the _PrimarySmtpAddress_ property will also search values in the _EmailAddresses_ property. For example, if a mailbox has the primary email address dario@contoso.com, and the additional proxy addresses dario2@contoso.com and dario3@contoso.com, all of the following filters will return that mailbox in the result: `"PrimarySmtpAddress -eq 'dario@contoso.com'"`, `"PrimarySmtpAddress -eq 'dario2@contoso.com'"`, or `"PrimarySmtpAddress -eq 'dario3@contoso.com'"`.| -|_ProhibitSendQuota_|_mDBOverQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ProhibitSendQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ProhibitSendQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ProhibitSendQuota - ''"`. For example, `Get-Mailbox | where "$_.ProhibitSendQuota -lt '70GB'"`.| -|_ProhibitSendReceiveQuota_|_mDBOverHardQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ProhibitSendReceiveQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ProhibitSendReceiveQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ProhibitSendReceiveQuota - ''"`. For example, `Get-Mailbox | where "$_.ProhibitSendReceiveQuota -lt '70GB'"`.| -|_ProtocolSettings_|_protocolSettings_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|The default value of this property on mailboxes is `RemotePowerShell§1`. This property is populated with additional values when you use Set-CASMailbox to disable protocols (for example, POP3 or IMAP4).
For example, `Get-Mailbox -Filter "ProtocolSettings -like 'POP3*'"`.| -|_PublicFolderContacts_|_pFContacts_|**Get-MailPublicFolder**|String or `$null`|This property is displayed as **Contacts** in the results of the command `Get-MailPublicFolder -Identity | Format-List`, but you need to use the property name **PublicFolderContacts** in the filter.
This filter requires the distinguished name or canonical distinguished name of the public folder contact. For example, `Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a public folder contact, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_QueryBaseDN_|_msExchQueryBaseDN_|**Get-Mailbox**|String or `$null`|This property was used in Exchange 2007 global address list segregation to specify a location in Active Directory. This feature was replaced by address book policies in Exchange 2010 Service Pack 2, so the value of this property should always be blank ( `$null`).
For example, `Get-Mailbox -Filter 'QueryBaseDN -ne $null'`.| -|_RecipientContainer_|_msExchDynamicDLBaseDN_|**Get-DynamicDistributionGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the organizational unit or container in Active Directory. For example, `Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'CN=Users,DC=contoso,DC=com'"` or `Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'contoso.com/Users'"`
To find the distinguished names or canonical distinguished names of organizational units and containers in Active Directory, run this command: `Get-OrganizationalUnit -IncludeContainers | Format-List Name,DistinguishedName,ID`.| -|_RecipientLimits_|_msExchRecipLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Integer or `Unlimited`|For example, `Get-Mailbox -Filter "RecipientLimits -ne 'Unlimited'"`.| -|_RecipientType_|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**
**Get-UnifiedGroup**|`DynamicDistributionGroup`, `MailContact`, `MailNonUniversalGroup`, `MailUniversalDistributionGroup`, `MailUniversalSecurityGroup`, `MailUser`, `PublicFolder` or `UserMailbox`|For example, `Get-Recipient -Filter "RecipientType -eq 'MailContact'"`.| -|_RecipientTypeDetails_|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**
**Get-UnifiedGroup**|String|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](https://docs.microsoft.com/powershell/module/exchange/get-recipient).
For example, `Get-Recipient -Filter "RecipientTypeDetails -eq 'SharedMailbox'"`.| -|_RecoverableItemsQuota_|_msExchDumpsterQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "RecoverableItemsQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "RecoverableItemsQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RecoverableItemsQuota - ''`. For example, `Get-Mailbox | where "$_.RecoverableItemsQuota -gt '35GB'"`.| -|_RecoverableItemsWarningQuota_|_msExchDumpsterWarningQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "RecoverableItemsWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "RecoverableItemsWarningQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RecoverableItemsWarningQuota - ''`". For example, `Get-Mailbox | where "$_.RecoverableItemsWarningQuota -gt '25GB'"`.| -|_RejectMessagesFrom_|_unauthOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_RejectMessagesFromDLMembers_|_dLMemRejectPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'contoso.com/Users/Marketing Department'"`.
To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName` or `Get-DynamicDistributionGroup -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_PostalCode_|_postalCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "PostalCode -eq 90210"`.| +|_PostOfficeBox_|_postOfficeBox_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "PostOfficeBox -like '555*'"`.| +|_PreviousRecipientTypeDetails_|_msExchPreviousRecipientTypeDetails_|**Get-LinkedUser**
**Get-User**|String or `$null`|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](https://docs.microsoft.com/powershell/module/exchange/get-recipient).
For example, `Get-User -Filter 'PreviousRecipientTypeDetails -ne $null'`.| +|_PrimarySmtpAddress_|n/a|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)|Don't use the _PrimarySmtpAddress_ property; use the _EmailAddresses_ property instead. Any filter that uses the _PrimarySmtpAddress_ property will also search values in the _EmailAddresses_ property. For example, if a mailbox has the primary email address dario@contoso.com, and the additional proxy addresses dario2@contoso.com and dario3@contoso.com, all of the following filters will return that mailbox in the result: `"PrimarySmtpAddress -eq 'dario@contoso.com'"`, `"PrimarySmtpAddress -eq 'dario2@contoso.com'"`, or `"PrimarySmtpAddress -eq 'dario3@contoso.com'"`.| +|_ProhibitSendQuota_|_mDBOverQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ProhibitSendQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ProhibitSendQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ProhibitSendQuota - ''"`. For example, `Get-Mailbox | where "$_.ProhibitSendQuota -lt '70GB'"`.| +|_ProhibitSendReceiveQuota_|_mDBOverHardQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ProhibitSendReceiveQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ProhibitSendReceiveQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ProhibitSendReceiveQuota - ''"`. For example, `Get-Mailbox | where "$_.ProhibitSendReceiveQuota -lt '70GB'"`.| +|_ProtocolSettings_|_protocolSettings_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|The default value of this property on mailboxes is `RemotePowerShell§1`. This property is populated with additional values when you use Set-CASMailbox to disable protocols (for example, POP3 or IMAP4).
For example, `Get-Mailbox -Filter "ProtocolSettings -like 'POP3*'"`.| +|_PublicFolderContacts_|_pFContacts_|**Get-MailPublicFolder**|String or `$null`|This property is displayed as **Contacts** in the results of the command `Get-MailPublicFolder -Identity | Format-List`, but you need to use the property name **PublicFolderContacts** in the filter.
This filter requires the distinguished name or canonical distinguished name of the public folder contact. For example, `Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a public folder contact, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_QueryBaseDN_|_msExchQueryBaseDN_|**Get-Mailbox**|String or `$null`|This property was used in Exchange 2007 global address list segregation to specify a location in Active Directory. This feature was replaced by address book policies in Exchange 2010 Service Pack 2, so the value of this property should always be blank ( `$null`).
For example, `Get-Mailbox -Filter 'QueryBaseDN -ne $null'`.| +|_RecipientContainer_|_msExchDynamicDLBaseDN_|**Get-DynamicDistributionGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the organizational unit or container in Active Directory. For example, `Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'CN=Users,DC=contoso,DC=com'"` or `Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'contoso.com/Users'"`
To find the distinguished names or canonical distinguished names of organizational units and containers in Active Directory, run this command: `Get-OrganizationalUnit -IncludeContainers | Format-List Name,DistinguishedName,ID`.| +|_RecipientLimits_|_msExchRecipLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Integer or `Unlimited`|For example, `Get-Mailbox -Filter "RecipientLimits -ne 'Unlimited'"`.| +|_RecipientType_|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**
**Get-UnifiedGroup**|`DynamicDistributionGroup`, `MailContact`, `MailNonUniversalGroup`, `MailUniversalDistributionGroup`, `MailUniversalSecurityGroup`, `MailUser`, `PublicFolder` or `UserMailbox`|For example, `Get-Recipient -Filter "RecipientType -eq 'MailContact'"`.| +|_RecipientTypeDetails_|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**
**Get-UnifiedGroup**|String|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](https://docs.microsoft.com/powershell/module/exchange/get-recipient).
For example, `Get-Recipient -Filter "RecipientTypeDetails -eq 'SharedMailbox'"`.| +|_RecoverableItemsQuota_|_msExchDumpsterQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "RecoverableItemsQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "RecoverableItemsQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RecoverableItemsQuota - ''`. For example, `Get-Mailbox | where "$_.RecoverableItemsQuota -gt '35GB'"`.| +|_RecoverableItemsWarningQuota_|_msExchDumpsterWarningQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "RecoverableItemsWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "RecoverableItemsWarningQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RecoverableItemsWarningQuota - ''`". For example, `Get-Mailbox | where "$_.RecoverableItemsWarningQuota -gt '25GB'"`.| +|_RejectMessagesFrom_|_unauthOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_RejectMessagesFromDLMembers_|_dLMemRejectPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'contoso.com/Users/Marketing Department'"`.
To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName` or `Get-DynamicDistributionGroup -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| |_RemoteAccountPolicy_|_msExchSyncAccountsPolicyDN_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the remote account policy. For example, `Get-Mailbox -Filter "RemoteAccountPolicy -eq 'CN=Contoso Remote Account Policy,CN=Remote Accounts Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.| |_RemotePowerShellEnabled_|n/a|**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter 'RemotePowerShellEnabled -eq $false'`.| -|_RemoteRecipientType_|_msExchRemoteRecipientType_|**Get-Mailbox**
**Get-RemoteMailbox**|`None` (0), `ProvisionMailbox` (1), `ProvisionArchive` (2), `Migrated` (4), `DeprovisionMailbox` (8), `DeprovisionArchive` (16), `RoomMailbox` (32), `EquipmentMailbox` (64), `SharedMailbox` (96), `TeamMailbox` (128), or `$null`.|For example, `Get-RemoteMailbox -Filter "RemoteRecipientType -eq 'ProvisionMailbox'"`.| -|_ReportToManagerEnabled_|_reportToOwner_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'ReportToManagerEnabled -eq $true'`.| -|_ReportToOriginatorEnabled_|_reportToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'ReportToOriginatorEnabled -eq $false'`.| -|_RequireAllSendersAreAuthenticated_|_msExchRequireAuthToSendTo_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**|Boolean (`$true` or `$false`)|This property is displayed as **RequireSenderAuthenticationEnabled** in the results of the command `Get- -Identity | Format-List`, but you need to use the property name **RequireAllSendersAreAuthenticated** in the filter. For example, `Get-DistributionGroup -Filter 'RequireAllSendersAreAuthenticated -eq $false'`.| +|_RemoteRecipientType_|_msExchRemoteRecipientType_|**Get-Mailbox**
**Get-RemoteMailbox**|`None` (0), `ProvisionMailbox` (1), `ProvisionArchive` (2), `Migrated` (4), `DeprovisionMailbox` (8), `DeprovisionArchive` (16), `RoomMailbox` (32), `EquipmentMailbox` (64), `SharedMailbox` (96), `TeamMailbox` (128), or `$null`.|For example, `Get-RemoteMailbox -Filter "RemoteRecipientType -eq 'ProvisionMailbox'"`.| +|_ReportToManagerEnabled_|_reportToOwner_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'ReportToManagerEnabled -eq $true'`.| +|_ReportToOriginatorEnabled_|_reportToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'ReportToOriginatorEnabled -eq $false'`.| +|_RequireAllSendersAreAuthenticated_|_msExchRequireAuthToSendTo_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**|Boolean (`$true` or `$false`)|This property is displayed as **RequireSenderAuthenticationEnabled** in the results of the command `Get- -Identity | Format-List`, but you need to use the property name **RequireAllSendersAreAuthenticated** in the filter. For example, `Get-DistributionGroup -Filter 'RequireAllSendersAreAuthenticated -eq $false'`.| |_ResourceBehaviorOptions_|n/a|**Get-UnifiedGroup**|`AllowOnlyMembersToPost`, `CalendarMemberReadOnly`, `ConnectorsEnabled`, `HideGroupInOutlook`, `NotebookForLearningCommunitiesEnabled`, `ReportToOriginator`, `SharePointReadonlyForMembers`, `SubscriptionEnabled`, `SubscribeMembersToCalendarEvents`, `SubscribeMembersToCalendarEventsDisabled`, `SubscribeNewGroupMembers`, `WelcomeEmailDisabled`, `WelcomeEmailEnabled`, or `$null`|For example, `Get-UnifiedGroup -Filter "ResourceBehaviorOptions -eq 'CalendarMemberReadOnly'"`| |_ResourceCapacity_|_msExchResourceCapacity_|**Get-Mailbox**|Integer or `$null`|For example, `Get-Mailbox -Filter "ResourceCapacity -gt 15"`| -|_ResourceCustom_|n/a|**Get-Mailbox**|String or `$null`|You create custom resource properties by using the Set-ResourceConfig cmdlet. For example, `Set-ResourceConfig -ResourcePropertySchema Room/Whiteboard,Equipment/Van`. After you create the properties, you can assign them to room or equipment mailboxes. For example, `Set-Mailbox -Identity "Conference Room 1" -ResourceCustom Whiteboard`.
When you search for values, use the custom resource property that's assigned to the room or equipment mailbox. For example, `Get-Mailbox -Filter "ResourceCustom -eq 'Whiteboard'"`.| +|_ResourceCustom_|n/a|**Get-Mailbox**|String or `$null`|You create custom resource properties by using the Set-ResourceConfig cmdlet. For example, `Set-ResourceConfig -ResourcePropertySchema Room/Whiteboard,Equipment/Van`. After you create the properties, you can assign them to room or equipment mailboxes. For example, `Set-Mailbox -Identity "Conference Room 1" -ResourceCustom Whiteboard`.
When you search for values, use the custom resource property that's assigned to the room or equipment mailbox. For example, `Get-Mailbox -Filter "ResourceCustom -eq 'Whiteboard'"`.| |_ResourceProvisioningOptions_|n/a|**Get-UnifiedGroup**|`Team` or `$null`|For example, `Get-UnifiedGroup -Filter "ResourceProvisioningOptions -eq 'Team'"`| -|_ResourceType_|n/a|**Get-Mailbox**
**Get-Recipient**|`Room` (0), `Equipment` (1), or `$null`|For example, `Get-Mailbox -Filter "ResourceType -eq 'Equipment'"`| -|_RetainDeletedItemsFor_|_garbageCollPeriod_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.|You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: `Get-Mailbox | where "$_.RetainDeletedItemsFor - ''"`. For example, `Get-Mailbox | where "$_.RetainDeletedItemsFor -gt '14.00:00:00'"`.| -|_RetentionComment_|_msExchRetentionComment_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "RetentionComment -like '7 years*'"`| -|_RetentionPolicy_|n/a|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the retention policy. For example, `Get-Mailbox -Filter "RetentionPolicy -eq 'CN=Default MRM Policy,CN=Retention Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of retention policies, run this command: `Get-RetentionPolicy | Format-List Name,DistinguishedName`.| -|_RetentionUrl_|_msExchRetentionURL_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "RetentionUrl -like 'https://intranet.contoso.com/*'"`| -|_RoleAssignmentPolicy_|_msExchRBACPolicyLink_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This filter requires the distinguished name of the role assignment policy in Exchange Online. For example, `Get-Mailbox -Filter "RoleAssignmentPolicy -eq 'CN=Default Role Assignment Policy,CN=Policies,CN=RBAC,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR10A001,DC=PROD,DC=OUTLOOK,DC=COM'"`.
To find the distinguished names of role assignment policies in Exchange Online, run this command: `Get-RoleAssignmentPolicy | Format-List Name,DistinguishedName`.| +|_ResourceType_|n/a|**Get-Mailbox**
**Get-Recipient**|`Room` (0), `Equipment` (1), or `$null`|For example, `Get-Mailbox -Filter "ResourceType -eq 'Equipment'"`| +|_RetainDeletedItemsFor_|_garbageCollPeriod_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.|You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: `Get-Mailbox | where "$_.RetainDeletedItemsFor - ''"`. For example, `Get-Mailbox | where "$_.RetainDeletedItemsFor -gt '14.00:00:00'"`.| +|_RetentionComment_|_msExchRetentionComment_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "RetentionComment -like '7 years*'"`| +|_RetentionPolicy_|n/a|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the retention policy. For example, `Get-Mailbox -Filter "RetentionPolicy -eq 'CN=Default MRM Policy,CN=Retention Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of retention policies, run this command: `Get-RetentionPolicy | Format-List Name,DistinguishedName`.| +|_RetentionUrl_|_msExchRetentionURL_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "RetentionUrl -like 'https://intranet.contoso.com/*'"`| +|_RoleAssignmentPolicy_|_msExchRBACPolicyLink_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This filter requires the distinguished name of the role assignment policy in Exchange Online. For example, `Get-Mailbox -Filter "RoleAssignmentPolicy -eq 'CN=Default Role Assignment Policy,CN=Policies,CN=RBAC,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR10A001,DC=PROD,DC=OUTLOOK,DC=COM'"`.
To find the distinguished names of role assignment policies in Exchange Online, run this command: `Get-RoleAssignmentPolicy | Format-List Name,DistinguishedName`.| |_RulesQuota_|_msExchMDBRulesQuota_|**Get-Mailbox**|A byte quantified size value (for example, `50B` or `128KB`). Unqualified values are treated as bytes.|You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RulesQuota - ''"`. For example, `Get-Mailbox | where "$_.RulesQuota -lt '256KB'"`.| |_SafeRecipientsHash_|_msExchSafeRecipientsHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.|Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'SafeRecipientsHash -ne $null'.`| |_SafeSendersHash_|_msExchSafeSendersHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.|Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'SafeSendersHash -ne $null'.`| -|_SamAccountName_|_SamAccountName_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "SamAccountName -like 'laura*'"`| +|_SamAccountName_|_SamAccountName_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "SamAccountName -like 'laura*'"`| |_SCLDeleteThresholdInt_|_msExchMessageHygieneSCLDeleteThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLDeleteThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLDeleteThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLDeleteThresholdInt -ge -2147483640"`.| |_SCLJunkThresholdInt_|_msExchMessageHygieneSCLJunkThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLJunkThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLJunkThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLJunkThresholdInt -ge -2147483645"`.| |_SCLQuarantineThresholdInt_|_msExchMessageHygieneSCLQuarantineThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLQuarantineThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLQuarantineThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLQuarantineThresholdInt -ge -2147483643"`.| |_SCLRejectThresholdInt_|_msExchMessageHygieneSCLRejectThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLRejectThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLRejectThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLRejectThresholdInt -ge -2147483641"`.| -|_SendOofMessageToOriginatorEnabled_|_oOFReplyToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'SendOofMessageToOriginatorEnabled -eq $true'`.| -|_ServerLegacyDN_|_msExchHomeServerName_|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "ServerLegacyDN -like 'Mailbox01'"`.
This is an example of a complete **ServerLegacyDN** value: `/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01`.| -|_ServerName_|n/a|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String or `$null`|For example, `Get-Recipient -Filter "ServerName -eq 'Mailbox01'"`.| -|_SharingPolicy_|_msExchSharingPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the sharing policy. For example, `Get-Mailbox -Filter "SharingPolicy -eq 'CN=Custom Sharing Policy,CN=Federation,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of sharing policies, run this command: `Get-SharingPolicy | Format-List Name,DistinguishedName`.
**Note**: For the default assignment of the default sharing policy (named Default Sharing Policy) to a mailbox, the value of the **SharingPolicy** property is blank (`$null`).| -|_Sid_|_objectSid_|**Get-Group**
**Get-LinkedUser**
**Get-SecurityPrincipal**
**Get-User**|String|For example, `Get-User -Filter "Sid -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"`.| -|_SidHistory_|_SIDHistory_|**Get-Group**
**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter "SidHistory -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"`.| -|_SimpleDisplayName_|_displayNamePrintable_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "SimpleDisplayName -like 'lila*'"`.| -|_SingleItemrecoveryEnabled_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'SingleItemRecoveryEnabled -eq $true'`.| -|_SKUAssigned_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|Boolean (`$true` or `$false`) or `$null`.|For example, `Get-User -Filter 'SKUAssigned -eq $true'`.| +|_SendOofMessageToOriginatorEnabled_|_oOFReplyToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'SendOofMessageToOriginatorEnabled -eq $true'`.| +|_ServerLegacyDN_|_msExchHomeServerName_|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "ServerLegacyDN -like 'Mailbox01'"`.
This is an example of a complete **ServerLegacyDN** value: `/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01`.| +|_ServerName_|n/a|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String or `$null`|For example, `Get-Recipient -Filter "ServerName -eq 'Mailbox01'"`.| +|_SharingPolicy_|_msExchSharingPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the sharing policy. For example, `Get-Mailbox -Filter "SharingPolicy -eq 'CN=Custom Sharing Policy,CN=Federation,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of sharing policies, run this command: `Get-SharingPolicy | Format-List Name,DistinguishedName`.
**Note**: For the default assignment of the default sharing policy (named Default Sharing Policy) to a mailbox, the value of the **SharingPolicy** property is blank (`$null`).| +|_Sid_|_objectSid_|**Get-Group**
**Get-LinkedUser**
**Get-SecurityPrincipal**
**Get-User**|String|For example, `Get-User -Filter "Sid -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"`.| +|_SidHistory_|_SIDHistory_|**Get-Group**
**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter "SidHistory -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"`.| +|_SimpleDisplayName_|_displayNamePrintable_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "SimpleDisplayName -like 'lila*'"`.| +|_SingleItemrecoveryEnabled_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'SingleItemRecoveryEnabled -eq $true'`.| +|_SKUAssigned_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|Boolean (`$true` or `$false`) or `$null`.|For example, `Get-User -Filter 'SKUAssigned -eq $true'`.| |_SourceAnchor_|n/a|**Get-Mailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter 'SourceAnchor -ne $null'`.| -|_StateOrProvince_|_st_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "StateOrProvince -like 'Carolina*'"`.| -|_StreetAddress_|_streetAddress_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "StreetAddress -like '36th Ave NE*'"`.| -|_StsRefreshTokensValidFrom_|_msExchStsRefreshTokensValidFrom_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-User -Filter "StsRefreshTokensValidFrom -gt '8/1/2017'"`.| -|_TelephoneAssistant_|_telephoneAssistant_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "TelephoneAssistant -like '206*'"`.| -|_ThrottlingPolicy_|_msExchThrottlingPolicyDN_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the throttling policy. For example, `Get-Mailbox -Filter "ThrottlingPolicy -eq 'CN=Custom Throttling Policy,CN=Global Settings,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of throttling policies, run this command: `Get-ThrottlingPolicy | Format-List Name,DistinguishedName`.| -|_Title_|_title_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Title -eq 'Dr.'"`.| +|_StateOrProvince_|_st_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "StateOrProvince -like 'Carolina*'"`.| +|_StreetAddress_|_streetAddress_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "StreetAddress -like '36th Ave NE*'"`.| +|_StsRefreshTokensValidFrom_|_msExchStsRefreshTokensValidFrom_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-User -Filter "StsRefreshTokensValidFrom -gt '8/1/2017'"`.| +|_TelephoneAssistant_|_telephoneAssistant_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "TelephoneAssistant -like '206*'"`.| +|_ThrottlingPolicy_|_msExchThrottlingPolicyDN_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the throttling policy. For example, `Get-Mailbox -Filter "ThrottlingPolicy -eq 'CN=Custom Throttling Policy,CN=Global Settings,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of throttling policies, run this command: `Get-ThrottlingPolicy | Format-List Name,DistinguishedName`.| +|_Title_|_title_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Title -eq 'Dr.'"`.| |_UMAddresses_|_msExchUMAddresses_|**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-UMMailbox -Filter 'UMAddresses -ne $null'`.| -|_UMCallingLineIds_|_msExchUMCallingLineIds_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "UMCallingLineIds -like '123*'"`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_UMDtmfMap_|_msExchUMDtmfMap_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "UMDtmfMap -like '26297*'"`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_UMEnabled_|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'UMEnabled -eq $true'`.| -|_UMMailboxPolicy_|_msExchUMTemplateLink_|**Get-Recipient**
**Get-UMMailbox**|String or `$null`|This filter requires the distinguished name of the UM mailbox policy. For example, `Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Default Policy,CN=UM Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of UM mailbox policies, run this command: `Get-UMMailboxPolicy | Format-List Name,DistinguishedName`.| -|_UMRecipientDialPlanId_|_msExchUMRecipientDialPlanLink_|**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the UM dial plan. For example, `Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Dial Plan,CN=UM DialPlan Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of UM dial plans, run this command: `Get-UMDialPlan | Format-List Name,DistinguishedName`.| +|_UMCallingLineIds_|_msExchUMCallingLineIds_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "UMCallingLineIds -like '123*'"`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_UMDtmfMap_|_msExchUMDtmfMap_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "UMDtmfMap -like '26297*'"`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| +|_UMEnabled_|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'UMEnabled -eq $true'`.| +|_UMMailboxPolicy_|_msExchUMTemplateLink_|**Get-Recipient**
**Get-UMMailbox**|String or `$null`|This filter requires the distinguished name of the UM mailbox policy. For example, `Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Default Policy,CN=UM Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of UM mailbox policies, run this command: `Get-UMMailboxPolicy | Format-List Name,DistinguishedName`.| +|_UMRecipientDialPlanId_|_msExchUMRecipientDialPlanLink_|**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the UM dial plan. For example, `Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Dial Plan,CN=UM DialPlan Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of UM dial plans, run this command: `Get-UMDialPlan | Format-List Name,DistinguishedName`.| |_UpgradeRequest_|n/a|**Get-User**|`None` (0), `TenantUpgrade` (1), `PrestageUpgrade` (2), `CancelPrestageUpgrade` (3), `PilotUpgrade` (4), or `TenantUpgradeDryRun` (5),|For example, `Get-User -Filter "UpgradeRequest -ne 'None'"`.| |_UpgradeStatus_|n/a|**Get-User**|`None` (0), `NotStarted` (1), `InProgress` (2), `Warning` (3), `Error` (4), `Cancelled` (5), `Complete` (6), or `ForceComplete` (7).|For example, `Get-User -Filter "UpgradeStatus -ne 'None'"`.| -|_UsageLocation_|_msExchUsageLocation_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**|String or `$null`|This filter requires the ISO 3166-1 country name (for example, `United States`), or two-letter country code (for example `US`) for the user in Microsoft 365. For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html).
For example, `Get-Recipient -Filter 'UsageLocation -ne $null'`.| +|_UsageLocation_|_msExchUsageLocation_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**|String or `$null`|This filter requires the ISO 3166-1 country name (for example, `United States`), or two-letter country code (for example `US`) for the user in Microsoft 365. For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html).
For example, `Get-Recipient -Filter 'UsageLocation -ne $null'`.| |_UseDatabaseQuotaDefaults_|_mDBUseDefaults_|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'UseDatabaseQuotaDefaults -eq $false'`.| -|_UserAccountControl_|_userAccountControl_|**Get-LinkedUser**
**Get-User**|`AccountDisabled`, `DoNotExpirePassword`, or `NormalAccount`|For example, `Get-User -Filter "UserAccountControl -eq 'NormalAccount'"`.
You can specify multiple values separated by commas, but the order matters. For example, `Get-User -Filter "UserAccountControl -eq 'AccountDisabled,NormalAccount'"` returns different results than `Get-User -Filter "UserAccountControl -eq 'NormalAccount,AccountDisabled'"`.
This multivalued property will only return a match if the property *equals* the specified value.| -|_UserPrincipalName_|_userPrincipalName_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted)|For example, `Get-User -Filter "UserPrincipalName -like 'julia@*'"`.| -|_VoiceMailSettings_|_msExchUCVoiceMailSettings_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter 'VoiceMailSettings -ne $null'`.| -|_WebPage_|_wWWHomePage_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "WebPage -like 'https://intranet.contoso.com/*'"`.| -|_WhenChanged_|_WhenChanged_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenChanged -gt '8/1/2017 2:00:00 PM'"`.| -|_WhenChangedUTC_|n/a|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenChangedUTC -gt '8/1/2017 2:00:00 PM'"`.| -|_WhenCreated_|_whenCreated_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenCreated -gt '8/1/2017 2:00:00 PM'"`.| -|_WhenCreatedUTC_|n/a|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenCreatedUTC -gt '8/1/2017 2:00:00 PM'"`.| -|_WhenMailboxCreated_|_msExchWhenMailboxCreated_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenMailboxCreated -gt '8/1/2017 2:00:00 PM'"`.| -|_WhenSoftDeleted_|_msExchWhenSoftDeletedTime_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|This filter requires the _SoftDeleted_ switch in the command for mailboxes.
For example, `Get-Mailbox -SoftDeleted -Filter "WhenSoftDeleted -gt '8/1/2017 2:00:00 PM'"`.| -|_WindowsEmailAddress_|_mail_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.com*'"`.| -|_WindowsLiveID_|_msExchWindowsLiveID_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.onmicrosoft.com*'"`.| +|_UserAccountControl_|_userAccountControl_|**Get-LinkedUser**
**Get-User**|`AccountDisabled`, `DoNotExpirePassword`, or `NormalAccount`|For example, `Get-User -Filter "UserAccountControl -eq 'NormalAccount'"`.
You can specify multiple values separated by commas, but the order matters. For example, `Get-User -Filter "UserAccountControl -eq 'AccountDisabled,NormalAccount'"` returns different results than `Get-User -Filter "UserAccountControl -eq 'NormalAccount,AccountDisabled'"`.
This multivalued property will only return a match if the property *equals* the specified value.| +|_UserPrincipalName_|_userPrincipalName_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted)|For example, `Get-User -Filter "UserPrincipalName -like 'julia@*'"`.| +|_VoiceMailSettings_|_msExchUCVoiceMailSettings_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter 'VoiceMailSettings -ne $null'`.| +|_WebPage_|_wWWHomePage_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "WebPage -like 'https://intranet.contoso.com/*'"`.| +|_WhenChanged_|_WhenChanged_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenChanged -gt '8/1/2017 2:00:00 PM'"`.| +|_WhenChangedUTC_|n/a|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenChangedUTC -gt '8/1/2017 2:00:00 PM'"`.| +|_WhenCreated_|_whenCreated_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenCreated -gt '8/1/2017 2:00:00 PM'"`.| +|_WhenCreatedUTC_|n/a|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenCreatedUTC -gt '8/1/2017 2:00:00 PM'"`.| +|_WhenMailboxCreated_|_msExchWhenMailboxCreated_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenMailboxCreated -gt '8/1/2017 2:00:00 PM'"`.| +|_WhenSoftDeleted_|_msExchWhenSoftDeletedTime_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|This filter requires the _SoftDeleted_ switch in the command for mailboxes.
For example, `Get-Mailbox -SoftDeleted -Filter "WhenSoftDeleted -gt '8/1/2017 2:00:00 PM'"`.| +|_WindowsEmailAddress_|_mail_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.com*'"`.| +|_WindowsLiveID_|_msExchWindowsLiveID_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.onmicrosoft.com*'"`.| | ## For more information diff --git a/exchange/docs-conceptual/filters-v2.md b/exchange/docs-conceptual/filters-v2.md index 94a294b3e0..304ac7ff04 100644 --- a/exchange/docs-conceptual/filters-v2.md +++ b/exchange/docs-conceptual/filters-v2.md @@ -20,7 +20,7 @@ description: "Learn about how to use filtering for cmdlets in the Exchange Onlin The Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module) contains a few exclusive cmdlets that are optimized for high speed, high volume operations, and (after you connect to your organization) gives you access to the hundreds of existing cmdlets in the service. For more information, see [About the Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). -In order to get the most out of the EXO V2 module, you need to follow the guidance in this topic. +In order to get the most out of the EXO V2 module, you need to follow the guidance in this article. ## Use client-side filtering for the best performance @@ -36,9 +36,9 @@ Although the EXO V2 module supports the majority of filterable attributes, the f |Cmdlet|Attribute|LDAP Display Name| |---|---|---| -|[Get-CASMailbox](https://docs.microsoft.com/powershell/module/exchange/get-casmailbox)|MemberOfGroup

ExternalDirectoryObjectId|memberOf

msExchExternalDirectoryObjectId| -|[Get-Mailbox](https://docs.microsoft.com/powershell/module/exchange/get-mailbox)|DeletedItemFlags

ExternalDirectoryObjectId

LanguagesRaw

MasterAccountSid

MemberOfGroup

RequireAllSendersAreAuthenticated

SCLDeleteThresholdInt

SCLJunkThresholdInt

SCLQuarantineThresholdInt

SCLRejectThresholdInt|deletedItemFlags

msExchExternalDirectoryObjectId

msExchUserCulture

msExchMasterAccountSid

memberOf

msExchRequireAuthToSendTo

msExchMessageHygieneSCLDeleteThreshold

msExchMessageHygieneSCLJunkThreshold

msExchMessageHygieneSCLQuarantineThreshold

msExchMessageHygieneSCLRejectThreshold| -|[Get-Recipient](https://docs.microsoft.com/powershell/module/exchange/get-recipient)|CountryCode

ExternalDirectoryObjectId

MasterAccountSid

MemberOfGroup

Members|countryCode

msExchExternalDirectoryObjectId

msExchMasterAccountSid

memberOf

member| +|[Get-CASMailbox](https://docs.microsoft.com/powershell/module/exchange/get-casmailbox)|MemberOfGroup

ExternalDirectoryObjectId|memberOf

msExchExternalDirectoryObjectId| +|[Get-Mailbox](https://docs.microsoft.com/powershell/module/exchange/get-mailbox)|DeletedItemFlags

ExternalDirectoryObjectId

LanguagesRaw

MasterAccountSid

MemberOfGroup

RequireAllSendersAreAuthenticated

SCLDeleteThresholdInt

SCLJunkThresholdInt

SCLQuarantineThresholdInt

SCLRejectThresholdInt|deletedItemFlags

msExchExternalDirectoryObjectId

msExchUserCulture

msExchMasterAccountSid

memberOf

msExchRequireAuthToSendTo

msExchMessageHygieneSCLDeleteThreshold

msExchMessageHygieneSCLJunkThreshold

msExchMessageHygieneSCLQuarantineThreshold

msExchMessageHygieneSCLRejectThreshold| +|[Get-Recipient](https://docs.microsoft.com/powershell/module/exchange/get-recipient)|CountryCode

ExternalDirectoryObjectId

MasterAccountSid

MemberOfGroup

Members|countryCode

msExchExternalDirectoryObjectId

msExchMasterAccountSid

memberOf

member| | ## Supported and unsupported operators @@ -46,13 +46,11 @@ Although the EXO V2 module supports the majority of filterable attributes, the f The following operators are fully supported for all string formats in the EXO V2 module: - [Logical operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_logical_operators): - - `-and` - `-not` - `-or` - [Comparison operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators) - - `-eq` - `-ne` - `-lt` diff --git a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md index 26a2dc95dd..5f324e2f92 100644 --- a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md +++ b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md @@ -20,31 +20,31 @@ You can use PowerShell to find the permissions required to run any Exchange or E - Estimated time to complete this procedure: less than 5 minutes. -- You can only use PowerShell to perform this procedure. +- You can only use PowerShell to perform these procedures. -- Basically, you need to be an administrator to complete this procedure. Specifically, you need access to the **Get-ManagementRole** and **Get-ManagementRoleAssignment** cmdlets. By default, access to these cmdlets is granted by the **View-Only Configuration** or **Role Management** roles, which are typically assigned to the **View-Only Organization Management** and **Organization Management** role groups. +- Basically, you need to be an administrator to complete this procedure. Specifically, you need access to the **Get-ManagementRole** and **Get-ManagementRoleAssignment** cmdlets. By default, access to these cmdlets is granted by the **View-Only Configuration** or **Role Management** roles, which are only assigned to the **View-Only Organization Management** and **Organization Management** role groups by default. -- The procedures in this topic don't work in Security & Compliance Center PowerShell. For more information about permissions in the Security & Compliance Center, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - -- The procedures in this topic don't work in standalone Exchange Online Protection (EOP) PowerShell (Microsoft 365 organizations without Exchange Online mailboxes). For more information about permissions in standalone EOP, see [Feature permissions in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/feature-permissions-in-eop). +- The procedures in this article don't work in Security & Compliance Center PowerShell or standalone Exchange Online Protection (EOP) PowerShell (Microsoft 365 organizations without Exchange Online mailboxes). For more information about permissions in these environments, see the following articles: + - [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). + - [Permissions in standalone EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/feature-permissions-in-eop). > [!TIP] > Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) or [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542). ## Use PowerShell to find the permissions required to run a cmdlet -1. Open the PowerShell environment where you want to run the cmdlet. - +1. If you haven't already, open the Exchange PowerShell environment that you're interested in: - **Exchange Online**: [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). - - **Exchange Server**: [Open the Exchange Management Shell](open-the-exchange-management-shell.md) or [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). -2. Run the following command to identify the cmdlet and, optionally, one or more parameters on the cmdlet. Be sure to replace `` and optionally, `,,...` with the actual cmdlet and parameter names you are interested in. If you specify multiple parameters separated by commas, only the roles that include **all** of the parameters are returned. +2. Replace `` and optionally, `,,...` with the values that you want to use, and run the following command: ```powershell $Perms = Get-ManagementRole -Cmdlet [-CmdletParameters ,,...] ``` + **Note**: If you specify multiple parameters, only roles that include the cmdlet with **all** of the parameters are returned. + 3. Run the following command: ```powershell @@ -57,7 +57,9 @@ The results contain the following information: - **Role**: Indicates the role that gives access to the cmdlet or the combination of cmdlet and parameters. Note that role names that begin with "My" are user roles that allow regular users to operate on objects they own (for example, their own mailbox or their distribution groups). -- **RoleAssigneeType** and **RoleAssigneeName**: These values are inter-related. **RoleAssigneeType** is the type of object that has the role assigned to it, and **RoleAssigneeName** is the name of the object. **RoleAssigneeType** can be a role group, role assignment policy, security group, or user. Typically, administrator roles are assigned to role groups. +- **RoleAssigneeType** and **RoleAssigneeName**: These values are inter-related: + - **RoleAssigneeType** is the type of object that has the role assigned to it. For administrator roles, this value is typically a role group, but it can also be a role assignment policy, a security group, or a user. + - **RoleAssigneeName** is the name of the role group, role assignment policy, security group, or user. ## Troubleshooting @@ -65,70 +67,85 @@ What if there are no results? - Verify that you entered the cmdlet and parameter names correctly. -- You might have entered too many parameters, and all of the parameters on the cmdlet aren't defined in a single role. Try specifying only the cmdlet name in Step 2, and run Step 3 to verify that the cmdlet is available in your environment. Then, add parameters one at a time to Step 2 before running Step 3. +- The parameters that you specified are actually available for a cmdlet in a single role. Try specifying only the cmdlet name in the first command before you run the second command. Then, add the parameters one at a time to the first command before you run the second command. -- These possible causes have the same solution: +Otherwise, no results are likely caused by one of the following conditions: - - You might have entered a cmdlet or parameters that are defined in a role that isn't assigned to anyone by default. +- The cmdlet or parameters are defined in a role that isn't assigned to any role groups by default. +- The cmdlet or parameters aren't available in your environment. For example, you specified an Exchange Online cmdlet or Exchange Online parameters in an on-premises Exchange environment. - - You might have entered a cmdlet or parameter that isn't available in your environment. For example, when you enter an Exchange Online cmdlet or parameters in an on-premises Exchange 2016 environment. +To find the roles in your environment (if any) that contain the cmdlet or parameters, replace `` and optionally, `,,...` with the values that you want to use and run the following command: - Run the following command to find the role that contains the cmdlet or parameters. Be sure to replace `` and optionally, `,,...` with the actual cmdlet and parameter names you are interested in. Note that you can use wildcard characters (*) in the cmdlet and parameter names (for example, `*-Mailbox*`). +```powershell +Get-ManagementRoleEntry -Identity *\ [-Parameters ,,...] +``` - ```powershell - Get-ManagementRoleEntry -Identity *\ [-Parameters ,,... ] - ``` +**Note**: You can use wildcard characters (*) in the cmdlet and parameter names (for example, `*-Mailbox*`). - - If the command returns an error saying the object couldn't be found, the cmdlet or parameters aren't available in your environment. +If the command returns an error saying the object couldn't be found, the cmdlet or parameters aren't available in your environment. - - If the command returns one or more entries for **Name**, **Role**, and **Parameters**, the cmdlet (or parameters on the cmdlet) is available in your environment, but the required role isn't assigned to anyone. To see all roles that aren't assigned to anyone, run the following command: +If the command returns results, the cmdlet or parameters are available in your environment, but the required role isn't assigned to any role groups. To find roles that aren't assigned to any role groups, run the following command: - ```powershell - $na = Get-ManagementRole ; $na | foreach {If ((Get-ManagementRoleAssignment -Role $_.Name -Delegating $false) -eq $null) {$_.Name}} - ``` +```powershell +$na = Get-ManagementRole; $na | foreach {If ((Get-ManagementRoleAssignment -Role $_.Name -Delegating $false) -eq $null) {$_.Name}} +``` ## Related procedures -- Management role scopes define where cmdlets can operate (in particular, write scopes). +### Include management role scopes + +Management role scopes (in particular, write scopes) define where cmdlets can operate. For example, the entire organization or only on specific user objects. + +To include scope information in the [Use PowerShell to find the permissions required to run a cmdlet](#use-powershell-to-find-the-permissions-required-to-run-a-cmdlet) output, add `*Scope*` to the second command: + +```powershell +$Perms | foreach {Get-ManagementRoleAssignment -Role $_.Name -Delegating $false | Format-List Role,RoleAssigneeType,RoleAssigneeName,*Scope*} +``` + +For detailed information about management role scopes, see [Understanding management role scopes](https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). + +### Find all roles assigned to a specific user + +To see all roles that are assigned to a specific user, replace `` with the name, alias, or email address of the user and run the following command: + +```powershell +Get-ManagementRoleAssignment -RoleAssignee -Delegating $false | Format-Table -Auto Role,RoleAssigneeName,RoleAssigneeType +``` - To include scope information in Step 2, substitute the following command: +For example: - ```powershell - $Perms | foreach {Get-ManagementRoleAssignment -Role $_.Name -Delegating $false | Format-List Role,RoleAssigneeType,RoleAssigneeName,*Scope*} - ``` +```powershell +Get-ManagementRoleAssignment -RoleAssignee julia@contoso.com -Delegating $false | Format-Table -Auto Role,RoleAssigneeName,RoleAssigneeType +``` -- To see all roles assigned to a specific user, run the following command: +**Note**: The _RoleAssignee_ parameter returns both direct role assignments to users (uncommon) and indirect role assignments granted to the user through their membership in role groups. - ```powershell - Get-ManagementRoleAssignment -RoleAssignee -Delegating $false | Format-Table -Auto Role,RoleAssigneeName,RoleAssigneeType - ``` +### Find all users who have a specific role assigned - For example: +To see all users who have a specific role assigned to them, replace `` with the name of the role and run the following command: - ```powershell - Get-ManagementRoleAssignment -RoleAssignee julia@contoso.com -Delegating $false | Format-Table -Auto Role,RoleAssigneeName,RoleAssigneeType - ``` +```powershell +Get-ManagementRoleAssignment -Role "" -GetEffectiveUsers -Delegating $false | Where-Object {$_.EffectiveUserName -ne "All Group Members"} | Format-Table -Auto EffectiveUserName,Role,RoleAssigneeName,AssignmentMethod +``` -- To see all users who are assigned a specific role, run the following command: +For example: - ```powershell - Get-ManagementRoleAssignment -Role "" -GetEffectiveUsers -Delegating $false | Where-Object {$_.EffectiveUserName -ne "All Group Members"} | Format-Table -Auto EffectiveUserName,Role,RoleAssigneeName,AssignmentMethod - ``` +```powershell +Get-ManagementRoleAssignment -Role "Mailbox Import Export" -GetEffectiveUsers -Delegating $false | Where-Object {$_.EffectiveUserName -ne "All Group Members"} | Format-Table -Auto EffectiveUserName,Role,RoleAssigneeName,AssignmentMethod +``` - For example: +### Find the members of a role group - ```powershell - Get-ManagementRoleAssignment -Role "Mailbox Import Export" -GetEffectiveUsers -Delegating $false | Where-Object {$_.EffectiveUserName -ne "All Group Members"} | Format-Table -Auto EffectiveUserName,Role,RoleAssigneeName,AssignmentMethod - ``` +To see the members of a specific role group, replace `` with the name of the role group and run the following command: -- To see the members of a specific role group, run the following command: +```powershell +Get-RoleGroupMember "" +``` - ```powershell - Get-RoleGroupMember "" - ``` +For example: - For example: +```powershell +Get-RoleGroupMember "Organization Management" +``` - ```powershell - Get-RoleGroupMember "Organization Management" - ``` +**Note**: To see the names of all available role groups, run `Get-RoleGroup`. diff --git a/exchange/docs-conceptual/media/app-only-auth-role-assignment.png b/exchange/docs-conceptual/media/app-only-auth-role-assignment.png index db6f44f177..e621133963 100644 Binary files a/exchange/docs-conceptual/media/app-only-auth-role-assignment.png and b/exchange/docs-conceptual/media/app-only-auth-role-assignment.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-granted.png b/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-granted.png new file mode 100644 index 0000000000..556726052f Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-granted.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role.png b/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role.png new file mode 100644 index 0000000000..5e05c99150 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-app-registration-page.png b/exchange/docs-conceptual/media/exo-app-only-auth-app-registration-page.png new file mode 100644 index 0000000000..c43cf46b86 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-app-registration-page.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-certificate-successfully-added.png b/exchange/docs-conceptual/media/exo-app-only-auth-certificate-successfully-added.png new file mode 100644 index 0000000000..27c2e1e65d Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-certificate-successfully-added.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-find-add-select-app-for-assignment.PNG b/exchange/docs-conceptual/media/exo-app-only-auth-find-add-select-app-for-assignment.PNG new file mode 100644 index 0000000000..09b7bcb514 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-find-add-select-app-for-assignment.PNG differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role.png b/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role.png new file mode 100644 index 0000000000..2b4aa3aaf5 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-manage-ad-view.png b/exchange/docs-conceptual/media/exo-app-only-auth-manage-ad-view.png new file mode 100644 index 0000000000..5ab47205b9 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-manage-ad-view.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-new-app-registration.png b/exchange/docs-conceptual/media/exo-app-only-auth-new-app-registration.png new file mode 100644 index 0000000000..dc4154af4a Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-new-app-registration.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-original-permissions.png b/exchange/docs-conceptual/media/exo-app-only-auth-original-permissions.png new file mode 100644 index 0000000000..e1ff41c91a Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-original-permissions.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-register-app.png b/exchange/docs-conceptual/media/exo-app-only-auth-register-app.png new file mode 100644 index 0000000000..36de7d3689 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-register-app.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments.png b/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments.png new file mode 100644 index 0000000000..64f2025b8f Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-role-description-page-click-assignments.PNG b/exchange/docs-conceptual/media/exo-app-only-auth-role-description-page-click-assignments.PNG new file mode 100644 index 0000000000..4f7e9e97ab Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-role-description-page-click-assignments.PNG differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-api-permissions.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-api-permissions.png new file mode 100644 index 0000000000..da6ca1af65 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-select-api-permissions.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-app-registrations.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-app-registrations.png new file mode 100644 index 0000000000..3b3c884eef Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-select-app-registrations.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-certificates-and-secrets.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-certificates-and-secrets.png new file mode 100644 index 0000000000..1c5f46f150 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-select-certificates-and-secrets.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-manifest.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-manifest.png new file mode 100644 index 0000000000..ee56a245a7 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-select-manifest.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-roles-and-administrators.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-roles-and-administrators.png new file mode 100644 index 0000000000..26eca627fa Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-select-roles-and-administrators.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-upload-certificate.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-upload-certificate.png new file mode 100644 index 0000000000..bf40ab47a3 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-select-upload-certificate.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-upload-certificate-dialog.png b/exchange/docs-conceptual/media/exo-app-only-auth-upload-certificate-dialog.png new file mode 100644 index 0000000000..77ef07a65a Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-upload-certificate-dialog.png differ diff --git a/exchange/docs-conceptual/open-the-exchange-management-shell.md b/exchange/docs-conceptual/open-the-exchange-management-shell.md index 12b33e2c2f..fdd5ab5c3b 100644 --- a/exchange/docs-conceptual/open-the-exchange-management-shell.md +++ b/exchange/docs-conceptual/open-the-exchange-management-shell.md @@ -24,7 +24,9 @@ When you open the Exchange Management Shell you can perform administrative tasks - Estimated time to complete this procedure: less than 1 minute. -- The user must be assigned at least one management role. For detailed steps, see [Exchange Server permissions](https://docs.microsoft.com/Exchange/permissions/permissions). +- To do the procedures in this article, you need to be assigned at least one management role (typically, via membership in a role group). After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). + + For more information, see [Exchange Server permissions](https://docs.microsoft.com/exchange/permissions/permissions). - If you want to run the Exchange Management Shell from a local installation of the Exchange management tools, you need to consider remote PowerShell access for your user account. By default, users are allowed to use remote PowerShell to connect to an Exchange server. However, you can block remote PowerShell access for a user account. For more information, see [Control remote PowerShell access to Exchange servers](control-remote-powershell-access-to-exchange-servers.md). @@ -44,7 +46,7 @@ When you open the Exchange Management Shell you can perform administrative tasks ```dos exshell.psc1 & exchange.ps1 ``` - + ## Open the Exchange Management Shell in Windows Server 2016 or Windows 10 Click **Start** > **Microsoft Exchange Server 2016 \>** **Exchange Management Shell**. diff --git a/exchange/docs-conceptual/recipient-filters.md b/exchange/docs-conceptual/recipient-filters.md index d0ee77cb9d..fded4ed12c 100644 --- a/exchange/docs-conceptual/recipient-filters.md +++ b/exchange/docs-conceptual/recipient-filters.md @@ -197,7 +197,7 @@ When creating your own custom OPath filters, consider the following items: **** - |Search value|OPath filter
enclosed in
double quotation marks|OPath filter
enclosed in
single quotation marks|OPath filter enclosed in
braces| + |Search value|OPath filter
enclosed in
double quotation marks|OPath filter
enclosed in
single quotation marks|OPath filter enclosed in
braces| |---|:---:|:---:|:---:| |`'Text'`|![Check mark](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)||![Check mark](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)| |`"Text"`|||![Check mark](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)| @@ -221,7 +221,9 @@ When creating your own custom OPath filters, consider the following items: - `-like` (string comparison) - `-notlike` (string comparison) -- Many filterable properties accept wildcard characters. If you use a wildcard character, use the **-like** operator instead of the **-eq** operator. The **-like** operator is used to find pattern matches in rich types (for example, strings) whereas the **-eq** operator is used to find an exact match. +- Many filterable properties accept wildcard characters. If you use a wildcard character, use the **-like** operator instead of the **-eq** operator. Use the **-like** operator to find pattern matches in rich types (for example, strings). Use the **-eq** operator to find an exact match. + + When you use the **-like** operator in Exchange Online PowerShell, the wildcard character is supported only as a suffix. For example, `"Department -like 'sales*'"` is allowed; `"Department -like '*sales'"` is not allowed. - For more information about operators you can use, see: @@ -230,11 +232,11 @@ When creating your own custom OPath filters, consider the following items: ## Recipient filter documentation -The following table contains links to topics that will help you learn more about the filterable properties that you can use with Exchange recipient commands. +The following table contains links to articles that will help you learn more about the filterable properties that you can use with Exchange recipient commands. **** -|Topic|Description| +|Article|Description| |---|---| |[Filterable properties for the RecipientFilter parameter on Exchange cmdlets](recipientfilter-properties.md)|Learn more about the filterable properties that are available for the _RecipientFilter_ parameter.| |[Filterable properties for the Filter parameter on Exchange cmdlets](filter-properties.md) |Learn more about the filterable properties that are available for the _Filter_ parameter.| diff --git a/exchange/docs-conceptual/recipientfilter-properties.md b/exchange/docs-conceptual/recipientfilter-properties.md index ea9abe629d..457f487b4a 100644 --- a/exchange/docs-conceptual/recipientfilter-properties.md +++ b/exchange/docs-conceptual/recipientfilter-properties.md @@ -28,7 +28,6 @@ The recipient properties that have been *confirmed* to work with the _RecipientF **Notes**: - The list might include: - - Properties that are only used in one type of environment: Microsoft 365, on-premises Exchange, or hybrid. The property might exist on recipient objects in all environments, but the value is only meaningful (a value other than blank or `None`) in one type of environment. - Properties that are present, but correspond to features that are no longer used in Exchange. @@ -40,7 +39,7 @@ The recipient properties that have been *confirmed* to work with the _RecipientF - You typically use the object's name for properties that require a valid object value (for example, a mailbox, a distribution group, or an email address policy, but the property might also accept the object's distinguished name (DN) or globally unique identifier (GUID). To find the object's DN or GUID, use the **Get-** cmdlet that corresponds to the object's type (for example, `Get-EmailAddressPolicy | Format-List Name,DistinguishedName,GUID`). -- Text string properties that accept wildcard characters require the `-like` operator (for example, `"Property -like 'abc*'"`). +- Text string properties that accept wildcard characters require the `-like` operator (for example, `"Property -like 'abc*'"`). In Exchange Online PowerShell, you can't use the wildcard as a prefix (for example, `"Property -like '*abc'"`) is not allowed). - The Value column in the table describes the acceptable values for the *filter*, not necessarily for the property itself. For example, a property might obviously contain a date or numeric value, but when you use that property in a filter, it might be treated like a text string (no value check, and wildcards are supported). @@ -52,8 +51,8 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |Property name|LDAP display name|Value|Comments| |---|---|---|---| -|_AcceptMessagesOnlyFrom_|_authOrig_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| -|_AcceptMessagesOnlyFromDLMembers_|_dLMemSubmitPerms_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| +|_AcceptMessagesOnlyFrom_|_authOrig_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| +|_AcceptMessagesOnlyFromDLMembers_|_dLMemSubmitPerms_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| |_ActiveSyncAllowedDeviceIDs_|_msExchMobileAllowedDeviceIds_|String (wildcards accepted).|| |_ActiveSyncBlockedDeviceIDs_|_msExchMobileBlockedDeviceIds_|String (wildcards accepted).|| |_ActiveSyncEnabled_|n/a|Boolean (`$true` or `$false`)|| @@ -71,17 +70,17 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_ArchiveDomain_|_msExchArchiveAddress_|String (wildcards accepted).|| |_ArchiveGuid_|_msExchArchiveGUID_|String (wildcards accepted).|| |_ArchiveName_|_msExchArchiveName_|String (wildcards accepted).|| -|_ArchiveQuota_|_msExchArchiveQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| -|_ArchiveWarningQuota_|_msExchArchiveWarnQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_ArchiveQuota_|_msExchArchiveQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_ArchiveWarningQuota_|_msExchArchiveWarnQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| |_ArchiveRelease_|_msExchArchiveRelease_|String (wildcards accepted).|| |_ArchiveState_|n/a|`None` (0), `Local` (1), `HostedProvisioned` (2), `HostedPending` (3), or `OnPremise` (4).|| |_ArchiveStatus_|_msExchArchiveStatus_|`None` (0) or `Active` (1).|| |_AssistantName_|_msExchAssistantName_|String (wildcards accepted).|The name of the recipient's assistant.| |_AuditEnabled_|_msExchMailboxAuditEnable_|Boolean (`$true` or `$false`)|| -|_AuditLogAgeLimit_|_msExchMailboxAuditLogAgeLimit_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|The value of this property is a time span: `dd.hh:mm:ss` where `dd` = days, `hh` = hours, `mm` = minutes, and `ss` = seconds.| +|_AuditLogAgeLimit_|_msExchMailboxAuditLogAgeLimit_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|The value of this property is a time span: `dd.hh:mm:ss` where `dd` = days, `hh` = hours, `mm` = minutes, and `ss` = seconds.| |_AuthenticationPolicy_|_msExchAuthPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| |_C_|_C_|String (wildcards accepted).|This property contains the two-letter country/region designation from International Organization for Standardization (ISO) 3166. For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html).| -|_CalendarLoggingQuota_|_msExchCalendarLoggingQuota_|Dynamic distribution groups: `Unlimited` or a byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: `Unlimited`, or blank/non-blank.|| +|_CalendarLoggingQuota_|_msExchCalendarLoggingQuota_|Dynamic distribution groups: `Unlimited` or a byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: `Unlimited`, or blank/non-blank.|| |_CalendarRepairDisabled_|_msExchCalendarRepairDisabled_|Boolean (`$true` or `$false`)|| |_Certificate_|_userCertificate_|`System.Byte[]`|This property contains the DER-encoded X509v3 certificates that are issued to the user.| |_CertificateSubject_|n/a|`X509:X500IssuerX500Subject` (for example, `X509:C=US,O=InternetCA,CN=APublicCertificateAuthorityC=US,O=Fabrikam,OU=Sales,CN=Jeff Smith`)|The X509 certificate that's published for the user account (visible on the **Published Certificates** tab in Active Directory Users and Computers).| @@ -105,8 +104,8 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_DisplayName_|_displayName_|String (wildcards accepted).|| |_DistinguishedName_|_distinguishedName_|String (wildcards accepted).|| |_EcpEnabled_|n/a|Boolean (`$true` or `$false`)|| -|_ElcExpirationSuspensionEndDate_|_msExchELCExpirySuspensionEnd_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|This property contains a date-time value.| -|_ElcExpirationSuspensionStartDate_|_msExchELCExpirySuspensionStart_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|This property contains a date-time value.| +|_ElcExpirationSuspensionEndDate_|_msExchELCExpirySuspensionEnd_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|This property contains a date-time value.| +|_ElcExpirationSuspensionStartDate_|_msExchELCExpirySuspensionStart_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|This property contains a date-time value.| |_ElcMailboxFlags_|_msExchELCMailboxFlags_|`None` (0), `ExpirationSuspended` (1), `ElcV2` (2), `DisableCalendarLogging` (4),`LitigationHold` (8), `SingleItemRecovery` (16), `ValidArchiveDatabase` (32), `ShouldUseDefaultRetentionPolicy` (128), `EnableSiteMailboxMessageDedup` (256), `ElcProcessingDisabled` (512), or `ComplianceTagHold` (1024).|| |_EmailAddresses_|_proxyAddresses_|String (wildcards accepted).|This property contains the recipient's email addresses (the primary email address and all proxy addresses).| |_EmailAddressPolicyEnabled_|n/a|Boolean (`$true` or `$false`)|| @@ -115,7 +114,7 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_EwsEnabled_|_msExchEwsEnabled_|Integer|| |_ExchangeGuid_|_msExchMailboxGuid_|String (wildcards accepted).|| |_ExchangeUserAccountControl_|_msExchUserAccountControl_|For valid values, see [ADS_USER_FLAG_ENUM enumeration](https://docs.microsoft.com/windows/win32/api/iads/ne-iads-ads_user_flag_enum). The integer values will work as described. Most of the text values won't work as described (even if you remove `ADS_UF` and all underscores).|| -|_ExchangeVersion_|_msExchVersion_|Dynamic distribution groups: String (wildcards accepted).
Others: `ExchangeObjectVersion` values.|| +|_ExchangeVersion_|_msExchVersion_|Dynamic distribution groups: String (wildcards accepted).
Others: `ExchangeObjectVersion` values.|| |_ExpansionServer_|_msExchExpansionServerName_|String (wildcards accepted).|| |_ExtensionCustomAttribute1_ to _ExtensionCustomAttribute5_|_msExchExtensionCustomAttribute1_ to _msExchExtensionCustomAttribute5_|String (wildcards accepted).|| |_ExternalDirectoryObjectId_|_msExchExternalDirectoryObjectId_|String (wildcards accepted).|| @@ -142,7 +141,7 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_Initials_|_initials_|String (wildcards accepted).|| |_InPlaceHolds_|_msExchUserHoldPolicies_|String|| |_InPlaceHoldsRaw_|n/a|String|| -|_InternetEncoding_|_internetEncoding_|Integer|For valid values, see the Remarks section in the topic, [Encoding Class](https://docs.microsoft.com/dotnet/api/system.text.encoding).| +|_InternetEncoding_|_internetEncoding_|Integer|For valid values, see the Remarks section in the article, [Encoding Class](https://docs.microsoft.com/dotnet/api/system.text.encoding).| |_IsDirSynced_|_msExchIsMSODirsynced_|Boolean (`$true` or `$false`)|| |_IsExcludedFromServingHierarchy_|n/a|Boolean (`$true` or `$false`)|| |_IsHierarchyReady_|n/a|Boolean (`$true` or `$false`)|| @@ -152,14 +151,14 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_IsSecurityPrincipal_|n/a|Boolean (`$true` or `$false`)|| |_IsSoftDeletedByDisable_|n/a|Boolean (`$true` or `$false`)|| |_IsSoftDeletedByRemove_|n/a|Boolean (`$true` or `$false`)|| -|_IssueWarningQuota_|_mDBStorageQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_IssueWarningQuota_|_mDBStorageQuota_|Dynamic distribution groups: A byte quantified size value (for example, `300MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| |_JournalArchiveAddress_|n/a|An SMTP email address (for example, `julia@contoso.com`).|| |_LanguagesRaw_|_msExchUserCulture_|String (wildcards accepted).|This property contains the language preference for this mailbox in the format `-`. For example, United States English is `en-US`. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo).| -|_LastExchangeChangedTime_|_msExchLastExchangeChangedTime_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_LastExchangeChangedTime_|_msExchLastExchangeChangedTime_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| |_LastName_|_sn_|String (wildcards accepted).|| |_LdapRecipientFilter_|_msExchDynamicDLFilter_|String (wildcards accepted).|| |_LegacyExchangeDN_|_legacyExchangeDN_|String (wildcards accepted).|| -|_LitigationHoldDate_|_msExchLitigationHoldDate_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_LitigationHoldDate_|_msExchLitigationHoldDate_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| |_LitigationHoldEnabled_|n/a|Boolean (`$true` or `$false`)|| |_LitigationHoldOwner_|_msExchLitigationHoldOwner_|String (wildcards accepted).|| |_LocaleID_|_localeID_|Integer|For valid values, [Microsoft Locale ID Values](https://docs.microsoft.com/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a).| @@ -178,8 +177,8 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_MapiRecipient_|_mAPIRecipient_|Boolean (`$true` or `$false`)|| |_MaxBlockedSenders_|_msExchMaxBlockedSenders_|`Unlimited` or an integer.|| |_MaxSafeSenders_|_msExchMaxSafeSenders_|`Unlimited` or an integer.|| -|_MaxReceiveSize_|_delivContLength_|Dynamic distribution groups: A byte quantified size value (for example, `50MB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| -|_MaxSendSize_|_submissionContLength_|Dynamic distribution groups: A byte quantified size value (for example, `50MB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_MaxReceiveSize_|_delivContLength_|Dynamic distribution groups: A byte quantified size value (for example, `50MB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_MaxSendSize_|_submissionContLength_|Dynamic distribution groups: A byte quantified size value (for example, `50MB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| |_MemberDepartRestriction_|_msExchGroupDepartRestriction_|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|| |_MemberJoinRestriction_|_msExchGroupDepartRestriction_|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|| |_MemberOfGroup_|_memberOf_|String (wildcards accepted in dynamic distribution groups).|| @@ -194,8 +193,8 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_Name_|_name_|String (wildcards accepted).|The unique name value of the recipient.| |_NetID_|n/a|A sample value is `1003BFFD9A0CFA03`.|This property is populated for Exchange Online mailboxes in hybrid environments.| |_Notes_|_info_|String (wildcards accepted).|| -|_ObjectCategory_|_objectCategory_|Dynamic distribution groups: String (wildcards accepted).
Others: Valid Active Directory `ObjectCategory` values.|Valid values use the format `CN=,CN=Schema,CN=Configuration,DC=`, where _\_ is typically `Person` or `Group` for recipients. For example, `CN=Person,CN=Schema,CN=Configuration,DC=contoso,DC=com`.| -|_ObjectClass_|_objectClass_|Dynamic distribution groups: String (wildcards accepted).
Others: Valid Active Directory `ObjectCategory` values.|Common values for recipients are: `contact`, `organizationalPerson`, `person`, `top`, `group`, `msExchDynamicDistributionList`, and `user`.| +|_ObjectCategory_|_objectCategory_|Dynamic distribution groups: String (wildcards accepted).
Others: Valid Active Directory `ObjectCategory` values.|Valid values use the format `CN=,CN=Schema,CN=Configuration,DC=`, where _\_ is typically `Person` or `Group` for recipients. For example, `CN=Person,CN=Schema,CN=Configuration,DC=contoso,DC=com`.| +|_ObjectClass_|_objectClass_|Dynamic distribution groups: String (wildcards accepted).
Others: Valid Active Directory `ObjectCategory` values.|Common values for recipients are: `contact`, `organizationalPerson`, `person`, `top`, `group`, `msExchDynamicDistributionList`, and `user`.| |_Office_|_physicalDeliveryOfficeName_|String (wildcards accepted).|| |_OfflineAddressBook_|_msExchUseOAB_|String (wildcards accepted in dynamic distribution groups).|This property contains the offline address book (OAB) that's associated with this recipient.| |_OperatorNumber_|_msExchUMOperatorNumber_|String (wildcards accepted).|| @@ -221,8 +220,8 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_PreviousRecipientTypeDetails_|_msExchPreviousRecipientTypeDetails_|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](https://docs.microsoft.com/powershell/module/exchange/get-recipient).|| |_PrimaryGroupId_|_primaryGroupId_|Integer|For domain users, the value of this property is typically 513, which corresponds to the Domain Users group.| |_PrimarySmtpAddress_|n/a|String (wildcards accepted).|Don't use the _PrimarySmtpAddress_ property; use the _EmailAddresses_ property instead. Any filter that uses the _PrimarySmtpAddress_ property will also search values in the _EmailAddresses_ property. For example, if a mailbox has the primary email address dario@contoso.com, and the additional proxy addresses dario2@contoso.com and dario3@contoso.com, all of the following filters will return that mailbox in the result: `"PrimarySmtpAddress -eq 'dario@contoso.com'"`, `"PrimarySmtpAddress -eq 'dario2@contoso.com'"`, or `"PrimarySmtpAddress -eq 'dario3@contoso.com'"`.| -|_ProhibitSendQuota_|_mDBOverQuotaLimit_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| -|_ProhibitSendReceiveQuota_|_mDBOverHardQuotaLimit_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_ProhibitSendQuota_|_mDBOverQuotaLimit_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_ProhibitSendReceiveQuota_|_mDBOverHardQuotaLimit_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| |_ProtocolSettings_|_protocolSettings_|String (wildcards accepted).|| |_PublicFolderContacts_|_pFContacts_|String (wildcards accepted in dynamic distribution groups).|| |_PurportedSearchUI_|_msExchPurportedSearchUI_|String (wildcards accepted).|| @@ -236,10 +235,10 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_RecipientLimits_|_msExchRecipLimit_|`Unlimited` or an integer.|This property specifies the maximum number of recipients that are allowed in messages sent by the mailbox.| |_RecipientType_|n/a|For valid values, see the description of the _RecipientType_ parameter in [Get-Recipient](https://docs.microsoft.com/powershell/module/exchange/get-recipient).|| |_RecipientTypeDetails_|n/a|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](https://docs.microsoft.com/powershell/module/exchange/get-recipient).|| -|_RecoverableItemsQuota_|_msExchDumpsterQuota_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| -|_RecoverableItemsWarningQuota_|_msExchDumpsterWarningQuota_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| -|_RejectMessagesFrom_|_unauthOrig_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| -|_RejectMessagesFromDLMembers_|_dLMemRejectPerms_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| +|_RecoverableItemsQuota_|_msExchDumpsterQuota_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_RecoverableItemsWarningQuota_|_msExchDumpsterWarningQuota_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_RejectMessagesFrom_|_unauthOrig_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| +|_RejectMessagesFromDLMembers_|_dLMemRejectPerms_|Dynamic distribution groups: String (wildcards accepted).
Others: Blank or non-blank.|| |_RemoteAccountPolicy_|_msExchSyncAccountsPolicyDN_|String (wildcards accepted in dynamic distribution groups).|| |_RemotePowerShellEnabled_|n/a|Boolean (`$true` or `$false`)|| |_RemoteRecipientType_|_msExchRemoteRecipientType_|`None` (0), `ProvisionMailbox` (1), `ProvisionArchive` (2), `Migrated` (4), `DeprovisionMailbox` (8), `DeprovisionArchive` (16), `RoomMailbox` (32), `EquipmentMailbox` (64), `SharedMailbox` (96), or `TeamMailbox` (128).|| @@ -252,12 +251,12 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_ResourcePropertiesDisplay_|_msExchResourceDisplay_|String (wildcards accepted).|| |_ResourceSearchProperties_|_msExchResourceSearchProperties_|String (wildcards accepted).|| |_ResourceType_|n/a|`Room` (0) or `Equipment` (1).|| -|_RetainDeletedItemsFor_|_garbageCollPeriod_|Dynamic distribution groups: A time span: `dd.hh:mm:ss` where `dd` = days, `hh` = hours, `mm` = minutes, and `ss` = seconds.
Others: Blank or non-blank.|| +|_RetainDeletedItemsFor_|_garbageCollPeriod_|Dynamic distribution groups: A time span: `dd.hh:mm:ss` where `dd` = days, `hh` = hours, `mm` = minutes, and `ss` = seconds.
Others: Blank or non-blank.|| |_RetentionComment_|_msExchRetentionComment_|String (wildcards accepted).|| |_RetentionPolicy_|n/a|String|| |_RetentionUrl_|_msExchRetentionURL_|String (wildcards accepted).|| |_RoleAssignmentPolicy_|_msExchRBACPolicyLink_|String (wildcards accepted in dynamic distribution groups).|| -|_RulesQuota_|_msExchMDBRulesQuota_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| +|_RulesQuota_|_msExchMDBRulesQuota_|Dynamic distribution groups: A byte quantified size value (for example, `50MB` or `1.5GB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| |_SamAccountName_|_SamAccountName_|String (wildcards accepted in dynamic distribution groups).|This property specifies an identifier that's compatible with older versions of Microsoft Windows client and server operating systems (also known as the pre-Windows 2000 user account or group name)| |_SafeRecipientsHash_|_msExchSafeRecipientsHash_|`System.Byte[]`|A user's safe recipients list is hashed (SHA-256) one way before it's stored as a binary large object in Active Directory.| |_SafeSendersHash_|_msExchSafeSendersHash_|`System.Byte[]`|A user's safe senders list is hashed (SHA-256) one way before it's stored as a binary large object in Active Directory.| @@ -277,7 +276,7 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_SMimeCertificate_|_userSMIMECertificate_|`System.Byte[]`|This property contains the binary encoded S/MIME certificates that are issued to the user.| |_StateOrProvince_|_st_|String (wildcards accepted).|| |_StreetAddress_|_streetAddress_|String (wildcards accepted).|| -|_StsRefreshTokensValidFrom_|_msExchStsRefreshTokensValidFrom_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_StsRefreshTokensValidFrom_|_msExchStsRefreshTokensValidFrom_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| |_TelephoneAssistant_|_telephoneAssistant_|String (wildcards accepted).|| |_TextEncodedORAddress_|_textEncodedORAddress_|String (wildcards accepted).|| |_ThrottlingPolicy_|_msExchThrottlingPolicyDN_|String (wildcards accepted in dynamic distribution groups).|| @@ -299,12 +298,12 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_UserPrincipalName_|_userPrincipalName_|String (wildcards accepted).|This property contains the user principal name (UPN) for this recipient (for example, `kim@contoso.com`).| |_VoiceMailSettings_|_msExchUCVoiceMailSettings_|String (wildcards accepted).|Valid values for this property are: `ExchangeHostedVoiceMail=0`, `ExchangeHostedVoiceMail=1`, `CsHostedVoiceMail=0`, or `CsHostedVoiceMail=1`.| |_WebPage_|_wWWHomePage_|String (wildcards accepted).|| -|_WhenChanged_|_whenChanged_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| -|_WhenChangedUTC_|n/a|Dynamic distribution groups: A date/time value in Coordinated Universal Time (UTC).
Others: Blank or non-blank.|| -|_WhenCreated_|_whenCreated_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| -|_WhenCreatedUTC_|n/a|Dynamic distribution groups: A date/time value in UTC.
Others: Blank or non-blank.|| -|_WhenMailboxCreated_|_msExchWhenMailboxCreated_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| -|_WhenSoftDeleted_|_msExchWhenSoftDeletedTime_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_WhenChanged_|_whenChanged_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_WhenChangedUTC_|n/a|Dynamic distribution groups: A date/time value in Coordinated Universal Time (UTC).
Others: Blank or non-blank.|| +|_WhenCreated_|_whenCreated_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_WhenCreatedUTC_|n/a|Dynamic distribution groups: A date/time value in UTC.
Others: Blank or non-blank.|| +|_WhenMailboxCreated_|_msExchWhenMailboxCreated_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| +|_WhenSoftDeleted_|_msExchWhenSoftDeletedTime_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| |_WindowsEmailAddress_|_mail_|String (wildcards accepted).|| |_WindowsLiveID_|_msExchWindowsLiveID_|String (wildcards accepted).|| | diff --git a/exchange/docs-conceptual/scc-powershell.md b/exchange/docs-conceptual/scc-powershell.md index f3c0c4fcfa..1dbb6c6225 100644 --- a/exchange/docs-conceptual/scc-powershell.md +++ b/exchange/docs-conceptual/scc-powershell.md @@ -15,12 +15,12 @@ description: "Learn about using Security & Compliance Center PowerShell." # Security & Compliance Center PowerShell -Security & Compliance Center PowerShell is the administrative interface that enables you to manage the features that are available in the Security & Compliance Center from the command line. For example, you can use Security & Compliance Center PowerShell to perform Compliance Searches and configure access to the Security & Compliance Center. The following topics provide information about using Security & Compliance Center PowerShell: +Security & Compliance Center PowerShell is the administrative interface that enables you to manage the features that are available in the Security & Compliance Center from the command line. For example, you can use Security & Compliance Center PowerShell to perform Compliance Searches and configure access to the Security & Compliance Center. The following articles provide information about using Security & Compliance Center PowerShell: - To create a remote PowerShell session that supports both modern authentication and multi-factor authentication (MFA), see [Connect to Security & Compliance Center PowerShell](connect-to-scc-powershell.md). Note that the connection instructions are different from Exchange Online PowerShell or standalone Exchange Online Protection (EOP) PowerShell (the _ConnectionUri_ value is different). -- To learn about the structure and layout of the cmdlet reference topics in Security & Compliance Center PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). +- To learn about the structure and layout of the cmdlet reference articles in Security & Compliance Center PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). Many of the cmdlets that are available in Security & Compliance Center PowerShell correspond to features that are only available in the Security & Compliance Center, so the related cmdlets are exclusive to Security & Compliance Center PowerShell. But, some cmdlets that are available in Security & Compliance Center PowerShell have the same names and functionality as those in Exchange Online PowerShell (for example, [Get-User](https://docs.microsoft.com/powershell/module/exchange/get-user)). -Also, some features that are available in the Security & Compliance Center (for example, [anti-spam and anti-malware](https://docs.microsoft.com/microsoft-365/security/office-365-security/anti-spam-and-anti-malware-protection) cmdlets are only available in [Exchange Online PowerShell](exchange-online-powershell.md)). Check the **Applies to** value in the cmdlet reference topic to verify where the cmdlet actually resides. +Also, some features that are available in the Security & Compliance Center (for example, [anti-spam and anti-malware](https://docs.microsoft.com/microsoft-365/security/office-365-security/anti-spam-and-anti-malware-protection) cmdlets are only available in [Exchange Online PowerShell](exchange-online-powershell.md)). Check the **Applies to** value in the cmdlet reference article to verify where the cmdlet actually resides. diff --git a/exchange/docs-conceptual/toc.yml b/exchange/docs-conceptual/toc.yml index a0edf38ad8..fed35046d8 100644 --- a/exchange/docs-conceptual/toc.yml +++ b/exchange/docs-conceptual/toc.yml @@ -23,6 +23,8 @@ href: filter-properties.md - name: Filterable properties for the RecipientFilter parameter href: recipientfilter-properties.md + - name: Values for the CustomPropertyNames parameter + href: values-for-custompropertynames-parameter.md - name: Exchange Online PowerShell href: exchange-online-powershell.md items: diff --git a/exchange/docs-conceptual/use-update-exchangehelp.md b/exchange/docs-conceptual/use-update-exchangehelp.md index 824dd73ace..303da7aca8 100644 --- a/exchange/docs-conceptual/use-update-exchangehelp.md +++ b/exchange/docs-conceptual/use-update-exchangehelp.md @@ -1,5 +1,5 @@ --- -title: "Use Update-ExchangeHelp to update Exchange PowerShell help topics on Exchange servers" +title: "Use Update-ExchangeHelp to update Exchange PowerShell help articles on Exchange servers" ms.author: chrisda author: chrisda manager: dansimp @@ -9,12 +9,12 @@ ms.topic: article ms.service: exchange-powershell localization_priority: Normal ms.assetid: 219f78a3-f0e5-4dc6-9787-9a0b9756ee09 -description: "Administrators can learn how to use Update-ExchangeHelp to update Exchange cmdlet reference topics that are available in Exchange Management Shell in Exchange 2016" +description: "Administrators can learn how to use Update-ExchangeHelp to update Exchange cmdlet reference articles that are available in Exchange Management Shell in Exchange 2016" --- -# Use Update-ExchangeHelp to update Exchange PowerShell help topics on Exchange servers +# Use Update-ExchangeHelp to update Exchange PowerShell help articles on Exchange servers -Exchange cmdlet reference topics are created and updated all the time, but it's been difficult to get those updates into Exchange code in a timely manner so they're available in the Exchange Management Shell. Now, you can use the **Update-ExchangeHelp** cmdlet in the Exchange Management Shell to get the most up-to-date cmdlet reference topics for the command line in Exchange 2013 or later. +Exchange cmdlet reference articles are created and updated all the time, but it's been difficult to get those updates into Exchange code in a timely manner so they're available in the Exchange Management Shell. Now, you can use the **Update-ExchangeHelp** cmdlet in the Exchange Management Shell to get the most up-to-date cmdlet reference articles for the command line in Exchange 2013 or later. The **Update-ExchangeHelp** cmdlet automatically connects to a predefined website, compares the version of the local Exchange server and the installed languages to what's available in the update packages, and then downloads and installed the updated Exchange Management Shell help. Typically, the cmdlet connects to the internet, but you can configure it to connect to an intranet source inside your organization. @@ -26,7 +26,7 @@ The **Update-ExchangeHelp** cmdlet automatically connects to a predefined websit - Configure **Update-ExchangeHelp** to get updates from an internal web server: 30 minutes. -- You need to be assigned permissions before you can perform this procedure or procedures. To see what permissions you need, see the "Exchange server configuration settings" entry in the [Exchange infrastructure and PowerShell permissions](https://docs.microsoft.com/Exchange/permissions/feature-permissions/infrastructure-permissions) topic. +- You need to be assigned permissions before you can perform this procedure or procedures. To see what permissions you need, see the "Exchange server configuration settings" entry in the [Exchange infrastructure and PowerShell permissions](https://docs.microsoft.com/Exchange/permissions/feature-permissions/infrastructure-permissions) article. - You can only use PowerShell to perform this procedure. To learn how to open the Exchange Management Shell in your on-premises Exchange organization, see [Open the Exchange Management Shell](open-the-exchange-management-shell.md). @@ -198,4 +198,4 @@ An easy way to find new update packages is to periodically run **Update-Exchange ## Details about Update-ExchangeHelp -Windows PowerShell has the **Update-Help** and **Save-Help** cmdlets for online and offline updates of cmdlet reference topics. However, these cmdlets don't support Exchange cmdlet help, so a specific Exchange cmdlet is required to update cmdlet reference topics in the Exchange Management Shell. +Windows PowerShell has the **Update-Help** and **Save-Help** cmdlets for online and offline updates of cmdlet reference articles. However, these cmdlets don't support Exchange cmdlet help, so a specific Exchange cmdlet is required to update cmdlet reference articles in the Exchange Management Shell. diff --git a/exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md b/exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md index 7a7208eb85..91e150d542 100644 --- a/exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md +++ b/exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md @@ -17,7 +17,7 @@ description: "Admins can learn how to use the older Exchange Online Remote Power # V1 module - Connect to Exchange Online PowerShell using MFA > [!NOTE] -> The older Exchange Online Remote PowerShell Module that's described in this topic will eventually be retired. The Exchange Online PowerShell V2 module (EXO V2 module) supports MFA, so we suggest using it instead. For instructions, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). +> The older Exchange Online Remote PowerShell Module that's described in this article will eventually be retired. The Exchange Online PowerShell V2 module (EXO V2 module) supports MFA, so we suggest using it instead. For instructions, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). If you want to use multi-factor authentication (MFA) to connect to Exchange Online PowerShell, you can't use the instructions at [Basic auth - Connect to Exchange Online PowerShell](basic-auth-connect-to-exo-powershell.md) to use remote PowerShell to connect to Exchange Online. MFA requires you to install the Exchange Online Remote PowerShell Module, and use the **Connect-EXOPSSession** cmdlet to connect. @@ -25,6 +25,8 @@ If you want to use multi-factor authentication (MFA) to connect to Exchange Onli - Estimated time to complete: 5 minutes +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in Exchange Online](https://docs.microsoft.com/exchange/permissions-exo/permissions-exo). + - You can use the following versions of Windows: - Windows 10 @@ -35,7 +37,7 @@ If you want to use multi-factor authentication (MFA) to connect to Exchange Onli - Windows 7 Service Pack 1 (SP1)* - Windows Server 2008 R2 SP1* - \* This version of Windows has reached end of support, and is now only supported when running in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). + \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. @@ -52,7 +54,7 @@ If you want to use multi-factor authentication (MFA) to connect to Exchange Onli ```dos winrm set winrm/config/client/auth @{Basic="true"} ``` - + **Note**: If you'd rather run the command in Windows PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`. If Basic authentication for WinRM is disabled, you'll get this error when you try to connect: diff --git a/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md b/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md index aa9675139f..b45df4919f 100644 --- a/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md @@ -17,13 +17,13 @@ description: "Admins can learn how to use the older Exchange Online Remote Power # V1 module - Connect to Security & Compliance Center PowerShell using MFA > [!NOTE] -> The older Exchange Online Remote PowerShell Module that's described in this topic will eventually be retired. The Exchange Online PowerShell V2 module (EXO V2 module) supports MFA, so we suggest using it instead. For instructions, see [Connect to Security & Compliance Center PowerShell](connect-to-scc-powershell.md). +> The older Exchange Online Remote PowerShell Module that's described in this article will eventually be retired. The Exchange Online PowerShell V2 module (EXO V2 module) supports MFA, so we suggest using it instead. For instructions, see [Connect to Security & Compliance Center PowerShell](connect-to-scc-powershell.md). If your account uses multi-factor authentication (MFA) or federated authentication, you can't use the instructions at [Basic auth - Connect to Security & Compliance Center PowerShell](basic-auth-connect-to-scc-powershell.md) to use remote PowerShell to connect to the Security & Compliance Center. Instead, you need to install the Exchange Online Remote PowerShell Module, and use the **Connect-IPPSSession** cmdlet to connect to Security & Compliance Center PowerShell. **Notes**: -- Delegated Access Permission (DAP) partners can't use the procedures in this topic to connect to their customer tenant organizations in Security & Compliance Center PowerShell. MFA and the Exchange Online Remote PowerShell Module don't work with delegated authentication. +- Delegated Access Permission (DAP) partners can't use the procedures in this article to connect to their customer tenant organizations in Security & Compliance Center PowerShell. MFA and the Exchange Online Remote PowerShell Module don't work with delegated authentication. - The Exchange Online Remote PowerShell Module is not supported in PowerShell Core (macOS, Linux, or Windows Nano Server). As a workaround, you can install the module on a computer that's running a supported version of Windows (physical or virtual), and use remote desktop software to connect. @@ -31,6 +31,8 @@ If your account uses multi-factor authentication (MFA) or federated authenticati - Estimated time to complete: 5 minutes +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). + - You can use the following versions of Windows: - Windows 10 @@ -41,7 +43,7 @@ If your account uses multi-factor authentication (MFA) or federated authenticati - Windows 7 Service Pack 1 (SP1)* - Windows Server 2008 R2 SP1* - \* This version of Windows has reached end of support, and is now only supported when running in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). + \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](https://docs.microsoft.com/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. @@ -68,9 +70,9 @@ If your account uses multi-factor authentication (MFA) or federated authenticati ## Install the Exchange Online Remote PowerShell Module > [!NOTE] -> +> > - The Exchange Online Remote PowerShell Module is not supported in PowerShell Core (macOS, Linux, or Windows Nano Server). As a workaround, you can install the module on a computer that's running a supported version of Windows (physical or virtual), and use remote desktop software to connect. -> +> > - If your installed version of the Exchange Online Remote PowerShell Module doesn't have the **Connect-IPPSSession** cmdlet, you need to install the latest version of the module. You need to do the following steps in a browser that supports ClickOnce (for example, Internet Explorer or Edge): diff --git a/exchange/docs-conceptual/values-for-custompropertynames-parameter.md b/exchange/docs-conceptual/values-for-custompropertynames-parameter.md new file mode 100644 index 0000000000..b3def77ea1 --- /dev/null +++ b/exchange/docs-conceptual/values-for-custompropertynames-parameter.md @@ -0,0 +1,217 @@ +--- +title: Values for the CustomPropertyNames parameter +ms.author: chrisda +author: chrisda +manager: dansimp +ms.date: +ms.audience: Admin +ms.topic: article +ms.service: exchange-online +ms.reviewer: +localization_priority: Priority +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: +search.appverid: MET150 +description: "Learn about the valid values for the CustomPropertyNames parameter on the the Get-CalendarDiagnosticsLog cmdlet in Exchange Online PowerShell." +--- + +# Values for the CustomPropertyNames parameter in Exchange Online PowerShell + +The _CustomPropertyNames_ parameter on the [Get-CalendarDiagnosticObjects](https://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticobjects) cmdlet returns the specified properties in the results. + +The article describes the valid values for the _CustomPropertyNames_ parameter. + +

+ +**** + +|CustomPropertyNames|Description| +|---|---| +|AddOnlineMeetingOnFinalize|Add online meeting on finalize flag.| +|AllAttachmentsHidden|The AllAttachmentsHidden property displays whether or not there are non-inline attachments inside the protected message.| +|AppointmentAuxiliaryFlags|Detect whether the meeting request is a forwarded meeting (for example, IsForwardedMeeting or AttendeeCount).| +|AppointmentClass|AppointmentClass is the MessageClass of the calendar item from which a meeting message is created.| +|AppointmentCounterEndWhole|End time proposal.| +|AppointmentCounterProposalCount|Current counter proposal count.| +|AppointmentCounterProposal|Indicates whether a Meeting Response object is a counter proposal.| +|AppointmentCounterStartWhole|Start time proposal.| +|AppointmentLastSequenceNumber|If AppointmentSequenceNumber doesn't match, then use AppointmentLastSequenceNumber to decide if this stale incoming request.| +|AppointmentProposedDuration|Proposed duration of the meeting in total minutes.| +|AppointmentRecurrenceBlob|Holds a copy of recurring information only from Recurring Masters.| +|AppointmentRecurring|Shows Bool True or False whether an Appointment is recurring.| +|AppointmentReplyName|The calendar item appointment reply name.| +|AppointmentReplyTime|Gets the time when the attendee replied to the meeting request.| +|AppointmentSequenceNumber|Gets the sequence number of this appointment.| +|AppointmentSequenceTime|Every appointment has a sequence number that is incremented on every modification.| +|AppointmentStateInternal|Gets the state of this appointment (for example, Meeting or Received).| +|AppointmentState|Gets the state of this appointment (for example, Meeting or Received).| +|AttendeeCriticalChangeTime|The attendee's critical change time.| +|BirthdayContactAttributionDisplayName|Property used to indicate the name of the contact associated with the birthday event.| +|BirthdayContactId|Represents the birthday contact ID property.| +|BirthdayPersonId|Represents the birthday person ID property used to associate multiple contact object to a single, aggregate person.| +|Birthday|Birthday of the contact.| +|CalendarItemExperienceTypeInternal|Experience type for a calendar item, used by client to render custom user experiences for different types of calendar items.| +|CalendarItemType|The Calendar Item Type (for example, RecurringMaster).| +|CalendarLogTriggerAction|The action thats taken on the item (for example, Create or Update).| +|CalendarOriginatorId|Identification of the organizer to prevent unintentional takeover of a meeting by other users.| +|CalendarProcessed|Check if the meeting message has been processed by XSO.| +|CalendarProcessingSteps|This is a set of flags for the various steps we completed in the stages of processing.| +|ChangeHighlight|Encapsulates information on the change highlights of a meeting request.| +|ChangeList|Add item to change list.| +|Charm|Charm on a calendar folder or item.| +|CleanGlobalObjectId|CleanGlobalObjectID is just the GlobalObjectId with the Instance Date segment zeroed out. This property will be the same for all meeting objects of all exceptions and masters belonging to the same series.| +|ClientBuildVersion|Outlook client build version.| +|ClientInfoString|The entity that made the change (for example, `Client=OWA;, Client=WebServices;;`, or `Client=TBA;Service=MSExchangeMailboxAssistants;Action=ELCAssistant;`).| +|ClientIntent|What the intent of the client is from any changes that are made to the item.| +|ClientProcessName|Client process name (for example, OUTLOOK.EXE).| +|ConferenceInfo|ConferenceInfo property is used by legacy online meeting and by calling the UCWA APIs we've updated the meeting.| +|ConferenceTelURI|The conference tel uri for online meeting.| +|ConferenceType|The type of conferencing that will be used during the meeting.| +|ConnectedCalendarEventSourceData|Property that contains the data of a connected calendar event as received from source.| +|CreationHash|A hash that identifies the original request to create an event.| +|CreationTime|Creation time of the item.| +|DisallowNewTimeProposal|Specifies whether recipients of the meeting request can propose a new time for the meeting.| +|DisplayAttendeesAll|List of All the Attendees.| +|DisplayAttendeesCc|Who to display the Attendees list CC line.| +|DisplayAttendeesTo|Who to display the Attendees list in To line.| +|DoNotForward|Organizer wants to prevent attendees from inviting others.| +|Duration|Duration in minutes.| +|EndTimeZoneId|Time zone of the end of the meeting.| +|EndTimeZone|Defines the EndTimeZone property.| +|EndTime|End time of a calendar item.| +|EndWallClock|The end time of the meeting expressed in the time zone of the meeting.| +|EnhancedLocation|Indicates that Enhanced Location data is present, has value : Microsoft.Exchange.Data.Storage.EnhancedLocation.| +|EntryId|The store entry id or PR_ENTRYID (MAPI).| +|EstimatedAcceptCount|An estimated count of the number of attendees which accepted a meeting.| +|EstimatedAttendeeCount|An estimated count of the number of attendees of a meeting.| +|EstimatedDeclineCount|An estimated count of the number of attendees which declined a meeting.| +|EstimatedTentativeCount|An estimated count of the number of attendees which tentatively accepted a meeting.| +|EventClientId|Client-generated string representing id for series of calendar events.| +|EventDraft|Flag indicating whether calendar event is in the draft state.| +|EventResponseTrackingSource|Event response tracking status.| +|EventTimeBasedInboxRemindersState|Property that contains the state for time-based inbox reminders pertaining to calendar events.| +|EventTimeBasedInboxReminders|Property that contains time-based inbox reminders pertaining to calendar events.| +|ExceptionReplaceTime|The exception replace time.| +|ExceptionalAttendees|Bool value whether there are Exceptional Attendees.| +|ExceptionalBody|Bool value whether there are Exceptional Body is changed.| +|ExternalSharingMasterId|If copy of remote calendar in shared in calendar do not set organizer as it is not simply owner of a current mailbox It will sync back from master copy where it will be evaluated properly at save.| +|ForwardNotificationRecipients|List of Forwarded Recipients.| +|FreeBusyStatus|Free/busy status associated with the event.| +|From|From e-mail address.| +|GlobalObjectId|GlobalObjectId is a binary blob used to correlate the meeting requests/responses/cancellations in the Inbox with the meeting item in the Calendar.| +|HasAttachment|Value indicating whether the item has attachments.| +|HasExceptionalInboxReminders|Whether a series has any exceptional inbox reminders.| +|HijackedMeeting|Indicates if the meeting request was hijacked, useful to identify if if specific meetings aren't processed, because another user Hijacked the meeting.| +|Importance|Importance status of the email (for example, Normal).| +|InboundICalStream|Contains the contents of the iCalendar MIME part of the original MIME message.| +|InstanceCreationIndex|The index of this instance when the series was originally created.| +|IntendedFreeBusyStatus|Value representing the intended free/busy status of the meeting.| +|InternetMessageId|Internet Message Id of the e-mail message.| +|IsAllDayEvent|Value indicating whether this appointment is an all day event.| +|IsBirthdayContactWritable|Property used to indicate whether or not the contact associated with the birthday event is writable.| +|IsCancelled|Bool value whether or not the meeting is cancelled.| +|IsCopyOnWriteItem|Indicator for Calendar Logging items.| +|IsDraft|Bool value indicating whether the item is is a draft. An item is a draft when it has not yet been sent.| +|IsEvent|Indicates if the meeting should be displayed in banner for event, not calendar grid area.| +|IsException|Value indicating whether the calendar event is an exception in a recurring series.| +|IsHiddenFromLegacyClients|Flag deciding whether modern calendar item should be hidden for legacy clients.| +|IsMeetingPollEvent|Is meeting poll event boolean flag.| +|IsMeeting|Value indicating whether the calendar event is a meeting.| +|IsProcessed|True if the message has been processed either by XSO or by Outlook.| +|IsPublishedCalendarItem|Whether a calendar event (schedule) has been published.| +|IsRecurring|Value indicating whether the calendar event is recurring.| +|IsResponseRequested|Value indicating whether responses are requested when invitations are sent for this meeting.| +|IsSeriesCancelled|Expected to be true for the attendee if the recurring master is cancelled.| +|IsSilent|Returns True if the response doesn't contain any body text.| +|IsSingleBodyICal|Indicates that the original MIME message contained a single MIME part.| +|IsSoftDeleted|True only if the object is soft-deleted.| +|ItemClass|Contains a text string that identifies the sender-defined message class, such as IPM.Note.| +|ItemId|Object Store ItemId.| +|ItemVersion|Version of the item.| +|LastModifiedTime|Gets the date and time this item was last modified.| +|LocationAddressInternal|One of the properties that define the enhanced location and their corresponding default values.| +|Location|Gets the location of the calendar event.| +|MFNAddedRecipients|The list of recipients that were explicitly forwarded.| +|MailboxDatabaseName|Mailbox Database Exchange DistinguishedName.| +|MapiEndTime|EndTime of Meeting.| +|MapiIsAllDayEvent|An all-day event is midnight to midnight.| +|MapiPREndDate|MapiPR(Pattern Recurrence) EndDate of Meeting.| +|MapiPRStartDate|MapiPR(Pattern Recurrence) StartDate of Meeting.| +|MapiStartTime|StartTime of Meeting.| +|MasterGlobalObjectId|Holds the original GUID of the item in case another process needs to change it.| +|MeetingRequestType|Defines the type of meeting request.| +|MeetingRequestWasSent|Value indicating whether the meeting request has already been sent.| +|MeetingUniqueId|Meeting unique ID used to link meeting history to master meeting item.| +|MeetingWorkspaceUrl|URL of the meeting workspace. A meeting workspace is a shared Web site for planning meetings and tracking results.| +|MiddleTierProcessName|ProcessName handling the request (for example, w3wp).| +|MiddleTierServerBuildVersion|EXO Build Version.| +|MiddleTierServerName|Backend Mailbox ServerName.| +|NormalizedSubject|Subject of the meeting.| +|OccurrencesExceptionalViewProperties|Blob representing the exceptional properties of instances of an NPR.| +|OldLocation|Saved old location before updating new location.| +|OldStartWhole|Old time properties on the updated meeting request.| +|OnlineMeetingConfLink|The online meeting link.| +|OnlineMeetingExternalLink|The online meeting external link.| +|OnlineMeetingInformation|The online meeting information.| +|OnlineMeetingInternalLink|Represents the https uri for joining the Lync online meeting. Deprecated.| +|OriginalClientInfoString|Some processes are touching the ClientInfoString, so we need to backup the original value for Calendar Logging items.| +|OriginalCreationTime|Creation time of the item.| +|OriginalEntryId|Original `PR_ENTRYID` (MAPI), unique Id identifier in store.| +|OriginalFolderId|Original `PR_FOLDERID` (MAPI), unique Id identifier in store.| +|OriginalGlobalObjectId|Holds the original GUID of the item in case we have to change it.| +|OriginalICal|Holds the original iCal of an imported item.| +|OriginalLastModifiedTime|Used as the primary sort field to order the events.| +|OriginalMeetingType|Retains the original MeetingType in case the original meeting type is reset.| +|OriginalStoreEntryId|Maintains a copy of the store entry id if the original gets modified.| +|OwnerAppointmentID|This property is supposed to be a number that is unique to the sender's calendar. Outlook uses this number to correlate meeting messages with calendar items.| +|OwnerCriticalChangeTime|DateTime tracking value for Owner Critical Change Time.| +|ParentDisplayName|ParentDisplayName of the Folder.| +|ParkedCorrelationId|Holds correlation id of parked message.| +|ParkedMessagesFolderEntryId|Holds the entry id of ParkedMessages folder.| +|Preview|Preview of the Email.| +|PropertyChangeMetadataProcessingFlags|Flags representing property change metadata processing behavior.| +|PropertyChangeMetadataRaw|Blob representing property change metadata for Series exception management purposes.| +|PublishedCalendarItemUrl|The url for a published calendar event (schedule).| +|RawAttendeeInformation|Stores raw attendee information provided by a client, to help troubleshoot and debug attendee translation issues.| +|ReceivedBy|Gets the ReceivedBy property of the e-mail message.| +|ReceivedRepresenting|Returns received on behalf display name for delegate meeting message own meeting.| +|RecipientType|Represents the recipient type of a recipient on the message.| +|RecurrencePattern|A date for which this pattern should be created.| +|ReminderIsSetInternal|True or False.| +|ReminderMinutesBeforeStartInternal|Reminder in minutes before the meeting starts.| +|ResponseState|Accepted, Tentative, Declined Response State.| +|ResponseType|Gets the type of response the attendee gave to the meeting invitation it received.| +|ResponsibleUserName|The LegacyExchangeDN value of the user who made the change (for example, `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=BN6PR11MB1587/cn=Microsoft System Attendant` or `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=696eea97d3c449eab648920d03385efb-admin`).| +|SenderEmailAddress|SMTP Address who sent it.| +|Sensitivity|Defines the sensitivity of an item.| +|SentRepresentingDisplayName|The display name of the sent representing person.| +|SentRepresentingEmailAddress|Represents sent representing email address.| +|SentRepresentingEntryId|The entry id of the the sent representing person.| +|SentRepresentingType|The address type of the sent representing person.| +|SeriesId|String representing id for series of calendar events.| +|SeriesReminderIsSet|Flag indicating whether reminder is set for the whole series.| +|Size|Size in Bytes of the Meeting Message.| +|SkypeTeamsMeetingUrl|The meeting url for Teams meeting.| +|SkypeTeamsProperties|The relevant properties for Teams meeting.| +|StartTimeZoneId|Time zone of the start of the meeting.| +|StartTimeZone|Start timezone of a calendar item.| +|StartTime|Start time of a calendar item.| +|StartWallClock|The start time of the meeting expressed in the time zone of the meeting.| +|SuggestionCategory|Represents the suggestion category for the message.| +|TimeZoneBlob|Outlook time zone blob (from registry) for recurrence.| +|TimeZoneDefinitionEnd|Legacy time zone (ExchangeTimeZoneTime) blob for end time.| +|TimeZoneDefinitionRecurring|Legacy time zone (ExchangeTimeZoneTime) blob for recurrence.| +|TimeZoneDefinitionStart|Legacy time zone (ExchangeTimeZoneTime) blob for start time.| +|TimeZone|TimeZone value.| +|TransportMessageHeaders|Transport Message Header Information.| +|UCCapabilities|Represents the XML blob of OCS capabilities for the Lync online meeting.| +|UCInband|Represents the XML blob of Inband data for the Lync online meeting.| +|UCMeetingSettingSent|Represents the XML blob of all information related to the Lync online meeting.| +|UCMeetingSetting|Represents the XML blob of all information related to the Lync online meeting.| +|UCOpenedConferenceID|Represents the guid associated with this online meeting.| +|UnsendableRecipients|This property contains the recipient data for all unsendable recipients.| +|ViewEndTime|End time of a calendar item.| +|ViewStartTime|Start time of a calendar item.| +|When|The text returned by When is localized using the Exchange Server culture or using the culture specified in the PreferredCulture property of the ExchangeService object this appointment is bound to.| +| diff --git a/exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md b/exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md index 854ee58c40..2eb9584280 100644 --- a/exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md +++ b/exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md @@ -64,7 +64,7 @@ This example adds a global monitoring override that disables the StorageLogicalD ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the probe, monitor, or responder. This parameter uses the syntax \\\\[\\\]. Note that the values are case sensitive. For example, use "AD\\ActiveDirectoryConnectivityServerReboot", not "ad\\activedirectoryconnectivityserverreboot". +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 diff --git a/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md index 1b0becce88..c267d450c5 100644 --- a/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md +++ b/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md @@ -88,7 +88,7 @@ In on-premises Exchange, this example adds the MailboxAudit script with the Depa ## PARAMETERS ### -Identity -The Identity parameter specifies the role entry that you want to add. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). +The Identity parameter specifies the role entry that you want to add. This parameter uses the syntax: `Management role\role entry name` (for example, `CustomRole\Set-Mailbox`). For more information about how management role entries work, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). diff --git a/exchange/exchange-ps/exchange/Add-ResubmitRequest.md b/exchange/exchange-ps/exchange/Add-ResubmitRequest.md index b26705452c..3d88a20847 100644 --- a/exchange/exchange-ps/exchange/Add-ResubmitRequest.md +++ b/exchange/exchange-ps/exchange/Add-ResubmitRequest.md @@ -139,7 +139,7 @@ Accept wildcard characters: False ``` ### -Destination -The Destination parameter specifies the GUID of the destination mailbox database. To find the GUID of the mailbox database, run the command: Get-MailboxDatabase -Server \ | Format-List Name,GUID. +The Destination parameter specifies the GUID of the destination mailbox database. To find the GUID of the mailbox database, run the command: `Get-MailboxDatabase -Server | Format-List Name,GUID`. You can't use this parameter with the Recipient, ResubmitTo, or Sender parameters. diff --git a/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md b/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md index dbc5a7f115..999438d3f9 100644 --- a/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md @@ -52,7 +52,7 @@ This example adds a server monitoring override that disables the responder Activ ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the monitoring item that you want to override. This parameter uses the syntax \\\\[\\\]. Note that the values are case sensitive. For example, use "AD\\ActiveDirectoryConnectivityConfigDCServerReboot", not "ad\\activedirectoryconnectivityconfigdcserverreboot". +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. diff --git a/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md index c5a364faf8..78f036d363 100644 --- a/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/exchange/Add-UnifiedGroupLinks.md @@ -34,9 +34,7 @@ Microsoft 365 Groups are group objects that are available across Microsoft 365 s You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -> - [!NOTE] -> Only members can be owners of a group, so you must first add a user as member before adding it as an owner. +**Note**: Only members can be owners of a group, so you must first add a user as member before adding it as an owner. ## EXAMPLES @@ -84,7 +82,7 @@ You can use any value that uniquely identifies the recipient. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -102,6 +100,7 @@ Accept wildcard characters: False ### -LinkType The LinkType parameter specifies the Microsoft 365 Group property that you want to modify. Valid values are: +- Aggregators - Members - Owners - Subscribers diff --git a/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md index 8b51a6c9c5..df2877e7d3 100644 --- a/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md +++ b/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Clear-ActiveSyncDevice cmdlet to delete all data from a mobile device. -Note: In Exchange 2013 or later, use the Clear-MobileDevice cmdlet instead. If you have scripts that use Clear-ActiveSyncDevice, update them to use Clear-MobileDevice. +**Note**: In Exchange 2013 or later, use the Clear-MobileDevice cmdlet instead. If you have scripts that use Clear-ActiveSyncDevice, update them to use Clear-MobileDevice. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -134,7 +134,7 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses -The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. +The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index 7caf215ecd..55db4db002 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -238,7 +238,7 @@ Accept wildcard characters: False ``` ### -Prefix -The Prefix parameter specifies an alias to add to nouns in the names of older remote PowerShell cmdlets (cmdlet with nouns that don't already start with EXO). A valid value is a text string without spaces, and you can't use the value EXO (this prefix is reserved for PowerShell V2 module cmdlets). +The Prefix parameter specifies an alias to add to nouns in the names of older remote PowerShell cmdlets (cmdlet with nouns that don't already start with EXO). A valid value is a text string without spaces or special characters like underscrores, asterisks etc, and you can't use the value EXO (this prefix is reserved for PowerShell V2 module cmdlets). ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Connect-Mailbox.md b/exchange/exchange-ps/exchange/Connect-Mailbox.md index b9f426737d..8871c0b31b 100644 --- a/exchange/exchange-ps/exchange/Connect-Mailbox.md +++ b/exchange/exchange-ps/exchange/Connect-Mailbox.md @@ -367,9 +367,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md index 98103b3935..329fb5866e 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -53,14 +53,16 @@ This example deletes the quarantined message with the specified Identity value. ### Example 2 ```powershell -$ids = Get-QuarantineMessage | select -ExpandProperty Identity; Delete-QuarantineMessage -Identity $ids[4] +$ids = Get-QuarantineMessage | select -ExpandProperty Identity +Delete-QuarantineMessage -Identity $ids[4] ``` This example deletes the 5th quarantined message in the list of results from Get-QuarantineMessage. The first message has the index number 0, the second has the index number 1 and so on). ### Example 3 ```powershell -$ids = Get-QuarantineMessage | select -ExpandProperty Identity; Delete-QuarantineMessage -Identities $ids -Identity 000 +$ids = Get-QuarantineMessage | select -ExpandProperty Identity +Delete-QuarantineMessage -Identities $ids -Identity 000 ``` This example deletes all quarantined messages. The Identity parameter is required, but the value 000 is ignored. diff --git a/exchange/exchange-ps/exchange/Disable-InboxRule.md b/exchange/exchange-ps/exchange/Disable-InboxRule.md index 6a939ea093..9beb4072d2 100644 --- a/exchange/exchange-ps/exchange/Disable-InboxRule.md +++ b/exchange/exchange-ps/exchange/Disable-InboxRule.md @@ -52,8 +52,8 @@ The Identity parameter specifies the Inbox rule that you want to disable. You ca - Name - RuleIdentity property (for example, 16752869479666417665). -- Exchange Online: `\` (for example, `rzaher\16752869479666417665`. -- On-premises Exchange: `\` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). +- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). +- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). ```yaml Type: InboxRuleIdParameter diff --git a/exchange/exchange-ps/exchange/Disable-Mailbox.md b/exchange/exchange-ps/exchange/Disable-Mailbox.md index d97ade1b16..220524b315 100644 --- a/exchange/exchange-ps/exchange/Disable-Mailbox.md +++ b/exchange/exchange-ps/exchange/Disable-Mailbox.md @@ -284,7 +284,7 @@ This parameter is available only in the cloud-based service. The PermanentlyDisable switch specifies whether to permanently disable the mailbox. You don't need to specify a value with this switch. -Notes: +**Notes**: - You can only use this switch on user mailboxes that aren't licensed and aren't on hold. - When the Exchange Online license is removed from a mailbox without following other deprovisioning steps, this may leave the mailbox in a hard-deleted state. In this case, this parameter is not useful. You can use it, for example, in hybrid Exchange environments. diff --git a/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md index e6e4a34e1b..09567c59c3 100644 --- a/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md +++ b/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md @@ -68,11 +68,11 @@ This example disables Outlook Anywhere on the specified virtual directory on the ### -Identity The Identity parameter specifies the Outlook Anywhere virtual directory that you want to disable. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. You can't use the Identity and Server parameters in the same command. diff --git a/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md b/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md index 876984383e..f8ef8ee8bc 100644 --- a/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md @@ -41,7 +41,7 @@ If you want to remove both the cloud-based mailbox and the associated on-premise Directory synchronization must be configured correctly for a mailbox to be removed from the cloud. Removal of the cloud-based mailbox isn't immediate and depends on the directory synchronization schedule. -Note: If you are deprovisioning a cloud mailbox and its associated online archive, you must first disable the online archive with Disable-RemoteMailbox \ -Archive and then perform a directory synchronization prior to disabling the remote mailbox. Attempting to disable both the online archive and cloud mailbox without a sync between them may result in an ArchiveGuid mismatch and validation error. +**Note**: If you are deprovisioning a cloud mailbox and its associated online archive, you must first disable the online archive with the command `Disable-RemoteMailbox -Archive` and then perform a directory synchronization prior to disabling the remote mailbox. Attempting to disable both the online archive and cloud mailbox without a sync between them may result in an ArchiveGuid mismatch and validation error. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md index c46a6b70cb..186caa567a 100644 --- a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md @@ -30,7 +30,7 @@ Disable-SafeAttachmentRule [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Office 365 ATP](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md b/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md index 545e07c2df..de660c5c06 100644 --- a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md @@ -30,7 +30,7 @@ Disable-SafeLinksRule [-Identity] ``` ## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Disable-SweepRule.md b/exchange/exchange-ps/exchange/Disable-SweepRule.md index c1253a8521..e91c8f9811 100644 --- a/exchange/exchange-ps/exchange/Disable-SweepRule.md +++ b/exchange/exchange-ps/exchange/Disable-SweepRule.md @@ -54,8 +54,8 @@ This example disables all Sweep rules in the specified mailbox. The Identity parameter specifies the Sweep rule that you want to disable. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). -- Exchange Online: \\\\ (for example, rzaher\\x2hlsdpGmUifjFgxxGIOJw==. -- On-premises Exchange: \\\\ (for example, contoso.com/Users/Rick Zaher\\x2hlsdpGmUifjFgxxGIOJw==. +- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). +- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). ```yaml Type: SweepRuleIdParameter diff --git a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md index 956d2953ea..290e9aef33 100644 --- a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md @@ -10,7 +10,6 @@ ms.author: chrisda ms.reviewer: navgupta --- - # Disconnect-ExchangeOnline ## SYNOPSIS diff --git a/exchange/exchange-ps/exchange/Enable-DistributionGroup.md b/exchange/exchange-ps/exchange/Enable-DistributionGroup.md index 2d757e9af3..3f9e50109c 100644 --- a/exchange/exchange-ps/exchange/Enable-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Enable-DistributionGroup.md @@ -71,9 +71,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: diff --git a/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md index a2540eb117..e45a8fc424 100644 --- a/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md @@ -90,8 +90,8 @@ Accept wildcard characters: False ### -Identity The Identity parameter specifies the certificate that you want to configure. Valid values are: -- \\\\ -- \ +- `ServerNameOrFQDN\Thumbprint` +- `Thumbprint` You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. diff --git a/exchange/exchange-ps/exchange/Enable-InboxRule.md b/exchange/exchange-ps/exchange/Enable-InboxRule.md index 6e661ebd06..7748ec951e 100644 --- a/exchange/exchange-ps/exchange/Enable-InboxRule.md +++ b/exchange/exchange-ps/exchange/Enable-InboxRule.md @@ -52,8 +52,8 @@ The Identity parameter specifies the Inbox rule that you want to enable. You can - Name - RuleIdentity property (for example, 16752869479666417665). -- Exchange Online: `\` (for example, `rzaher\16752869479666417665`. -- On-premises Exchange: `\` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). +- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). +- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). ```yaml Type: InboxRuleIdParameter diff --git a/exchange/exchange-ps/exchange/Enable-MailContact.md b/exchange/exchange-ps/exchange/Enable-MailContact.md index e0e0503624..e7a9648a44 100644 --- a/exchange/exchange-ps/exchange/Enable-MailContact.md +++ b/exchange/exchange-ps/exchange/Enable-MailContact.md @@ -93,9 +93,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: diff --git a/exchange/exchange-ps/exchange/Enable-MailUser.md b/exchange/exchange-ps/exchange/Enable-MailUser.md index 00c4831493..ea84552cf2 100644 --- a/exchange/exchange-ps/exchange/Enable-MailUser.md +++ b/exchange/exchange-ps/exchange/Enable-MailUser.md @@ -120,9 +120,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: diff --git a/exchange/exchange-ps/exchange/Enable-Mailbox.md b/exchange/exchange-ps/exchange/Enable-Mailbox.md index 43b77d7f17..907f749312 100644 --- a/exchange/exchange-ps/exchange/Enable-Mailbox.md +++ b/exchange/exchange-ps/exchange/Enable-Mailbox.md @@ -586,9 +586,9 @@ This parameter is available only in on-premises Exchange. The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -671,7 +671,7 @@ Accept wildcard characters: False ### -ArchiveName The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook and Outlook Web App. -If you don't use this parameter, the default value is In-Place Archive - \. +If you don't use this parameter, the default value is `In-Place Archive - `. ```yaml Type: MultiValuedProperty @@ -711,7 +711,7 @@ The AutoExpandingArchive switch enables the unlimited archiving feature (called After you enable auto-expanding archiving, additional storage space is automatically added to the user's archive mailbox when it approaches the storage limit. -Notes: +**Notes**: - The user's archive mailbox has to be enabled before auto-expanding archiving can be enabled. - After you enable auto-expanding archiving for the user's mailbox, it can't be disabled. diff --git a/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md index 0b0c4865dd..93a727220c 100644 --- a/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md +++ b/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md @@ -224,7 +224,7 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi The possible values are: - Null This is the default value. -- Single SPN or comma delimited list of valid SPNs By default, you must specify the fully qualified domain name (FQDN) (for example mail.contoso.com) for each SPN. If you want to add an SPN that's not an FQDN (for example, ContosoMail), you must also use the ExtendedProtectionTokenChecking parameter with the AllowDotlessSPN value. You specify the domain in SPN format. The SPN format is \/\. For example, a valid entry could be HTTP/mail.contoso.com. +- Single SPN or comma delimited list of valid SPNs By default, you must specify the fully qualified domain name (FQDN) (for example mail.contoso.com) for each SPN. If you want to add an SPN that's not an FQDN (for example, ContosoMail), you must also use the ExtendedProtectionTokenChecking parameter with the AllowDotlessSPN value. You specify the domain in SPN format. The SPN format is `Protocol\FQDN` (for example, `HTTP/mail.contoso.com`). ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md b/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md index 76a9d87883..f8e0856881 100644 --- a/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md @@ -232,9 +232,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: diff --git a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md index 0d5fd5bf53..e0e484e13f 100644 --- a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md @@ -30,7 +30,7 @@ Enable-SafeAttachmentRule [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Office 365 ATP](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md b/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md index c35093137b..b08646d678 100644 --- a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md @@ -30,7 +30,7 @@ Enable-SafeLinksRule [-Identity] ``` ## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Enable-SweepRule.md b/exchange/exchange-ps/exchange/Enable-SweepRule.md index d2b7b4c20f..98088a3d4a 100644 --- a/exchange/exchange-ps/exchange/Enable-SweepRule.md +++ b/exchange/exchange-ps/exchange/Enable-SweepRule.md @@ -54,8 +54,8 @@ This example enables all Sweep rules in the specified mailbox. The Identity parameter specifies the Sweep rule that you want to enable. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). -- Exchange Online: \\\\ (for example, rzaher\\x2hlsdpGmUifjFgxxGIOJw==. -- On-premises Exchange: \\\\ (for example, contoso.com/Users/Rick Zaher\\x2hlsdpGmUifjFgxxGIOJw==. +- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). +- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). ```yaml Type: SweepRuleIdParameter diff --git a/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md b/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md index 8cf44f155a..0d60f7aa65 100644 --- a/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md +++ b/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md @@ -37,7 +37,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$file = Export-DlpPolicyCollection; Set-Content -Path "C:\My Documents\Contoso PII.xml" -Value $file.FileData -Encoding Byte +$file = Export-DlpPolicyCollection +Set-Content -Path "C:\My Documents\Contoso PII.xml" -Value $file.FileData -Encoding Byte ``` This example exports all the elements of the existing DLP policies to the file C:\\My Documents\\Contoso PII.xml. diff --git a/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md index 957162346c..5abecdd4f9 100644 --- a/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md @@ -107,8 +107,8 @@ Accept wildcard characters: False ### -Identity The Identity parameter specifies the certificate or certificate request that you want to export. Valid values are: -- \\\\ -- \ +- `ServerNameOrFQDN\Thumbprint` +- `Thumbprint` You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. @@ -185,7 +185,7 @@ Accept wildcard characters: False ``` ### -FileName -The FileName parameter specifies the name and path of the exported certificate or certificate request file. You can use a local path if the certificate or certificate request is located on the same Exchange server where you're running the command. Otherwise, use a UNC path (`\\\`). If the value contains spaces, enclose the value in quotation marks ("). +The FileName parameter specifies the name and path of the exported certificate or certificate request file. You can use a local path if the certificate or certificate request is located on the same Exchange server where you're running the command. Otherwise, use a UNC path (`\\Server\Share`). If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md b/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md index 5a7d5b1047..1a7a100227 100644 --- a/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md +++ b/exchange/exchange-ps/exchange/Export-JournalRuleCollection.md @@ -38,14 +38,16 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$file = Export-JournalRuleCollection; Set-Content -Path "C:\MyDocs\JournalRules.xml" -Value $file.FileData -Encoding Byte +$file = Export-JournalRuleCollection +Set-Content -Path "C:\MyDocs\JournalRules.xml" -Value $file.FileData -Encoding Byte ``` This example exports journal rules in a two-step process. In the first step, the Export-JournalRuleCollection cmdlet exports journal rules to the variable $file. In the second step, the Set-Content cmdlet saves the exported data to the XML file JournalRules.xml. ### Example 2 ```powershell -$file = Export-JournalRuleCollection -ExportLegacyRules; Set-Content -Path "C:\MyDocs\Ex2007-JournalRules.xml" -Value $file.FileData -Encoding Byte +$file = Export-JournalRuleCollection -ExportLegacyRules +Set-Content -Path "C:\MyDocs\Ex2007-JournalRules.xml" -Value $file.FileData -Encoding Byte ``` In Exchange Server 2010, this example exports legacy journal rules to an XML file using the two-step process similar to the preceding example. In the first step, the Export-JournalRuleCollection cmdlet is used with the ExportLegacyRules switch to export legacy rules to the array $file. In the second step, the exported data is saved to the XML file Ex2007-JournallRules.xml. diff --git a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md index ae7596f0de..32b3fe3c46 100644 --- a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md +++ b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md @@ -113,7 +113,9 @@ The ComponentName parameter specifies the component that you want to retrieve th - RemindersAssistant - SharingMigrationAssistant - SharingSyncAssistant +- SubstrateHoldTracking - SweepRules +- TimeProfile ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Export-Message.md b/exchange/exchange-ps/exchange/Export-Message.md index 742b48139c..80c9debd5c 100644 --- a/exchange/exchange-ps/exchange/Export-Message.md +++ b/exchange/exchange-ps/exchange/Export-Message.md @@ -43,13 +43,17 @@ This example exports a single message to the specified file path. Because the Ex ### Example 2 ```powershell -Get-Message -Queue "Server1\contoso.com" -ResultSize Unlimited | ForEach-Object {Suspend-Message $_.Identity -Confirm:$False; $Temp="C:\ExportFolder\"+$_.InternetMessageID+".eml"; $Temp=$Temp.Replace("<","_"); $Temp=$Temp.Replace(">","_"); Export-Message $_.Identity | AssembleMessage -Path $Temp} +Get-Message -Queue "Server1\contoso.com" -ResultSize Unlimited | ForEach-Object {Suspend-Message $_.Identity -Confirm:$False +$Temp="C:\ExportFolder\"+$_.InternetMessageID+".eml" +$Temp=$Temp.Replace("<","_") +$Temp=$Temp.Replace(">","_") +Export-Message $_.Identity | AssembleMessage -Path $Temp} ``` This example retrieves all messages from the specified queue. The query results are then piped to the Export-Message command, and all the messages are copied to individual .eml files. The Internet Message IDs of each message are used as the file names. To accomplish this, the command does the following: - Retrieves all messages in a specific queue using the Get-Message cmdlet. -- The result is pipelined into the ForEach-Object cmdlet, which prepares a file name including full path using the temporary variable $Temp that consists of the Internet Message ID with .eml extension. The Internet Message ID field contains angled brackets ("\>" and "\<") which need to be removed as they are invalid file names. This is done using the Replace method of the temporary variable. +- The result is pipelined into the ForEach-Object cmdlet, which prepares a file name including full path using the temporary variable $Temp that consists of the Internet Message ID with .eml extension. The Internet Message ID field contains angled brackets (`<` and `>`) which need to be removed as they are invalid file names. This is done using the Replace method of the temporary variable. - The ForEach-Object cmdlet also exports the message using the file name prepared. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md index 75c34c13cc..6a55fdd350 100644 --- a/exchange/exchange-ps/exchange/Export-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Export-QuarantineMessage.md @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Export-QuarantineMessage cmdlet to export quarantined messages and files from your cloud-based organization. Messages are exported to .eml message files so you can open them in Outlook. -For files that are protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams, the files are exported in Base64 format. +For files that were quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the files are exported in Base64 format. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -36,7 +36,9 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$e = Export-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7; $e.BodyEncoding; $e | select -ExpandProperty Eml | Out-File "C:\My Documents\Export1_ascii.eml" -Encoding ascii +$e = Export-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7 +$e.BodyEncoding +$e | select -ExpandProperty Eml | Out-File "C:\My Documents\Export1_ascii.eml" -Encoding ascii ``` This example exports the quarantined message with the specified Identity value. @@ -45,14 +47,16 @@ The first two commands determine the message encoding (the value of the BodyEnco The third command exports the message to the specified file using the message encoding that you found in the previous commands. -Notes: +**Notes**: - The `| select -ExpandProperty Eml`" part of the command specifies the whole message, including attachments. - You need to use the Out-File cmdlet to write the .eml message file with the required encoding. If you use the default PowerShell redirection operator ">" to write the output file, the default encoding is Unicode, which might not match the actual message encoding. ### Example 2 ```powershell -$e = Export-QuarantineMessage -Identity 9c6bb3e8-db9e-4823-9759-08d594179bd3\7fec89fe-41b0-ae67-4887-5bede017d111; $bytes = [Convert]::FromBase64String($e.eml); [IO.File]::WriteAllBytes("C:\My Documents\Export1.txt", $bytes) +$e = Export-QuarantineMessage -Identity 9c6bb3e8-db9e-4823-9759-08d594179bd3\7fec89fe-41b0-ae67-4887-5bede017d111 +$bytes = [Convert]::FromBase64String($e.eml) +[IO.File]::WriteAllBytes("C:\My Documents\Export1.txt", $bytes) ``` This example exports the quarantined file with the specified Identity value. The first command exports the file to a Base 64 string. The next two commands convert the string to byte format and write it to the output file. diff --git a/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md b/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md index d948683c9c..fa07cad4d6 100644 --- a/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md +++ b/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Export-TransportRuleCollection [[-Identity] ] [-Confirm] [-DomainController ] + [-Format ] [-ExportLegacyRules] [-WhatIf] [] @@ -40,7 +41,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$file = Export-TransportRuleCollection; Set-Content -Path "C:\My Docs\Rules.xml" -Value $file.FileData -Encoding Byte +$file = Export-TransportRuleCollection +Set-Content -Path "C:\My Docs\Rules.xml" -Value $file.FileData -Encoding Byte ``` This example exports transport rules. Rule data is first exported to the variable $file, and then written to the XML file Rules.xml in the C:\\My Docs folder. @@ -49,7 +51,8 @@ This example exports transport rules. Rule data is first exported to the variabl ### Example 2 ```powershell -$file = Export-TransportRuleCollection -ExportLegacyRules; Set-Content -Path "C:\MyDocs\LegacyRules.xml" -Value $file.FileData -Encoding Byte +$file = Export-TransportRuleCollection -ExportLegacyRules +Set-Content -Path "C:\MyDocs\LegacyRules.xml" -Value $file.FileData -Encoding Byte ``` In Exchange Server 2010, this example exports legacy transport rules created in Exchange 2007 using the ExportLegacyRules switch. The cmdlet should be run from an Exchange 2010 Hub Transport server. The exported rules collection can then be imported to Exchange 2010 using the Import-TransportRuleCollection cmdlet. @@ -59,7 +62,11 @@ In Exchange Server 2010, this example exports legacy transport rules created in ### -Identity This cmdlet is available only in on-premises Exchange, and is functional only in Exchange Server 2010. -The Identity parameter specifies the name or GUID of a transport rule to be exported. +The Identity parameter specifies the transport rule that you want to export. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml Type: RuleIdParameter @@ -131,6 +138,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Format +This parameter is available only in the cloud-based service. + +The Format parameter specifics the format of the exported transport rule collection. Valid values are: + +- RuleCollectionXML +- InternalXML +- DlpMigrationRuleCollection + +```yaml +Type: RuleCollectionFormat +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. diff --git a/exchange/exchange-ps/exchange/Export-UMPrompt.md b/exchange/exchange-ps/exchange/Export-UMPrompt.md index d675a5933d..ac8e5ea88d 100644 --- a/exchange/exchange-ps/exchange/Export-UMPrompt.md +++ b/exchange/exchange-ps/exchange/Export-UMPrompt.md @@ -49,14 +49,16 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$prompt = Export-UMPrompt -PromptFileName "customgreeting.mp3" -UMDialPlan MyUMDialPlan; Set-Content -Path "d:\DialPlanPrompts\welcomegreeting.mp3" -Value $prompt.AudioData -Encoding Byte +$prompt = Export-UMPrompt -PromptFileName "customgreeting.mp3" -UMDialPlan MyUMDialPlan +Set-Content -Path "d:\DialPlanPrompts\welcomegreeting.mp3" -Value $prompt.AudioData -Encoding Byte ``` This example exports the welcome greeting for the UM dial plan MyUMDialPlan and saves it as the file welcomegreeting.mp3. ### Example 2 ```powershell -$prompt = Export-UMPrompt -PromptFileName "welcomegreeting.mp3" -UMAutoAttendant MyUMAutoAttendant; Set-Content -Path "e:\UMPromptsBackup\welcomegreetingbackup.mp3" -Value $prompt.AudioData -Encoding Byte +$prompt = Export-UMPrompt -PromptFileName "welcomegreeting.mp3" -UMAutoAttendant MyUMAutoAttendant +Set-Content -Path "e:\UMPromptsBackup\welcomegreetingbackup.mp3" -Value $prompt.AudioData -Encoding Byte ``` This example exports a custom greeting for the UM auto attendant MyUMAutoAttendant and saves it to the file welcomegreetingbackup.mp3. diff --git a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md index e2fc5d4a1d..3e0216bc60 100644 --- a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md +++ b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-ATPTotalTrafficReport to view details about message traffic in your organization. +Use the Get-ATPTotalTrafficReport to view details about message traffic in your Microsoft Defender for Office 365 organization. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). diff --git a/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md index 7224277e4f..26f84fbc5f 100644 --- a/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md +++ b/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-AccessToCustomerDataRequest cmdlet to view Microsoft 365 customer lockbox requests that control access to your data by Microsoft support engineers. -Note: Customer lockbox is included in the Microsoft 365 E5 plan. If you don't have a Microsoft 365 E5 plan, you can buy a separate customer lockbox subscription with any Microsoft 365 Enterprise plan. +**Note**: Customer lockbox is included in the Microsoft 365 E5 plan. If you don't have a Microsoft 365 E5 plan, you can buy a separate customer lockbox subscription with any Microsoft 365 Enterprise plan. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md index 88ae4bddab..56ce49d502 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ActiveSyncDevice cmdlet to retrieve the list of devices in your organization that have active Exchange ActiveSync partnerships. -Note: In Exchange 2013 or later, use the Get-MobileDevice cmdlet instead. If you have scripts that use Get-ActiveSyncDevice, update them to use Get-MobileDevice. +**Note**: In Exchange 2013 or later, use the Get-MobileDevice cmdlet instead. If you have scripts that use Get-ActiveSyncDevice, update them to use Get-MobileDevice. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -240,7 +240,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md index 6b3c81f95b..7f0f342f42 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceClass.md @@ -123,7 +123,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md index 63439a6f08..e28d37d784 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md @@ -58,7 +58,8 @@ This example retrieves the statistics for the mobile phone configured to synchro ### Example 2 ```powershell -$UserList = Get-CASMailbox -Filter "HasActiveSyncDevicePartnership -eq `$true -and -not DisplayName -like 'CAS_{*'"; Get-Mailbox $UserList | foreach {Get-ActiveSyncDeviceStatistics -Mailbox $_} +$UserList = Get-CASMailbox -Filter "HasActiveSyncDevicePartnership -eq `$true -and -not DisplayName -like 'CAS_{*'" +Get-Mailbox $UserList | foreach {Get-ActiveSyncDeviceStatistics -Mailbox $_} ``` This example uses the Get-CASMailbox cmdlet to determine who in the organization has an Exchange ActiveSync mobile device. For each mobile device, the Exchange ActiveSync device statistics are retrieved. diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md index d169b2cb58..b3b6c55a67 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ActiveSyncMailboxPolicy cmdlet to retrieve the Mobile Device mailbox policy settings for a specific Mobile Device mailbox policy. -Note: In Exchange 2013 or later, use the Get-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Get-ActiveSyncMailboxPolicy, update them to use Get-MobileDeviceMailboxPolicy. +**Note**: In Exchange 2013 or later, use the Get-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Get-ActiveSyncMailboxPolicy, update them to use Get-MobileDeviceMailboxPolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md index cb7b8bc6bc..dc9a7f88cb 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncVirtualDirectory.md @@ -71,11 +71,11 @@ This example returns a summary list of all Exchange ActiveSync virtual directori ### -Identity The Identity parameter specifies the ActiveSync virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. You can't use the Identity and Server parameters in the same command. diff --git a/exchange/exchange-ps/exchange/Get-AddressList.md b/exchange/exchange-ps/exchange/Get-AddressList.md index 33b9dd2f29..1856f28533 100644 --- a/exchange/exchange-ps/exchange/Get-AddressList.md +++ b/exchange/exchange-ps/exchange/Get-AddressList.md @@ -72,7 +72,7 @@ The Identity parameter specifies the address list that you want to view. You can - Name - Distinguished name (DN) - GUID -- Path: (\\\) or [\\\\) +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) You can't use this parameter with the Container or SearchText parameters. @@ -95,7 +95,7 @@ The Container parameter filters the results based on the location of the address - Name - Distinguished name (DN) - GUID -- Path: (\\\) or [\\\\) +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) You can't use this parameter with the Identity or SearchText parameters. diff --git a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md b/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md index afee0cb527..0def252c2e 100644 --- a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md +++ b/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-AdministrativeUnit cmdlet to view administrative units, which are Azure Active Directory containers of resources. You can use administrative units to delegate administrative permissions and apply policies to different groups of users. -Note: Administrative units are only available in Azure Active Directory Premium. You create and manage administrative units in Azure AD PowerShell. +**Note**: Administrative units are only available in Azure Active Directory Premium. You create and manage administrative units in Azure AD PowerShell. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). diff --git a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentDetail.md b/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentDetail.md index ce8ceffc6c..41cbf27a66 100644 --- a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentDetail.md +++ b/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentDetail.md @@ -12,7 +12,9 @@ ms.reviewer: # Get-AdvancedThreatProtectionDocumentDetail ## SYNOPSIS -This cmdlet is available only in the cloud-based service. Use the Get-AdvancedThreatProtectionDocumentDetailReport cmdlet to view the results of Office 365 Advanced Threat Protection (ATP) actions for files in SharePoint Online, OneDrive for Business and Microsoft Teams in your cloud-based organization. +This cmdlet is available only in the cloud-based service. + +Use the Get-AdvancedThreatProtectionDocumentDetailReport cmdlet to view the detailed results of Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in your Microsoft Defender for Office 365 organization. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -47,7 +49,7 @@ For the reporting period and organization you specify, the cmdlet returns the fo - Timestamp - Workload -For more information about this feature, see [ATP for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). +For more information about this feature, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -58,7 +60,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Get-AdvancedThreatProtectionDocumentDetail -Organization contoso.com -StartDate "4/26/2016" -EndDate "4/28/2016" | Format-Table ``` -This example returns the detailed report of ATP detections during the specified date range. +This example returns the detailed report of detections during the specified date range. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentReport.md b/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentReport.md index bee95f5fb4..ccf075490a 100644 --- a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentReport.md +++ b/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentReport.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-AdvancedThreatProtectionDocumentReport cmdlet to view the results of Office 365 Advanced Threat Protection (ATP) actions for files in SharePoint Online, OneDrive for Business and Microsoft Teams in your cloud-based organization. +Use the Get-AdvancedThreatProtectionDocumentReport cmdlet to view the results of Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in your Microsoft Defender for Office 365 organization. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -38,7 +38,7 @@ Get-AdvancedThreatProtectionDocumentReport ``` ## DESCRIPTION -For more information about this feature, see [ATP for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). +For more information about this feature, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). For the reporting period and organization you specify, the cmdlet returns the following information: @@ -58,7 +58,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Get-AdvancedThreatProtectionTrafficReport -Organization contoso.com -StartDate "4/26/2018" -EndDate "4/28/2018" | Format-Table ``` -This example returns the aggregated report of ATP detections for the specified organization during the specified date range. +This example returns the aggregated report of detections for the specified organization during the specified date range. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionTrafficReport.md b/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionTrafficReport.md index a33665bf16..4163f5dd62 100644 --- a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionTrafficReport.md +++ b/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionTrafficReport.md @@ -40,9 +40,9 @@ Get-AdvancedThreatProtectionTrafficReport [-Action ] ``` ## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. For the reporting period you specify, the cmdlet returns the following information: diff --git a/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md index a1a90b5847..f1cc767ece 100644 --- a/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md @@ -79,7 +79,7 @@ The Advanced switch filters the properties that are returned to the advanced set You don't need to specify a value with this switch. -Advanced settings are only available in ATP anti-phishing policies. +Advanced settings are only available in anti-phishing policies in Microsoft Defender for Office 365. ```yaml Type: SwitchParameter @@ -119,7 +119,7 @@ The Impersonation switch filters the properties that are returned to the imperso You don't need to specify a value with this switch. -Impersonation settings are only available in ATP anti-phishing policies. +Impersonation settings are only available in anti-phishing policies in Microsoft Defender for Office 365. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md index 7fecde3779..daa0136fe7 100644 --- a/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md +++ b/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-AtpPolicyForO365 cmdlet to view the Advanced Threat Protection (ATP) policy in Office 365. The ATP policy enables the following protections: +Use the Get-AtpPolicyForO365 cmdlet to view the settings for the following features in Microsoft Defender for Office 365: -- Safe Links for Office 365 ProPlus desktop clients and Office Mobile apps. -- Safe Documents: Before a user is allowed to trust a file open in Office 365 ProPlus, the file will be verified by Microsoft Defender ATP. -- ATP to protect files in SharePoint Online, OneDrive for Business and Microsoft Teams. +- Safe Links protection for supported Office 365 apps. +- Safe Documents: Uses Microsoft Defender for Endpoint to scan documents and files that are opened in Protected View in Microsoft 365 apps for enterprise. +- Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -32,9 +32,11 @@ Get-AtpPolicyForO365 [[-Identity] ] ``` ## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. For more information, see [Office 365 ATP Safe Links](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links). +Safe Links protection for Office 365 apps checks links in Office documents, not links in email messages. For more information, see [Safe Links settings for Office 365 apps](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#safe-links-settings-for-office-365-apps). -ATP can also protect files in SharePoint Online, OneDrive for Business and Microsoft Teams by preventing users from opening and downloading files that are identified as malicious. For more information, see [ATP for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). +Safe Documents scans documents and files that are opened in Protected View. For more information, see [Safe Documents in Microsoft 365 E5](https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-docs). + +Safe Attachments for SharePoint, OneDrive, and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -45,12 +47,12 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Get-AtpPolicyForO365 ``` -This example returns detailed information about the ATP policy named Default +This example returns detailed information about the default policy. ## PARAMETERS ### -Identity -The Identity parameter specifies the ATP policy that you want to modify. There's only one policy named Default. +The Identity parameter specifies the policy that you want to modify. There's only one policy named Default. ```yaml Type: AtpPolicyForO365IdParameter diff --git a/exchange/exchange-ps/exchange/Get-AuthRedirect.md b/exchange/exchange-ps/exchange/Get-AuthRedirect.md index b548558662..6d6c37726b 100644 --- a/exchange/exchange-ps/exchange/Get-AuthRedirect.md +++ b/exchange/exchange-ps/exchange/Get-AuthRedirect.md @@ -50,7 +50,7 @@ This example shows detailed information about the OAuth redirection object named ## PARAMETERS ### -Identity -The Identity parameter specifies the existing OAuth redirection object that you want to view. The object name uses the syntax AuthRedirect-Bearer-\. +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 diff --git a/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md index 0085a06ebb..08d59c541b 100644 --- a/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md @@ -69,11 +69,11 @@ This example returns a summary list of all Autodiscover virtual directories in t ### -Identity The Identity parameter specifies the Autodiscover virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. You can't use the Identity and Server parameters in the same command. diff --git a/exchange/exchange-ps/exchange/Get-CASMailbox.md b/exchange/exchange-ps/exchange/Get-CASMailbox.md index cd170dad5d..8ff9b9c5df 100644 --- a/exchange/exchange-ps/exchange/Get-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Get-CASMailbox.md @@ -96,7 +96,6 @@ Get-CASMailbox chris@contoso.com | Format-List Ews* This example returns all Exchange Web Services settings for the user chris@contoso.com. - ### Example 4 ```powershell Get-CASMailbox -RecipientTypeDetails SharedMailbox | Select * @@ -439,7 +438,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md b/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md index 438ed5f15e..df57a7dff6 100644 --- a/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md +++ b/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md @@ -62,7 +62,7 @@ The Identity parameter specifies the CAS mailbox plan that you want to view. You - Distinguished name (DN) - GUID -The display name and name of the CAS mailbox plan is the same as the corresponding mailbox plan (for example, ExchangeOnlineEnterprise and ExchangeOnlineEnterprise-\). +The display name and name of the CAS mailbox plan is the same as the corresponding mailbox plan (for example, ExchangeOnlineEnterprise and `ExchangeOnlineEnterprise-GUID`). ```yaml Type: MailboxPlanIdParameter @@ -155,7 +155,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following attributes: diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md index 646151f70c..0f9f46fb28 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md @@ -65,7 +65,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$logs = Get-CalendarDiagnosticLog -Identity oevans -MeetingID 040000008200E00074C5B7101A82E008000000009421DCCD5046CD0100000000000000001000000010B0349F6B17454685E17D9F9512E71F; Get-CalendarDiagnosticAnalysis -CalendarLogs $logs -DetailLevel Advanced | Set-Content -Path "C:\My Documents\Oscar Evans Analysis.csv" +$logs = Get-CalendarDiagnosticLog -Identity oevans -MeetingID 040000008200E00074C5B7101A82E008000000009421DCCD5046CD0100000000000000001000000010B0349F6B17454685E17D9F9512E71F +Get-CalendarDiagnosticAnalysis -CalendarLogs $logs -DetailLevel Advanced | Set-Content -Path "C:\My Documents\Oscar Evans Analysis.csv" ``` This example gets the specified calendar item from Oscar Evans' mailbox, stores the item as a variable and writes the advanced analysis of the item to a CSV file. @@ -106,7 +107,7 @@ Accept wildcard characters: False ``` ### -LogLocation -The LogLocation parameter specifies the location of the exported calendar items that you want to analyze. You can specify a local path, or a UNC path (`\\\\`). If the value contains spaces, enclose the value in quotation marks ("). +The LogLocation parameter specifies the location of the exported calendar items that you want to analyze. You can specify a local path, or a UNC path (`\\Server\Share\User`). If the value contains spaces, enclose the value in quotation marks ("). You export the calendar items to .msg files by using the Get-CalendarDiagnosticLog cmdlet with the LogLocation parameter. If the path contains multiple .msg files, all of those files are analyzed when you run Get-CalendarDiagnosticAnalysis. diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md index 8d0a5cbdac..7bf56a2b92 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md @@ -104,7 +104,7 @@ Get-CalendarDiagnosticLog -Identity "Jasen Kozma" -Subject "Budget Meeting" -Exa This example exports all calendar items in the Calendar Diagnostic log for Jasen Kozma's mailbox that have "Budget Meeting" anywhere in the subject to the specified folder. -Notes: +**Notes**: - In this example, the message files are written to C:\\My Documents\\Calendar Diagnostic Export\\jkozma@contoso.com. - In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet with the LogLocation parameter to analyze the exported .msg files. @@ -139,13 +139,13 @@ Accept wildcard characters: False ``` ### -LogLocation -The LogLocation parameter specifies the location to export the calendar items to .msg files. You can specify a local path, or a UNC path (`\\\`). If the value contains spaces, enclose the value in quotation marks ("). +The LogLocation parameter specifies the location to export the calendar items to .msg files. You can specify a local path, or a UNC path (`\\Server\Share`). If the value contains spaces, enclose the value in quotation marks ("). In the location you specify, a subfolder is automatically created for the specified mailbox that holds the exported calendar items. For example, if you specify the value "C:\\My Documents\\Calendar Export" to export calendar items from the mailbox of Shannon Steele, the .msg files are actually stored in C:\\My Documents\\Calendar Export\\ssteele@contoso.com. In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet with the LogLocation parameter to analyze the exported .msg files. -Note: Commands that use this parameter might fail if the calendar item doesn't have a title. If you receive errors when you use this parameter, run the command again and replace this parameter with redirection to a file (| Set-Content -Path "C:\\My Documents\\Calendar Export") or substitute the output to a PowerShell variable. +**Note**: Commands that use this parameter might fail if the calendar item doesn't have a title. If you receive errors when you use this parameter, run the command again and replace this parameter with redirection to a file (| Set-Content -Path "C:\\My Documents\\Calendar Export") or substitute the output to a PowerShell variable. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md index 5629c0948c..1c6e840047 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md @@ -49,11 +49,11 @@ Some of the more interesting properties that are returned in the results are: - AppointmentState: 1 = The appointment is a meeting, 2 = The appointment has been received, 4 = The appointment has been cancelled, and 8 = the appointment is a forwarded appointment. - CalendarLogTriggerAction: The action that's taken on the item (for example, Create or Update). -- ClientInfoString: The entity that made the change (for example, Client=OWA;\, Client=WebServices;\;, or Client=TBA;Service=MSExchangeMailboxAssistants;Action=ELCAssistant;). +- ClientInfoString: The entity that made the change (for example, `Client=OWA;`, `Client=WebServices;`;, or `Client=TBA;Service=MSExchangeMailboxAssistants;Action=ELCAssistant;`). - MeetingRequestType: 1 = The meeting message is a meeting request, 65536 = The meeting message is a full update to an existing meeting, 131072 = The meeting message is an informational update to an existing meeting, 262144 = The meeting message is a silent update, 524288 = The update is outdated, or 1048576 = The meeting message is forwarded to a delegate, and the copy is marked as informational. - OriginalLastModifiedTime: Used as the primary sort field to order the events. - ResponseType: 0 = The organizer hasn't received a response, 1 = The organizer's copy of the meeting, 2 = Tentative, 3 = Accept, 4 = Decline, or 5 = The attendee hasn't responded. -- ResponsibleUserName: The LegacyExchangeDN value of the user who made the change (for example, /o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=BN6PR11MB1587/cn=Microsoft System Attendant or /o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=696eea97d3c449eab648920d03385efb-admin). +- ResponsibleUserName: The LegacyExchangeDN value of the user who made the change (for example, `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=BN6PR11MB1587/cn=Microsoft System Attendant` or `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=696eea97d3c449eab648920d03385efb-admin`). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -68,7 +68,9 @@ This example retrieves the calendar diagnostic logs from Pedro Pizarro's mailbox ### Example 2 ```powershell -$A = Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -Subject "Team Meeting" -ExactMatch $true; $A | Select-Object *,@{n='OLMT'; e={[DateTime]::Parse($_.OriginalLastModifiedTime.ToString())}} | sort OLMT | Format-Table OriginalLastModifiedTime,CalendarLogTriggerAction,ItemClass,ClientInfoString +$A = Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -Subject "Team Meeting" -ExactMatch $true +$A | Select-Object *,@{n='OLMT' +e={[DateTime]::Parse($_.OriginalLastModifiedTime.ToString())}} | sort OLMT | Format-Table OriginalLastModifiedTime,CalendarLogTriggerAction,ItemClass,ClientInfoString ``` This is the same as the previous example, but now the results are sorted by original last modified time. @@ -133,7 +135,9 @@ Accept wildcard characters: False ``` ### -CustomPropertyNames -The CustomPropertyNames parameter returns the specified calendar item custom property in the results. You can specify multiple values separated by commas. +The CustomPropertyNames parameter returns the specified calendar item custom property in the results. For valid values, see [Values for the CustomPropertyNames parameter in Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/values-for-custompropertynames-parameter). + +You can specify multiple values separated by commas. ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessServer.md b/exchange/exchange-ps/exchange/Get-ClientAccessServer.md index bfad50ff14..8cd3a11d74 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessServer.md +++ b/exchange/exchange-ps/exchange/Get-ClientAccessServer.md @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ClientAccessServer cmdlet to view settings that are associated with the Client Access server role. -Note: In Exchange 2013 or later, use the Get-ClientAccessService cmdlet instead. If you have scripts that use Get-ClientAccessServer, update them to use Get-ClientAccessService. +**Note**: In Exchange 2013 or later, use the Get-ClientAccessService cmdlet instead. If you have scripts that use Get-ClientAccessServer, update them to use Get-ClientAccessService. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -74,7 +74,6 @@ Accept pipeline input: True Accept wildcard characters: False ``` - ### -DomainController The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -94,7 +93,7 @@ Accept wildcard characters: False ### -IncludeAlternateServiceAccountCredentialPassword The IncludeAlternateServiceAccountCredentialPassword switch specifies whether to include the password of the alternate service account in the results. You don't need to specify a value with this switch. -The password is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, Get-ClientAccessServer \ | Format-List AlternateServiceAccountConfiguration. +The password is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessServer | Format-List AlternateServiceAccountConfiguration`. ```yaml Type: SwitchParameter @@ -112,7 +111,7 @@ Accept wildcard characters: False ### -IncludeAlternateServiceAccountCredentialStatus The IncludeAlternateServiceAccountCredentialStatus parameter specifies whether to include the status of the alternate service account in the results. You don't need to specify a value with this switch. -The status is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, Get-ClientAccessServer \ | Format-List AlternateServiceAccountConfiguration. +The status is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessServer | Format-List AlternateServiceAccountConfiguration`. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessService.md b/exchange/exchange-ps/exchange/Get-ClientAccessService.md index 4fea5cb13a..9c186f6b5b 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessService.md +++ b/exchange/exchange-ps/exchange/Get-ClientAccessService.md @@ -91,7 +91,7 @@ Accept wildcard characters: False ### -IncludeAlternateServiceAccountCredentialPassword The IncludeAlternateServiceAccountCredentialPassword switch specifies whether to include the password of the alternate service account in the results. You don't need to specify a value with this switch. -The password is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, Get-ClientAccessService \ | Format-List AlternateServiceAccountConfiguration. +The password is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessService | Format-List AlternateServiceAccountConfiguration`. ```yaml Type: SwitchParameter @@ -109,7 +109,7 @@ Accept wildcard characters: False ### -IncludeAlternateServiceAccountCredentialStatus The IncludeAlternateServiceAccountCredentialStatus parameter specifies whether to include the status of the alternate service account in the results. You don't need to specify a value with this switch. -The status is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, Get-ClientAccessService \ | Format-List AlternateServiceAccountConfiguration. +The status is visible in the AlternateServiceAccountConfiguration property. To see this property, use the Format-List cmdlet. For example, `Get-ClientAccessService | Format-List AlternateServiceAccountConfiguration`. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/Get-ComplianceCase.md b/exchange/exchange-ps/exchange/Get-ComplianceCase.md index 2a25a6b880..9bca85a790 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceCase.md @@ -48,7 +48,6 @@ Get-ComplianceCase -Identity "Contoso Legal" | Format-List This example returns detailed information for the core eDiscovery case named Contoso Legal. - ### Example 3 ```powershell Get-ComplianceCase -CaseType AdvancedEdiscovery @@ -87,14 +86,14 @@ Accept wildcard characters: False ### -CaseType The CaseType parameter specifies the type of compliance case that you want to view. Valid values are: -- AdvancedEdiscovery: Advanced eDiscovery cases are used to manage legal or other types of investigations. In the Security & Compliance Center, Advanced eDiscovery cases are displayed under eDiscovery \> Advanced eDiscovery. -- ComplianceClassifier: This type of case corresponds to a trainable classifier. In the Microsoft 365 compliance center, trainable classifiers are displayed under Data classification \> Trainable classifiers. +- AdvancedEdiscovery: Advanced eDiscovery cases are used to manage legal or other types of investigations. In the Security & Compliance Center, Advanced eDiscovery cases are displayed under **eDiscovery** \> **Advanced eDiscovery**. +- ComplianceClassifier: This type of case corresponds to a trainable classifier. In the Microsoft 365 compliance center, trainable classifiers are displayed under **Data classification** \> **Trainable classifiers**. - ComplianceWorkspace: This value is reserved for internal Microsoft use.- DataInvestigation: Data investigation cases are used to investigate data spillage incidents. In the Security & Compliance Center, Data investigation cases are displayed on the Data investigations page. -- DSR: Data Subject Request (DSR) cases are used to manage General Data Protection Regulation (GDPR) DSR investigations. In the Security & Compliance Center, DSR cases are displayed under Data privacy \> Data subject requests. -- eDiscovery: eDiscovery (also called core eDiscovery) cases are used to manage legal or other types of investigations. In the Security & Compliance Center, core eDiscovery cases are displayed under eDiscovery \> eDiscovery. This is the default value. -- InsiderRisk: Insider risk cases are use to manage insider risk management cases. In the Microsoft 365 compliance center, insider risk cases are displayed under Insider risk management \> Cases. Typically, insider risk management cases are manually created in the compliance center to further investigate activity based on an risk alert. +- DSR: Data Subject Request (DSR) cases are used to manage General Data Protection Regulation (GDPR) DSR investigations. In the Security & Compliance Center, DSR cases are displayed under **Data privacy** \> **Data subject requests**. +- eDiscovery: eDiscovery (also called core eDiscovery) cases are used to manage legal or other types of investigations. In the Security & Compliance Center, core eDiscovery cases are displayed under **eDiscovery** \> **eDiscovery**. This is the default value. +- InsiderRisk: Insider risk cases are use to manage insider risk management cases. In the Microsoft 365 compliance center, insider risk cases are displayed under **Insider risk management** \> **Cases**. Typically, insider risk management cases are manually created in the compliance center to further investigate activity based on an risk alert. - InternalInvestigation: This value is reserved for internal Microsoft use. -- SupervisionPolicy: This type of case corresponds to communication compliance policy. In the Microsoft 365 Compliance center, communication compliance policies are displayed under Communication compliance \> Policies. +- SupervisionPolicy: This type of case corresponds to communication compliance policy. In the Microsoft 365 Compliance center, communication compliance policies are displayed under **Communication compliance** \> **Policies**. ```yaml Type: ComplianceCaseType diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md index bb0fa4595a..9e9c974dba 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md @@ -84,7 +84,7 @@ This example shows a summary list of all compliance search actions. ### Example 2 ```powershell -Get-ComplianceSearchAction -Identity "Case 1234_Preview" | Format-List +Get-ComplianceSearchAction -Identity "Case 1234\_Preview" | Format-List ``` This example shows details about the compliance search action named "Case 1234\_Preview" @@ -94,7 +94,7 @@ This example shows details about the compliance search action named "Case 1234\_ ### -Identity The Identity parameter specifies the compliance search action that you want to view. You can use any value that uniquely identifies the compliance search action. For example: -- Name: The compliance search action name uses the syntax \\_\ . For example, Case 1234\_Preview. +- Name: The compliance search action name uses the syntax `"Compliance Search Name\_Action"`. For example, `"Case 1234\_Preview"`. - JobRunId (GUID) ```yaml @@ -110,7 +110,6 @@ Accept pipeline input: True Accept wildcard characters: False ``` - ### -Case This parameter is reserved for internal Microsoft use. diff --git a/exchange/exchange-ps/exchange/Get-ConnectionByClientTypeReport.md b/exchange/exchange-ps/exchange/Get-ConnectionByClientTypeReport.md index cbc86c315f..28d7bba3bf 100644 --- a/exchange/exchange-ps/exchange/Get-ConnectionByClientTypeReport.md +++ b/exchange/exchange-ps/exchange/Get-ConnectionByClientTypeReport.md @@ -33,7 +33,7 @@ Get-ConnectionByClientTypeReport [-EndDate ] ``` ## DESCRIPTION -Note: There's a 7-day lag in the client connection information that's returned by this cmdlet. For example, if you run the cmdlet on June 18, 2018, you can't retrieve information about connections made to mailboxes between June 13, 2018 and June 15, 2018. To get connection information for that date range, you need to run the cmdlet on June 22, 2018 or later. +**Note**: There's a 7-day lag in the client connection information that's returned by this cmdlet. For example, if you run the cmdlet on June 18, 2018, you can't retrieve information about connections made to mailboxes between June 13, 2018 and June 15, 2018. To get connection information for that date range, you need to run the cmdlet on June 22, 2018 or later. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Get-Contact.md b/exchange/exchange-ps/exchange/Get-Contact.md index 83d2816255..54a63a0915 100644 --- a/exchange/exchange-ps/exchange/Get-Contact.md +++ b/exchange/exchange-ps/exchange/Get-Contact.md @@ -289,7 +289,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md index 7a452bb8d0..5ac62eec2f 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md @@ -88,7 +88,7 @@ Accept wildcard characters: False ``` ### -Identity -The Identity parameter specifies the mobile device conditional access rule that you want to view. The name of the rule uses the syntax \{\}. For example, Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}. +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 diff --git a/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md index 6f117fcc3e..bb044bd738 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md @@ -88,7 +88,7 @@ Accept wildcard characters: False ``` ### -Identity -The Identity parameter specifies the mobile device configuration rule that you want to view. The name of the rule uses the syntax \{\}. For example, Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}. +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 diff --git a/exchange/exchange-ps/exchange/Get-DistributionGroup.md b/exchange/exchange-ps/exchange/Get-DistributionGroup.md index 287984819d..6252511658 100644 --- a/exchange/exchange-ps/exchange/Get-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Get-DistributionGroup.md @@ -325,7 +325,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md index 1a2144b771..de09af1d64 100644 --- a/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md @@ -46,7 +46,8 @@ This example returns the existing distribution group members for the distributio ### Example 2 ```powershell -Set-ADServerSettings -ViewEntireForest $true; Get-DistributionGroupMember -Identity "Marketing Worldwide" +Set-ADServerSettings -ViewEntireForest $true +Get-DistributionGroupMember -Identity "Marketing Worldwide" ``` This example sets the scope of the search to the entire forest by running the Set-ADServerSettings cmdlet, then the Get-DistributionGroupMember cmdlet searches the entire forest for the distribution group members in the Marketing Worldwide distribution group. diff --git a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md index 0c8b7c3e3d..72263c42fd 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md @@ -97,7 +97,7 @@ Accept wildcard characters: False ### -Actor The Actor parameter filters the report by the user who last modified the item. You can enter multiple users separated by commas. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -115,7 +115,7 @@ Accept wildcard characters: False ### -DlpCompliancePolicy The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -133,7 +133,7 @@ Accept wildcard characters: False ### -DlpComplianceRule The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md index d164ab3d29..bd6785c8e9 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md @@ -106,7 +106,7 @@ Accept wildcard characters: False ### -DlpCompliancePolicy The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -124,7 +124,7 @@ Accept wildcard characters: False ### -DlpComplianceRule The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md index b7d37ac37c..74f62dfb1e 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md @@ -33,10 +33,10 @@ For the reporting period you specify, the cmdlet returns the following informati - Organization - Date -- SensitiveType: The GUID value of the DLP sensitive information type. To match the GUID value to the name of the sensitive information type, replace \ with the GUID value and run this command: Get-DlpSensitiveInformationType -Identity \. +- SensitiveType: The GUID value of the DLP sensitive information type. To match the GUID value to the name of the sensitive information type, replace `` with the GUID value and run this command: `Get-DlpSensitiveInformationType -Identity `. - DocumentCount: The number of documents that contain the detected sensitive information type. - ProtectionStatus: Values are Unprotected (the sensitive information type is not defined in any DLP policy) or Protected (the sensitive information type is defined in a DLP policy). -- DlpComplianceRuleIds: The GUID value of the DLP compliance rule that detected the sensitive information type (for ProtectionStatus values of Protected). To match the GUID value to the name of the DLP compliance rule, replace \ with the GUID value and run this command: Get-DlpComplianceRule -Identity \. +- DlpComplianceRuleIds: The GUID value of the DLP compliance rule that detected the sensitive information type (for ProtectionStatus values of Protected). To match the GUID value to the name of the DLP compliance rule, replace `` with the GUID value and run this command: `Get-DlpComplianceRule -Identity `. You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). @@ -79,7 +79,7 @@ Accept wildcard characters: False ### -SensitiveType The SensitiveType parameter filters the results by the specified sensitive information type. A valid value is the GUID of the sensitive information type (for example, 0e9b3178-9678-47dd-a509-37222ca96b42). To find the GUID value of a sensitive information type, run this command: Get-DlpSensitiveInformationType. -You can enter multiple values separated by commas: "\","\"..."\". +You can enter multiple values separated by commas: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-DomainController.md b/exchange/exchange-ps/exchange/Get-DomainController.md index e458ee3919..3f64b84c78 100644 --- a/exchange/exchange-ps/exchange/Get-DomainController.md +++ b/exchange/exchange-ps/exchange/Get-DomainController.md @@ -45,7 +45,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$UserCredentials = Get-Credential; Get-DomainController -DomainName corp.contoso.com -Credential $UserCredentials | Format-Table -AutoSize Name, ADSite +$UserCredentials = Get-Credential +Get-DomainController -DomainName corp.contoso.com -Credential $UserCredentials | Format-Table -AutoSize Name,ADSite ``` This example retrieves a list of global catalog servers in the corp.contoso.com domain. Because a different set of credentials are required to access this domain, the Get-Credential cmdlet is used to obtain the username and password from the user. diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md index 556b100954..e35549921e 100644 --- a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md @@ -95,7 +95,8 @@ This example returns all dynamic distribution groups whose names contain the str ### Example 4 ```powershell -$FTE = Get-DynamicDistributionGroup "Full Time Employees"; Get-Recipient -RecipientPreviewFilter $FTE.RecipientFilter -OrganizationalUnit $FTE.RecipientContainer +$FTE = Get-DynamicDistributionGroup "Full Time Employees" +Get-Recipient -RecipientPreviewFilter $FTE.RecipientFilter -OrganizationalUnit $FTE.RecipientContainer ``` This example returns the members for the dynamic distribution group named Full Time Employees. The first command stores the dynamic distribution group object in the variable $FTE. The second command uses the Get-Recipient cmdlet to list the recipients that match the criteria defined for the dynamic distribution group. @@ -332,7 +333,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md b/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md index e4020aedae..81accc830e 100644 --- a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md +++ b/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md @@ -435,7 +435,6 @@ The following Get-CasMailbox parameters are not available or supported in Get-EX - ReadIsOptimizedForAccessibility - SortBy - ## OUTPUTS ### diff --git a/exchange/exchange-ps/exchange/Get-EXOMailbox.md b/exchange/exchange-ps/exchange/Get-EXOMailbox.md index 0eb449508b..ff7a78a2e5 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailbox.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailbox.md @@ -539,7 +539,6 @@ The following Get-Mailbox parameters aren't available or functional in Get-EXOMa - PublicFolder - SortBy - ## OUTPUTS ### diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md b/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md index 01a573b921..1e0e513e2a 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md @@ -193,6 +193,8 @@ The user that you specify for this parameter must be a user or security group (a - Canonical DN - GUID +**Note**: Currently, the value that you provide for this parameter is case sensitive. + ```yaml Type: String Parameter Sets: Identity diff --git a/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md index cee2012725..1de4dd43f6 100644 --- a/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md @@ -71,11 +71,11 @@ This example returns a summary list of all Exchange Control Panel virtual direct ### -Identity The Identity parameter specifies the ECP virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. You can't use the Identity and Server parameters in the same command. diff --git a/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md index db7b4ad3a9..76d37cbbc9 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md @@ -50,12 +50,12 @@ Get-ExchangeCertificate [[-Thumbprint] ] By default, this cmdlet returns the following certificate properties in the summary list view: - Thumbprint: The unique digest of the certificate data. An example thumbprint value is 78E1BE82F683EE6D8CB9B9266FC1185AE0890C41. -- Services: The Exchange services that the certificate is assigned to by using the Enable-ExchangeCertificate cmdlet. Values are None, Federation, IIS, IMAP, POP, SMTP, UM, and UMCallRouter. You'll see the value None in certificates that aren't used with Exchange (for example, the WMSvc-\ certificate that's used for the IIS Web Management Service). +- Services: The Exchange services that the certificate is assigned to by using the Enable-ExchangeCertificate cmdlet. Values are None, Federation, IIS, IMAP, POP, SMTP, UM, and UMCallRouter. You'll see the value None in certificates that aren't used with Exchange (for example, the `WMSvc-` certificate that's used for the IIS Web Management Service). - Subject: Contains the X.500 value in the certificate's Subject Name field. The important part is the CN= value. -If you append | Format-List to the command, the cmdlet returns these additional certificate properties: +If you append ` | Format-List` to the command, the cmdlet returns these additional certificate properties: -- AccessRules: The host names or FQDNs in the certificate's Subject Alternative Name field. +- AccessRules: Typically, this value is multiple instances of the value System.Security.AccessControl.CryptoKeyAccessRule separated by commas. - CertificateDomains: The host names or FQDNs in the certificate's Subject Alternative Name field. - HasPrivateKey: Whether or not the certificate contains a private key. - IsSelfSigned: Whether or not the certificate is self-signed (not issued by a certification authority). @@ -67,7 +67,7 @@ If you append | Format-List to the command, the cmdlet returns these additional - SerialNumber: The unique serial number of the certificate. - Status: The status of the certificate. Values are DateInvalid, Invalid, PendingRequest, RevocationCheckFailure, Revoked, Unknown, Untrusted or Valid -If you append | Format-List \* to the command, the cmdlet returns these additional certificate properties: +If you append ` | Format-List *` to the command, the cmdlet returns these additional certificate properties: - Archived - CertificateRequest: This property contains the hash value of the certificate request. @@ -76,7 +76,7 @@ If you append | Format-List \* to the command, the cmdlet returns these addition - Extensions - FriendlyName - Handle -- Identity: This value is \\\\ +- Identity: This value uses the syntax ServerFQDN\\Thumbprint. - IISServices - IssuerName: Typically, this value is System.Security.Cryptography.X509Certificates.X500DistinguishedName. - KeyIdentifier @@ -88,7 +88,7 @@ If you append | Format-List \* to the command, the cmdlet returns these addition - ServicesStringForm - SignatureAlgorithm: Typically, this value is System.Security.Cryptography.Oid. - SubjectKeyIdentifier -- SubjectName: Typically, this value is System.Security.Cryptography.X509Certificates.X500DistinguishedName . +- SubjectName: Typically, this value is System.Security.Cryptography.X509Certificates.X500DistinguishedName. - Version: Typically, this value is 3. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -125,29 +125,54 @@ This example shows which certificate Exchange will select for the domain name ma ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Thumbprint +The Thumbprint parameter specifies the thumbprint value of the certificate that you want to view. -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: String +Parameter Sets: Thumbprint Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter specifies the certificate that you want to view. Valid values are: + +- `ServerNameOrFQDN\Thumbprint` +- `Thumbprint` + +You can't use this parameter with the Server parameter. + +The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. + +```yaml +Type: ExchangeCertificateIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainName -The DomainName parameter filters the results by the fully qualified domain name (FQDN) or server name values in the Subject Name or the Subject Alternative Name fields. You can specify multiple values separated by commas. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: MultiValuedProperty +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -159,24 +184,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the certificate that you want to view. Valid values are: - -- \\\\ -- \ - -You can't use this parameter with the Server parameter. - -The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. +### -DomainName +The DomainName parameter filters the results by the fully qualified domain name (FQDN) or server name values in the Subject Name or the Subject Alternative Name fields. You can specify multiple values separated by commas. ```yaml -Type: ExchangeCertificateIdParameter -Parameter Sets: Identity +Type: MultiValuedProperty +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -223,24 +241,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Thumbprint -The Thumbprint parameter specifies the thumbprint value of the certificate that you want to view. - -The Thumbprint parameter, not the Identity parameter, is the positional parameter for this cmdlet. Therefore, when you specify a thumbprint value by itself, the command uses that value for the Thumbprint parameter. - -```yaml -Type: String -Parameter Sets: Thumbprint -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). diff --git a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md b/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md index 879dde059e..cf23c30776 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md @@ -42,7 +42,8 @@ This example returns a summary list of all Exchange processes that are running o ### Example 2 ```powershell -[xml]$edi = Get-ExchangeDiagnosticInfo; $edi.Diagnostics.Processlocator.Process | Format-Table -Auto Name,ID,Guid +[xml]$edi = Get-ExchangeDiagnosticInfo +$edi.Diagnostics.Processlocator.Process | Format-Table -Auto Name,ID,Guid ``` This example display the XML output of the command in format that's easier to read. @@ -54,7 +55,7 @@ The Argument parameter specifies a valid argument to use with the specified Comp Common Argument values that you can use with virtually Component value are Help and Verbose. -To see the Argument values that are available for a given Component value, run the command Get-ExchangeDiagnosticInfo -Process \ -Component \ -Argument Help +To see the Argument values that are available for a given Component value, run the command `Get-ExchangeDiagnosticInfo -Process ProcessName -Component ComponentName -Argument Help`. ```yaml Type: String @@ -72,7 +73,7 @@ Accept wildcard characters: False ### -Component The Component parameter returns detailed information for the specified Component of the given Process value. -To see the Component values that are available for a given Process value, run the command Get-ExchangeDiagnosticInfo -Process \ -Argument Help. +To see the Component values that are available for a given Process value, run the command `Get-ExchangeDiagnosticInfo -Process ProcessName -Argument Help`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md index f06885099c..718d24c41f 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md @@ -44,12 +44,12 @@ This example returns the unique users for the license named Exchange Server 2016 ### -LicenseName The LicenseName parameter specifies the license type that you want to view. You can find the available license type values by running the Get-ExchangeServerAccessLicense cmdlet. Valid values are: -- Exchange Server \ Standard CAL -- Exchange Server \ Enterprise CAL -- Exchange Server \ Standard Edition -- Exchange Server \ Enterprise Edition +- `Exchange Server Standard CAL` +- `Exchange Server Enterprise CAL` +- `Exchange Server Standard Edition` +- `Exchange Server Enterprise Edition` -The \ value is 2013, 2016, or 2019. +The `` value is 2013, 2016, or 2019. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Get-ExchangeSettings.md b/exchange/exchange-ps/exchange/Get-ExchangeSettings.md index b9af751a01..3e56f03200 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeSettings.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeSettings.md @@ -181,7 +181,7 @@ Accept wildcard characters: False ``` ### -GenericScopes -The GenericScopes parameter filters the results by the scope. The available values are determined by the schema of the Exchange setting object. This parameter uses the syntax "\=\","\=\"... +The GenericScopes parameter filters the results by the scope. The available values are determined by the schema of the Exchange setting object. This parameter uses the syntax `"key1=value1","key2=value2", "keyN=valueN`. ```yaml Type: String[] @@ -286,7 +286,7 @@ Accept wildcard characters: False ``` ### -User -The User parameter filters the results by user. You identify the user by their GUID value (for example, 87246450-1b19-4c81-93dc-1a4200eff66c). To find the GUID for a user, run the following command: Get-User \ | Format-List Name,GUID. +The User parameter filters the results by user. You identify the user by their GUID value (for example, 87246450-1b19-4c81-93dc-1a4200eff66c). To find the GUID for a user, run the following command: `Get-User | Format-List Name,GUID`. ```yaml Type: Guid diff --git a/exchange/exchange-ps/exchange/Get-Group.md b/exchange/exchange-ps/exchange/Get-Group.md index 4683d57083..d28f2598a5 100644 --- a/exchange/exchange-ps/exchange/Get-Group.md +++ b/exchange/exchange-ps/exchange/Get-Group.md @@ -292,7 +292,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md index 6daf2aa46a..ed8130bb45 100644 --- a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md @@ -16,7 +16,7 @@ This cmdlet is available only in Security & Compliance Center PowerShell. For mo Use the Get-HoldCompliancePolicy to view existing preservation policies in the Security & Compliance Center. -Note: The Get-HoldCompliancePolicy cmdlet has been replaced by the Get-RetentionCompliancePolicy cmdlet. If you have scripts that use Get-HoldCompliancePolicy, update them to use Get-RetentionCompliancePolicy. +**Note**: The Get-HoldCompliancePolicy cmdlet has been replaced by the Get-RetentionCompliancePolicy cmdlet. If you have scripts that use Get-HoldCompliancePolicy, update them to use Get-RetentionCompliancePolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md index b872e0782a..c41a80db43 100644 --- a/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md @@ -16,7 +16,7 @@ This cmdlet is available only in Security & Compliance Center PowerShell. For mo Use the Get-HoldComplianceRule to view preservation rules in the Security & Compliance Center. -Note: The Get-HoldComplianceRule cmdlet has been replaced by the Get-RetentionComplianceRule cmdlet. If you have scripts that use Get-HoldComplianceRule, update them to use Get-RetentionComplianceRule. +**Note**: The Get-HoldComplianceRule cmdlet has been replaced by the Get-RetentionComplianceRule cmdlet. If you have scripts that use Get-HoldComplianceRule, update them to use Get-RetentionComplianceRule. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-InboxRule.md b/exchange/exchange-ps/exchange/Get-InboxRule.md index 82a0cd19e9..8920ec2cb7 100644 --- a/exchange/exchange-ps/exchange/Get-InboxRule.md +++ b/exchange/exchange-ps/exchange/Get-InboxRule.md @@ -134,8 +134,8 @@ The Identity parameter specifies the Inbox rule that you want to view. You can u - Name - RuleIdentity property (for example, 16752869479666417665). -- Exchange Online: `\` (for example, `rzaher\16752869479666417665`. -- On-premises Exchange: `\` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). +- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). +- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). ```yaml Type: InboxRuleIdParameter diff --git a/exchange/exchange-ps/exchange/Get-LinkedUser.md b/exchange/exchange-ps/exchange/Get-LinkedUser.md index 41c1e7fa5c..272b63c35e 100644 --- a/exchange/exchange-ps/exchange/Get-LinkedUser.md +++ b/exchange/exchange-ps/exchange/Get-LinkedUser.md @@ -166,7 +166,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md new file mode 100644 index 0000000000..6a82e9dde9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Exchange.WebClient-Help.xml +online version: https://docs.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicy +applicable: Exchange Online +title: Get-M365DataAtRestEncryptionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-M365DataAtRestEncryptionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-M365DataAtRestEncryptionPolicy cmdlet to view existing Microsoft 365 data-at-rest encryption policies. + +**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-M365DataAtRestEncryptionPolicy [[-Identity] ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +M365 data-at-rest encryption policy cmdlets are accessible to compliance administrator role as part of the Exchange Online infrastructure. For more information, see [Overview of M365 Customer Key at the tenant level](https://docs.microsoft.com/microsoft-365/compliance/customer-key-tenant-level#get-policy-details). + +You can create and assign a Microsoft 365 data-at-rest encryption policy at the tenant level by using the appropriate M365DataAtRestEncryptionPolicy cmdlets in Exchange Online PowerShell. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-M365DataAtRestEncryptionPolicy +``` + +This example returns a summary list of all Microsoft 365 data-at-rest encryption policies. + +### Example 2 +```powershell +Get-M365DataAtRestEncryptionPolicy -Identity "Contoso Corporate" | Format-List +``` + +This example returns detailed information about the policy named Contoso Corporate. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Microsoft 365 data-at-rest encryption policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### + +## OUTPUTS + +### + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md new file mode 100644 index 0000000000..0340749c3d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicyAssignment.md @@ -0,0 +1,63 @@ +--- +external help file: Microsoft.Exchange.WebClient-Help.xml +online version: https://docs.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicyassignment +applicable: Exchange Online +title: Get-M365DataAtRestEncryptionPolicyAssignment +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-M365DataAtRestEncryptionPolicyAssignment + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-M365DataAtRestEncryptionPolicyAssignment cmdlet to view the currently assigned Microsoft 365 data-at-rest encryption policy. + +**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-M365DataAtRestEncryptionPolicyAssignment [] +``` + +## DESCRIPTION +This cmdlet lists the Microsoft 365 data-at-rest encryption policy that's currently assigned to the tenant. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-M365DataAtRestEncryptionPolicyAssignment +``` + +This example returns a summary list of all Microsoft 365 data-at-rest encryption policy assignments. + +### Example 2 +```powershell +Get-M365DataAtRestEncryptionPolicyAssignment | Format-List +``` + +This example returns detailed information for all Microsoft 365 data-at-rest encryption policy assignments. + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### + +## OUTPUTS + +### + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailContact.md b/exchange/exchange-ps/exchange/Get-MailContact.md index 6f41fcd8b6..dd9007f6c9 100644 --- a/exchange/exchange-ps/exchange/Get-MailContact.md +++ b/exchange/exchange-ps/exchange/Get-MailContact.md @@ -285,7 +285,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md index 2e8602fcb5..08fc0cb64a 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-MailDetailATPReport cmdlet to list details about Exchange Online Protection and Advanced Threat protection (ATP) detections in your cloud-based organization for the last 10 days. +Use the Get-MailDetailATPReport cmdlet to list details about Exchange Online Protection and Microsoft Defender for Office 365 detections in your cloud-based organization for the last 10 days. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -41,9 +41,9 @@ Get-MailDetailATPReport [-Direction ] ``` ## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. For the reporting period you specify, the cmdlet returns the following information: @@ -72,7 +72,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Get-MailDetailATPReport -StartDate 7/22/2018 -EndDate 7/31/2018 ``` -This example returns the Advanced Threat Protection actions for the last 10 days in July, 2018. (Note: Customers with Advanced Threat Protection subscription will be able to get up to 30 days of data.) +This example returns the actions for the last 10 days in July, 2018. (Note: Customers with Defender for Office 365 subscriptions will be able to get up to 30 days of data.) ## PARAMETERS @@ -129,12 +129,12 @@ Accept wildcard characters: False ### -EventType The EventType parameter filters the report by the event type. Valid values are: -Email phish EventTypes: +Email phishing EventTypes: - Advanced phish filter (Indicates a message caught by the machine learning model.) - Anti-spoof: Intra-org (Indicates an internal message caught by anti-phish spoof protection.) - Anti-spoof: external domain (Indicates an external message caught by anti-phish spoof protection.) -- ATP-generated URL reputation\* (Indicates a message with a known malicious URL caught by ATP.) +- ATP-generated URL reputation\* (Indicates a message with a known malicious URL caught Defender for Office 365.) - Domain impersonation\* (Indicates a message impersonating a domain protected by an anti-phish policy.) - Brand impersonation (Indicates a message caught by phish filters as impersonating a known brand.) - EOP URL Reputation (Indicates a message with a known malicious URL caught by EOP.) @@ -147,21 +147,21 @@ Email malware EventTypes: - Anti-malware engine\* (Indicates a message caught by the anti-malware engine.) - Anti-malware policy file type block (Indicates when the Common Attachment Types filter blocks a file.) -- ATP-generated file reputation\* (Indicates a message with a known malicious file blocked by ATP.) -- ATP safe attachments\* (Indicates a message with a malicious attachment blocked by ATP.) -- ATP safe links\* (Indicates when a malicious link is blocked by ATP.) +- ATP-generated file reputation\* (Indicates a message with a known malicious file blocked Defender for Office 365.) +- ATP Safe Attachments\* (Indicates a message with a malicious attachment blocked Defender for Office 365.) +- ATP Safe Links\* (Indicates when a malicious link is blocked Defender for Office 365.) - File Detonation\* (Indicates a message with a malicious attachment blocked by the detonation service.) - Malware ZAP (Indicates a message with malware detected and auto-purged after delivery.) - Office 365 file reputation (Indicates a message with a known malicious file blocked.) Content malware EventTypes: -- AtpDocumentMalware\* (Indicates malicious content detected by ATP Safe Attachments in the cloud.) -- AvDocumentMalware (Indicates malware found by the anti-malware engine. Reporting requires ATP or E5.) +- AtpDocumentMalware\* (Indicates malicious content detected by Safe Attachments.) +- AvDocumentMalware (Indicates malware found by the anti-malware engine. Reporting requires Defender for Office 365 or E5.) -\* These features require a standalone Office 365 ATP or E5 subscription. +\* Requires Defender for Office 365 (included in Microsoft 365 E5 or in an add-in subscription). -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md b/exchange/exchange-ps/exchange/Get-MailPublicFolder.md index 32bac09d59..f02e03b2f8 100644 --- a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md +++ b/exchange/exchange-ps/exchange/Get-MailPublicFolder.md @@ -258,7 +258,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md index 5e7872ea2d..56360a73d7 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-MailTrafficATPReport cmdlet to view the results of Exchange Online Protection and Advanced Threat Protection (ATP) detections in your cloud-based organization for the last 90 days. +Use the Get-MailTrafficATPReport cmdlet to view the results of Exchange Online Protection and Microsoft Defender for Office 365 detections in your cloud-based organization for the last 90 days. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -40,9 +40,9 @@ Get-MailTrafficATPReport ``` ## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. For the reporting period you specify, the cmdlet returns the following information: @@ -175,7 +175,7 @@ The EventType parameter filters the report by the event type. Valid values are: - Message passed (Indicates a good message.) -Email phish EventTypes: +Email phishing EventTypes: - Advanced phish filter (Indicates a message caught by the machine learning model.) - Anti-spoof: Intra-org (Indicates an internal message caught by anti-phish spoof protection.) @@ -191,20 +191,20 @@ Email phish EventTypes: Email malware EventTypes: - Anti-malware engine (Indicates a message caught by the anti-malware engine.) -- ATP safe attachments\* (Indicates a message with a malicious attachment blocked by ATP.) -- ATP safe links\* (Indicates when a malicious link is blocked by ATP.) +- ATP Safe Attachments\* (Indicates a message with a malicious attachment blocked by Defender for Office 365.) +- ATP Safe Links\* (Indicates when a malicious link is blocked by Defender for Office 365.) - ZAP (Indicates a message with malware detected and auto-purged after delivery.) - Office 365 file reputation (Indicates a message with a known malicious file blocked.) - Anti-malware policy file type block (Indicates when the Common Attachment Types filter blocks a file.) Content malware EventTypes: -- AtpDocumentMalware\* (Indicates malicious content detected by ATP Safe Attachments in the cloud.) -- AvDocumentMalware (Indicates malware found by the anti-malware engine. Reporting requires ATP/E5.) +- AtpDocumentMalware\* (Indicates malicious content detected by Safe Attachments.) +- AvDocumentMalware (Indicates malware found by the anti-malware engine. Reporting requires Defender for Office 365 or E5.) -\* These features require an E5 subscription or an Office 365 ATP add-on. +\* Requires Defender for Office 365 (included in Microsoft 365 E5 or in an add-in subscription). -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficReport.md index 2c9518d58f..f8c9c6b668 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficReport.md @@ -54,8 +54,8 @@ You can use the EventType values from the Get-MailTrafficReport cmdlet to analyz Mail traffic summary -- AdvancedProtectionMalware: Messages that were marked as malware by the Office 365 Advanced Threat Protection service. For details about the Advanced Threat Protection service, see [Office 365 Advanced Threat Protection service description](https://docs.microsoft.com/office365/servicedescriptions/office-365-advanced-threat-protection-service-description). -- AtpGoodMail: Messages that were delivered after passing through the Office 365 Advanced Threat Protection service. This count shows the number of unique messages. If a message was delivered to multiple recipients, it would still count as a single message. +- AdvancedProtectionMalware: Messages that were marked as malware by Microsoft Defender for Office 365. For details about Defender for Office 365, see [Microsoft Defender for Office 365 service description](https://docs.microsoft.com/office365/servicedescriptions/office-365-advanced-threat-protection-service-description). +- AtpGoodMail: Messages that were delivered after passing through Defender for Office 365. This count shows the number of unique messages. If a message was delivered to multiple recipients, it would still count as a single message. - DLPMessages: Messages that matched a data loss prevention (DLP) policy. For details about data loss prevention, see [Overview of data loss prevention](https://docs.microsoft.com/microsoft-365/compliance/data-loss-prevention-policies). - Expire: Messages that cannot be delivered, stuck in a queue, and after some time expired. - GoodMail: Messages that were delivered after passing through the malware and spam filters. This count shows the number of unique messages. If a message was delivered to multiple recipients, it would still count as a single message. @@ -73,6 +73,7 @@ Spam detections - SpamContentFiltered: Messages that passed the initial IP and SMTP filters and were filtered based on content, rules or other spam configurations. Spam analysis - content-filtered spam + - Spam\_AdditionalSpamFiltered: Messages filtered based on advanced spam filters that have been enabled. For details about the advanced spam filter, see [Advanced spam filtering options](https://docs.microsoft.com/microsoft-365/security/office-365-security/advanced-spam-filtering-asf-options). - Spam\_BlockList: Messages that were filtered because the sender was on a spam filter block list. For more details on how to configure these lists, see [Configure your spam filter policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-your-spam-filter-policies). - Spam\_BulkFiltered: Messages that were filtered as bulk mail. See message volume breakdown by Bulk Complaint Level (BCL) for further analysis of bulk mail. For more information about bulk mail processing, see [What's the difference between junk email and bulk email?](https://docs.microsoft.com/microsoft-365/security/office-365-security/what-s-the-difference-between-junk-email-and-bulk-email). @@ -81,6 +82,7 @@ Spam analysis - content-filtered spam - Spam\_SenderBlocked: Messages that were filtered because the sender was on a block list. Spam analysis - non-spam messages + - NonSpam\_AdditionalSpamFilterPassed: Messages that were passed based on advanced spam filters that have been enabled. For details about the advanced spam filters, see [Advanced spam filtering options](https://docs.microsoft.com/microsoft-365/security/office-365-security/advanced-spam-filtering-asf-options). - NonSpam\_AllowList: Messages that were passed because the sender was on a spam filter allow list. For more details on how to configure these lists, see [Configure your spam filter policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-your-spam-filter-policies). - NonSpam\_BulkPassed: Messages that were determined not to be bulk mail. @@ -182,7 +184,7 @@ The Domain parameter filters the results by an accepted domain in the cloud-base If you don't use the Domain parameter, the message count for your entire organization is returned. This includes messages that were sent from or to unregistered domains that are attributed to your organization. Unregistered domains can be attributed to your organization in hybrid or EOP standalone configurations. -Notes: +**Notes**: - Messages that are sent to recipients in multiple domains are counted differently at the domain level versus the organizational level. At the domain level, the message is counted for each different domain. At the organizational level, the message is counted only once. Therefore, if you add up the total number of received messages for each domain, the value might not match the total number of received messages for the organization. - The Domain value is Others for messages that were sent from or to unregistered domains that are attributed to your organization (messages in domains that aren't configured as accepted domains in your organization). diff --git a/exchange/exchange-ps/exchange/Get-MailUser.md b/exchange/exchange-ps/exchange/Get-MailUser.md index ae40346f48..9cd81bc7b7 100644 --- a/exchange/exchange-ps/exchange/Get-MailUser.md +++ b/exchange/exchange-ps/exchange/Get-MailUser.md @@ -262,7 +262,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-Mailbox.md b/exchange/exchange-ps/exchange/Get-Mailbox.md index 7843a7a976..47e2162ebf 100644 --- a/exchange/exchange-ps/exchange/Get-Mailbox.md +++ b/exchange/exchange-ps/exchange/Get-Mailbox.md @@ -728,7 +728,7 @@ You can use any value that uniquely identifies the server. For example: You can't use this parameter with the Anr, Database, or Identity parameters. -The ServerName and ServerLegacyDN properties for a mailbox may not be updated immediately after a mailbox move within a database availability group (DAG). To get the most up-to-date values for these mailbox properties, run the command Get-Mailbox \ | Get-MailboxStatistics | Format-List Name,ServerName,ServerLegacyDN. +The ServerName and ServerLegacyDN properties for a mailbox may not be updated immediately after a mailbox move within a database availability group (DAG). To get the most up-to-date values for these mailbox properties, run the command `Get-Mailbox | Get-MailboxStatistics | Format-List Name,ServerName,ServerLegacyDN`. ```yaml Type: ServerIdParameter @@ -766,7 +766,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md b/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md index 89d7ebfbf4..f75b44ec3c 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md +++ b/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md @@ -138,7 +138,7 @@ Accept wildcard characters: False ``` ### -Identity -The Identity parameter specifies the name of the database copy for which the command should gather information. The Identity parameter can be specified in the form of \\\\. Specifying just \ returns information for all copies of the database. This parameter can't be combined with the Server parameter. +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 diff --git a/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md index 2982f5afce..ec79caa274 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md @@ -98,7 +98,7 @@ This example returns all export requests that have the name DB01toPST where the ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the export request. By default, export requests are named \\\MailboxExportX (where X = 0-9). If you specified a name for the export request when the request was created using the New-MailboxExportRequest cmdlet, use the following syntax: \\\\. Exchange automatically precedes the request with the mailbox's alias. +The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). If you specified a name for the export request when the request was created using the New-MailboxExportRequest cmdlet, use the following syntax: `Alias\Name`. Exchange automatically precedes the request with the mailbox's alias. This parameter can't be with the following parameters: diff --git a/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md index fc2a03e890..e5306f6454 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md @@ -106,7 +106,7 @@ This example returns additional information for all the export requests that hav ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the export request. By default, export requests are named \\\MailboxExportX (where X = 0-9). If you specified a name for the export request when it was created by using the New-MailboxExportRequest cmdlet, use the following syntax: \\\\. +The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). If you specified a name for the export request when it was created by using the New-MailboxExportRequest cmdlet, use the following syntax: `Alias\Name`. This parameter can't be used with the RequestGuid or RequestQueue parameters. diff --git a/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md index 22059a3a19..9eed4f64d2 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md @@ -100,7 +100,7 @@ This example returns all import requests that have the name Recovered where the ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the import request. By default, import requests are named \\\MailboxImportX (where X = 0-9). If you specify a name for the import request, use the following syntax: \\\\. Microsoft Exchange automatically precedes the request with the mailbox's alias. +The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you specify a name for the import request, use the following syntax: `Alias\Name`. Microsoft Exchange automatically precedes the request with the mailbox's alias. You can't use this parameter with the following parameters: diff --git a/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md index 06734977ba..01ddca5464 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md @@ -107,7 +107,7 @@ This example returns additional information for all the import requests that hav ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the import request. By default, import requests are named \\\MailboxImportX (where X = 0-9). If you specified a name when you created the import request, use the following syntax: \\\\. +The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you specified a name when you created the import request, use the following syntax: `Alias\Name`. ```yaml Type: MailboxImportRequestIdParameter diff --git a/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md index 2534319ef4..1176becf8c 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md @@ -50,7 +50,8 @@ This example returns the junk email configuration for the user named David Pelto ### Example 2 ```powershell -$AllUsers = Get-Mailbox -ResultSize unlimited -RecipientTypeDetails UserMailbox; $AllUsers | foreach {Get-MailboxJunkEmailConfiguration -Identity $_.UserPrincipalName} | Where {$_.Enabled -eq $false} | Format-Table -Auto Identity,Enabled +$AllUsers = Get-Mailbox -ResultSize unlimited -RecipientTypeDetails UserMailbox +$AllUsers | foreach {Get-MailboxJunkEmailConfiguration -Identity $_.UserPrincipalName} | Where {$_.Enabled -eq $false} | Format-Table -Auto Identity,Enabled ``` This example returns a summary list of all mailboxes in your organization where the junk email rule is disabled. The first command stores all user mailboxes in a variable. The second command parses through the mailboxes and returns the FQDN of the mailboxes where the junk email rule is disabled. diff --git a/exchange/exchange-ps/exchange/Get-MailboxLocation.md b/exchange/exchange-ps/exchange/Get-MailboxLocation.md index aacdfca97c..e19e792909 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxLocation.md +++ b/exchange/exchange-ps/exchange/Get-MailboxLocation.md @@ -70,7 +70,7 @@ In Exchange Online, this example returns the mailbox location information for th Get-MailboxLocation -Identity e15664af-82ed-4635-b02a-df7c2e03d950 ``` -In Exchange Server or Exchange Online, this example returns the mailbox location information for the specified mailbox GUID (the ExchangeGuid property value from the results of Get-Mailbox -Identity \ | Format-List ExchangeGuid). +In Exchange Server or Exchange Online, this example returns the mailbox location information for the specified mailbox GUID (the ExchangeGuid property value from the results of `Get-Mailbox -Identity | Format-List ExchangeGuid`). ## PARAMETERS @@ -101,12 +101,12 @@ Accept wildcard characters: False ### -Identity The Identity parameter specifies the mailbox location object that you want to view. The value uses the either of the following formats: -- \\\\ -- \ +- TenantGUID\\MailboxGUID +- MailboxGUID -In Exchange Server or Exchange Online, you can run the following command to find and compare the \ values for the user: Get-Mailbox -Identity \ \| Format-List *GUID,MailboxLocations. +In Exchange Server or Exchange Online, you can run the following command to find and compare the MailboxGUID values for the user: `Get-Mailbox -Identity | Format-List *GUID,MailboxLocations`. -In Exchange Online, you can find the \ and \ values after you run Get-MailboxLocation with the User parameter. +In Exchange Online, you can find the TenantGUID and MailboxGUID values after you run Get-MailboxLocation with the User parameter. You can't use this parameter with the User parameter. diff --git a/exchange/exchange-ps/exchange/Get-MailboxPlan.md b/exchange/exchange-ps/exchange/Get-MailboxPlan.md index cd0350106e..a1796f101c 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxPlan.md +++ b/exchange/exchange-ps/exchange/Get-MailboxPlan.md @@ -191,7 +191,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following attributes: diff --git a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md index 17cc0b6ee4..86fbf5227f 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md @@ -107,11 +107,11 @@ The VerifyDefaultFolderNameLanguage switch verifies that the default folder name The results are displayed in the DefaultFolderNameMatchingUserLanguage property. To see this property, you need to pipeline the results of the command to the Format-List or Format-Table cmdlets. For example: -- Get-MailboxRegionalConfiguration -Identity \ -VerifyDefaultFolderNameLanguage | Format-List +- `Get-MailboxRegionalConfiguration -Identity -VerifyDefaultFolderNameLanguage | Format-List` Or -- Get-MailboxRegionalConfiguration -Identity \ -VerifyDefaultFolderNameLanguage | Format-Table Language,DefaultFolderNameMatchingUserLanguage +- `Get-MailboxRegionalConfiguration -Identity -VerifyDefaultFolderNameLanguage | Format-Table Language,DefaultFolderNameMatchingUserLanguage` If you view the DefaultFolderNameMatchingUserLanguage property without using the VerifyDefaultFolderNameLanguage switch, the value is always $false, even if the default folder names are localized in the language that's specified for the mailbox. diff --git a/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md index c64a3df0c9..9a982ca18d 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md @@ -57,7 +57,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Get-MailboxDatabase | Get-MailboxRepairRequest | Format-Table Identity; Get-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\335c2b06-321d-4e73-b2f7-3dc2b02d0df5\374289de-b899-42dc-8391-4f8579935f1f | Format-List +Get-MailboxDatabase | Get-MailboxRepairRequest | Format-Table Identity +Get-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\335c2b06-321d-4e73-b2f7-3dc2b02d0df5\374289de-b899-42dc-8391-4f8579935f1f | Format-List ``` This example displays the value of the Identity property for all mailbox repair requests for all mailbox servers in your organization; the second command displays information about a specific mailbox repair request that was returned by the first command. @@ -71,7 +72,8 @@ This example displays repair request information for the mailbox of Ann Beebe us ### Example 3 ```powershell -$MailboxGuid = Get-MailboxStatistics annb; Get-MailboxRepairRequest -Database $MailboxGuid.Database -StoreMailbox $MailboxGuid.MailboxGuid | Format-List Identity +$MailboxGuid = Get-MailboxStatistics annb +Get-MailboxRepairRequest -Database $MailboxGuid.Database -StoreMailbox $MailboxGuid.MailboxGuid | Format-List Identity ``` This example uses the Database and StoreMailbox parameters to display the Identity property of the repair request for the mailbox of Ann Beebe. @@ -79,7 +81,7 @@ This example uses the Database and StoreMailbox parameters to display the Identi ## PARAMETERS ### -Identity -The Identity parameter specifies the mailbox repair request to display information about. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is \\\\\\\. +The Identity parameter specifies the mailbox repair request to display information about. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is `DatabaseGuid\RequestGuid\JobGuid`. ```yaml Type: StoreIntegrityCheckJobIdParameter diff --git a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md index 0e0520e85b..a639c76b70 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md @@ -80,7 +80,7 @@ This example returns all restore requests that have the name RestoreToMBD01 wher ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: \\\\. +The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). diff --git a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md index 677c6f499c..f29c40c597 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md @@ -103,7 +103,7 @@ This example returns additional information for all the restore requests that ha ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: \\\\. +The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). diff --git a/exchange/exchange-ps/exchange/Get-MailboxSearch.md b/exchange/exchange-ps/exchange/Get-MailboxSearch.md index 7820b17b23..41a58b6407 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Get-MailboxSearch.md @@ -16,6 +16,8 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxSearch cmdlet to view mailbox searches that are in progress, complete or stopped. +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). + For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,7 +49,7 @@ Get-MailboxSearch -InPlaceHoldIdentity ``` ## DESCRIPTION -In on-premises Exchange and Exchange Online, a mailbox search is used to perform an In-Place eDiscovery or to place users on an In-Place Hold. Use the Get-MailboxSearch cmdlet to retrieve details of either type of mailbox search. +In on-premises Exchange, a mailbox search is used to perform an In-Place eDiscovery or to place users on an In-Place Hold. Use the Get-MailboxSearch cmdlet to retrieve details of either type of mailbox search. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -71,7 +73,8 @@ The Identity parameter is a positional parameter. Positional parameters can be u ### Example 3 ```powershell -(Get-Mailbox Mark).InPlaceHolds; Get-MailboxSearch -InPlaceHoldIdentity 9953d0f0fd03415e949d4b41c5a28cbb +(Get-Mailbox Mark).InPlaceHolds +Get-MailboxSearch -InPlaceHoldIdentity 9953d0f0fd03415e949d4b41c5a28cbb ``` This example retrieves the In-Place Holds that a user is placed on. The first command outputs GUIDs of In-Place Holds. The last command retrieves a mailbox search based on the GUID of the In-Place Hold that the user is placed on. diff --git a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxStatistics.md index ec46139d6b..cbae43c89e 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxStatistics.md @@ -126,14 +126,16 @@ This example returns the summary move history for the completed move request for ### Example 8 ```powershell -$temp=Get-MailboxStatistics -Identity AylaKol -IncludeMoveHistory; $temp.MoveHistory[0] +$temp=Get-MailboxStatistics -Identity AylaKol -IncludeMoveHistory +$temp.MoveHistory[0] ``` This example returns the detailed move history for the completed move request for Ayla Kol's mailbox. This example uses a temporary variable to store the mailbox statistics object. If the mailbox has been moved multiple times, there are multiple move reports. The last move report is always MoveReport[0]. ### Example 9 ```powershell -$temp=Get-MailboxStatistics -Identity AylaKol -IncludeMoveReport; $temp.MoveHistory[0] | Export-CSV C:\MoveReport_AylaKol.csv +$temp=Get-MailboxStatistics -Identity AylaKol -IncludeMoveReport +$temp.MoveHistory[0] | Export-CSV C:\MoveReport_AylaKol.csv ``` This example returns the detailed move history and a verbose detailed move report for Ayla Kol's mailbox. This example uses a temporary variable to store the move request statistics object and outputs the move report to a CSV file. @@ -220,7 +222,6 @@ You can use any value that uniquely identifies the server. For example: If you don't use this parameter, the command is run on the local server. - ```yaml Type: ServerIdParameter Parameter Sets: Database, Identity @@ -382,7 +383,7 @@ This parameter is available only in on-premises Exchange. The IncludeQuarantineDetails switch specifies whether to return additional quarantine details about the mailbox that aren't otherwise included in the results. You can use these details to determine when and why the mailbox was quarantined. -Specifically, this switch returns the values of the QuarantineDescription, QuarantineLastCrash and QuarantineEnd properties on the mailbox. To see these values, you need use a formatting cmdlet. For example, Get-MailboxStatistics \ -IncludeQuarantineDetails | Format-List Quarantine\*. +Specifically, this switch returns the values of the QuarantineDescription, QuarantineLastCrash and QuarantineEnd properties on the mailbox. To see these values, you need use a formatting cmdlet. For example, `Get-MailboxStatistics -IncludeQuarantineDetails | Format-List Quarantine*`. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md index 20a59d6da5..cb9149119f 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md @@ -50,10 +50,10 @@ This example returns detailed information for the specified user configuration i ## PARAMETERS ### -Identity -The Identity parameter specifies the user configuration item that you want to view. This parameter uses the syntax \\\\: +The Identity parameter specifies the user configuration item that you want to view. This parameter uses the syntax MailboxFolder\ItemName: -- Valid values for \ are folder names (for example, Inbox or Calendar), the value Configuration, or the value Root. Wildcards (\*) aren't supported. -- Valid values for \ start with IPM.Configuration (for example, IPM.Configuration.Aggregated.OwaUserConfiguration. Wildcards (\*) are supported. +- Valid values for MailboxFolder are folder names (for example, Inbox or Calendar), the value Configuration, or the value Root. Wildcards (\*) aren't supported. +- Valid values for ItemName start with IPM.Configuration (for example, IPM.Configuration.Aggregated.OwaUserConfiguration. Wildcards (\*) are supported. ```yaml Type: MailboxUserConfigurationIdParameter diff --git a/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md index e337606a12..9800910ddb 100644 --- a/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md @@ -50,7 +50,9 @@ This example returns a summary list of the MAPI virtual directories on the serve ### Example 2 ```powershell -Get-MapiVirtualDirectory -Identity "ContosoMail\mapi (Default Web Site)" | Format-List; Get-MapiVirtualDirectory "ContosoMail\mapi (Default Web Site)" | Format-List; Get-MapiVirtualDirectory ContosoMai\mapi* | Format-List +Get-MapiVirtualDirectory -Identity "ContosoMail\mapi (Default Web Site)" | Format-List +Get-MapiVirtualDirectory "ContosoMail\mapi (Default Web Site)" | Format-List +Get-MapiVirtualDirectory ContosoMai\mapi* | Format-List ``` These examples return detailed information for the MAPI virtual directory named "mapi (Default Web Site)" on the server named ContosoMail. All three commands do the same thing. @@ -67,11 +69,11 @@ This example returns a summary list of all MAPI virtual directories in the clien ### -Identity The Identity parameter specifies the MAPI virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. You can't use the Identity and Server parameters in the same command. diff --git a/exchange/exchange-ps/exchange/Get-Message.md b/exchange/exchange-ps/exchange/Get-Message.md index deb209017d..71e20dcd5b 100644 --- a/exchange/exchange-ps/exchange/Get-Message.md +++ b/exchange/exchange-ps/exchange/Get-Message.md @@ -223,7 +223,7 @@ Accept wildcard characters: False ``` ### -Queue -The Queue parameter specifies the identity of the queue that contains the messages that you want to display. Valid input for this parameter uses the syntax \\\\ or \, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see the "Queue identity" section in Find queues and messages in queues in the Exchange Management Shell. +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://docs.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. diff --git a/exchange/exchange-ps/exchange/Get-MessageClassification.md b/exchange/exchange-ps/exchange/Get-MessageClassification.md index 394bdcfa0f..ccf4abbdfe 100644 --- a/exchange/exchange-ps/exchange/Get-MessageClassification.md +++ b/exchange/exchange-ps/exchange/Get-MessageClassification.md @@ -45,7 +45,7 @@ This example lists all message classifications in your organization. The Identity parameter specifies the message classification that you want to view. You can use any value that uniquely identifies the message classification. For example: - Name -- Identity: Default\\ or \\\; for example, "Default\My Message Classification" or "es-ES\My Message Classification". +- Identity: `Default\` or `\`; for example, "Default\My Message Classification" or "es-ES\My Message Classification". - ClassificationID (GUID) ```yaml diff --git a/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md b/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md index 29e13afc12..df0bbec744 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md @@ -51,7 +51,7 @@ The field names displayed in the results from the Get-MessageTrackingLog cmdlet For more information about the message tracking log files, see [Message tracking](https://docs.microsoft.com/Exchange/mail-flow/transport-logs/message-tracking). -The Get-MessageTrackingLog results are displayed on-screen. You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding "\> \" to the command. For example: +You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding ` > ` to the command. For example: `Get-MessageTrackingLog -Start "03/13/2020 09:00:00" -End "03/13/2020 09:10:00" | ConvertTo-Html > "C:\My Documents\message track.html"`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md b/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md index 7b3e4f148a..d67396f95a 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md @@ -46,7 +46,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$Temp = Search-MessageTrackingReport -Identity "David Jones" -Recipients "wendy@contoso.com"; Get-MessageTrackingReport -Identity $Temp.MessageTrackingReportID -ReportTemplate Summary +$Temp = Search-MessageTrackingReport -Identity "David Jones" -Recipients "wendy@contoso.com" +Get-MessageTrackingReport -Identity $Temp.MessageTrackingReportID -ReportTemplate Summary ``` This example gets the message tracking report for messages sent from one user to another. This example returns the summary of the message tracking report for a message that David Jones sent to Wendy Richardson. diff --git a/exchange/exchange-ps/exchange/Get-MobileDevice.md b/exchange/exchange-ps/exchange/Get-MobileDevice.md index 7986c34fe0..34d30f0f4e 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDevice.md +++ b/exchange/exchange-ps/exchange/Get-MobileDevice.md @@ -110,7 +110,7 @@ Accept wildcard characters: False ``` ### -ActiveSync -The ActiveSync switch specifies whether to include mobile devices that synchronize with Exchange ActiveSync. You don't need to specify a value with this switch. +The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -284,7 +284,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md index 2224f5a7af..f2676c2789 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md @@ -66,7 +66,8 @@ This example retrieves the statistics for the mobile phone configured to synchro ### Example 2 ```powershell -$UserList = Get-CASMailbox -Filter "HasActiveSyncDevicePartnership -eq `$true -and -not DisplayName -like 'CAS_{*'" | Get-Mailbox; $UserList | foreach {Get-MobileDeviceStatistics -Mailbox $_.Identity} +$UserList = Get-CASMailbox -Filter "HasActiveSyncDevicePartnership -eq `$true -and -not DisplayName -like 'CAS_{*'" | Get-Mailbox +$UserList | foreach {Get-MobileDeviceStatistics -Mailbox $_.Identity} ``` This example uses the Get-CASMailbox cmdlet to determine who in the organization has an Exchange ActiveSync mobile device. For each mobile device, the Exchange ActiveSync device statistics are retrieved. diff --git a/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md b/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md index 420acf7b6c..08fc697f74 100644 --- a/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md +++ b/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md @@ -40,7 +40,7 @@ This example retrieves health set information for a monitoring item on the serve ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the monitoring item. The parameter uses the syntax \\\\[\\\]. You can find the available values in the Identity property of the output of the Get-MonitoringItem cmdlet. +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 diff --git a/exchange/exchange-ps/exchange/Get-MoveRequest.md b/exchange/exchange-ps/exchange/Get-MoveRequest.md index b820e70a02..68a49cf290 100644 --- a/exchange/exchange-ps/exchange/Get-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Get-MoveRequest.md @@ -406,7 +406,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md index a99f28292a..d729795256 100644 --- a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md @@ -14,8 +14,6 @@ ms.author: chrisda ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). -**Note**: This cmdlet is available in version 2.0.4-Preview3 of the EXO V2 Module. - Use the Get-MyAnalyticsFeatureConfig cmdlet to view the availability and feature status of MyAnalytics for the specified user. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md b/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md index 286c3e3805..3114d5389d 100644 --- a/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md +++ b/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md @@ -28,7 +28,7 @@ Get-OMEMessageStatus -MessageId ``` ## DESCRIPTION -If encryption for the message was successfully revoked, the command will return the message: The encrypted email with the subject "\" and Message ID "\\" was successfully revoked. +If encryption for the message was successfully revoked, the command will return the message: `The encrypted email with the subject "" and Message ID "" was successfully revoked`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md index 5bd5097928..6c4edbb2ad 100644 --- a/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md @@ -124,11 +124,11 @@ Accept wildcard characters: False ### -Identity The Identity parameter specifies the OAB virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. You can't use the Identity and Server parameters in the same command. diff --git a/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md index d8c95f70ba..2123a27195 100644 --- a/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md @@ -67,7 +67,7 @@ This example returns specific properties for all existing OABs, including the Ge ### -Server This parameter is available only in on-premises Exchange. -Note: This parameter isn't relevant in Exchange 2013 or later. The Server property for an OAB is blank, because the OAB is generated by an arbitration mailbox. +**Note**: This parameter isn't relevant in Exchange 2013 or later. The Server property for an OAB is blank, because the OAB is generated by an arbitration mailbox. The Server parameter returns all of the OABs that are generated by the specified Exchange 2010 or earlier server. You can use any value that uniquely identifies the server. For example: diff --git a/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md index eb8f3cb5b5..05c90e2cec 100644 --- a/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md +++ b/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md @@ -62,11 +62,11 @@ This example returns information about the Outlook Anywhere virtual directory na ### -Identity The Identity parameter specifies the Outlook Anywhere virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. You can't use the Identity and Server parameters in the same command. diff --git a/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md index 9f96072460..e306926586 100644 --- a/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md @@ -73,11 +73,11 @@ This example returns a summary list of all Outlook on the web virtual directorie ### -Identity The Identity parameter specifies the OWA virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. You can't use the Identity and Server parameters in the same command. diff --git a/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md b/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md index 5fe4eca65b..43d2d0399e 100644 --- a/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md @@ -61,7 +61,8 @@ This example returns the list of senders that appear to be sending spoofed email ### Example 2 ```powershell -$file = "C:\My Documents\Summary Spoofed Internal Domains and Senders.csv"; Get-PhishFilterPolicy -Detailed -SpoofType Internal | Export-CSV $file +$file = "C:\My Documents\Summary Spoofed Internal Domains and Senders.csv" +Get-PhishFilterPolicy -Detailed -SpoofType Internal | Export-CSV $file ``` This example exports the same list of spoofed senders to a CSV file. diff --git a/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md index bd41464439..984a2d3739 100644 --- a/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md +++ b/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md @@ -109,7 +109,7 @@ Accept wildcard characters: False ### -Identity The Identity parameter specifies the custom Policy Tip you want to view. You can use any value that uniquely identifies the custom Policy Tip. For example: -- \\\\: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - The value Url - GUID - Distinguished name (DN) diff --git a/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md index 73d7df2a9c..a6c39ee580 100644 --- a/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md @@ -69,11 +69,11 @@ This example returns a summary list of all PowerShell virtual directories in the ### -Identity The Identity parameter specifies the PowerShell virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. You can't use the Identity and Server parameters in the same command. diff --git a/exchange/exchange-ps/exchange/Get-PublicFolder.md b/exchange/exchange-ps/exchange/Get-PublicFolder.md index f803a4e63f..0a852b3584 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolder.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolder.md @@ -172,7 +172,7 @@ Accept wildcard characters: False ``` ### -Identity -The Identity parameter specifies the name and path of the public folder you want to view. A valid value uses the syntax: \\\\\\\\...\\\\\\. For example, "\\Customer Discussion" or "\\Engineering\\Customer Discussion". +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 diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md index f381f36d42..47833a9c83 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md @@ -135,8 +135,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - - ### -IncludePreExchange2010 This parameter is available or functional only in Exchange Server 2010. diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md index 830f4bf72e..a9db4eea27 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md @@ -83,7 +83,7 @@ This example returns duplicate public folder migration requests (requests create ## PARAMETERS ### -BatchName -The BatchName parameter filters the results by the friendly BatchName value that was assigned when the batch job was created. The format of this value is: MigrationService:\. +The BatchName parameter filters the results by the friendly BatchName value that was assigned when the batch job was created. The format of this value is: `MigrationService:`. You can't use this parameter with the Identity parameter. @@ -142,7 +142,7 @@ Accept wildcard characters: False ``` ### -Identity -The Identity parameter specifies the public folder mailbox migration request that you want to view. The value uses the syntax: \\PublicFolderMailboxMigration\ (for example, \\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e). +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: @@ -167,7 +167,7 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies the name of the public folder mailbox migration request. If the name was not specified at creation, the default value is PublicFolderMailboxMigration\ (for example, PublicFolderMailboxMigration2ffdef13-01b9-4586-af2b-d5a5482010a8). +The Name parameter specifies the name of the public folder mailbox migration request. If the name was not specified at creation, the default value is `PublicFolderMailboxMigration` (for example, `PublicFolderMailboxMigration2ffdef13-01b9-4586-af2b-d5a5482010a8`). You can't use this parameter with the Identity parameter. diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md index b8626534a2..2fc1e8ed44 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md @@ -74,7 +74,7 @@ This example uses the Identity parameter to return information about the specifi ## PARAMETERS ### -Identity -The Identity parameter specifies the public folder mailbox migration request. The default identity value is \\PublicFolderMailboxMigration\ (for example, \\PublicFolderMailboxMigration\ac6d9eb4-ee49-405f-b90d-04e9a258bd7e). +The Identity parameter specifies the public folder mailbox migration request. The default identity value is `\PublicFolderMailboxMigration` (for example, `PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). You can't use this parameter with the RequestQueue and RequestGuid parameters. diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md index 06dd1ff8e8..70a9ddf2fe 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -14,9 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-QuarantineMessage cmdlet to view quarantined messages and files in your cloud-based organization. - -**Note**: Quarantined files are files protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams. +Use the Get-QuarantineMessage cmdlet to view quarantined messages and files in your cloud-based organization. Files are quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -90,7 +88,7 @@ This example returns detailed information for the quarantined message with the s Get-QuarantineMessage -QuarantineTypes SPOMalware | Format-List ``` -This example returns detailed information for the files protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams. +This example returns detailed information for the files protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. ## PARAMETERS @@ -254,14 +252,14 @@ The QuarantineTypes parameter filters the results by what caused the message to - Malware - Phish - Spam -- SPOMalware (ATP only) +- SPOMalware (Microsoft Defender for Office 365 only) - TransportRule You can specify multiple values separated by commas. You don't need to use this parameter with the Type parameter. -For files protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams, the detection information can be found in CustomData field in the output. +For files protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. ```yaml Type: QuarantineMessageTypeEnum[] @@ -388,12 +386,12 @@ The Type parameter filters the results by what caused the message to be quaranti - HighConfPhish - Phish - Spam -- SPOMalware (ATP only) +- SPOMalware (Microsoft Defender for Office 365 only) - TransportRule You don't need to use this parameter with the QuarantineTypes parameter. -For files protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams, the detection information can be found in CustomData field in the output. +For files protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. ```yaml Type: QuarantineMessageTypeEnum diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md index 19d3223201..67c99499da 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md @@ -43,7 +43,8 @@ This example displays the message header of the quarantined message that has the ### Example 2 ```powershell -$qMessages = Get-QuarantineMessage; Get-QuarantineMessageHeader $qMessages[0].Identity +$qMessages = Get-QuarantineMessage +Get-QuarantineMessageHeader $qMessages[0].Identity ``` This example displays the message header of the first message that's returned by Get-QuarantineMessage cmdlet. diff --git a/exchange/exchange-ps/exchange/Get-ReceiveConnector.md b/exchange/exchange-ps/exchange/Get-ReceiveConnector.md index 45ab9bb93b..e70040959e 100644 --- a/exchange/exchange-ps/exchange/Get-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/Get-ReceiveConnector.md @@ -81,7 +81,7 @@ The Identity parameter specifies the Receive connector that you want to view. Yo - Name - Distinguished name (DN) - GUID -- \\\\ +- ServerName\\Name You can't use this parameter with the Server parameter. diff --git a/exchange/exchange-ps/exchange/Get-Recipient.md b/exchange/exchange-ps/exchange/Get-Recipient.md index e77bf9cd61..ac87fe21c8 100644 --- a/exchange/exchange-ps/exchange/Get-Recipient.md +++ b/exchange/exchange-ps/exchange/Get-Recipient.md @@ -570,7 +570,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-RecoverableItems.md b/exchange/exchange-ps/exchange/Get-RecoverableItems.md index 6ff446093c..f82a2a0d5f 100644 --- a/exchange/exchange-ps/exchange/Get-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Get-RecoverableItems.md @@ -69,7 +69,6 @@ Get-RecoverableItems -Identity "malik@contoso.com", "lillian@contoso.com" -Filte This example returns all of the available recoverable deleted messages with the specified subject in the mailboxes of both malik@contoso.com and lillian@contoso.com for the specified date/time range. - ## PARAMETERS ### -Identity @@ -86,7 +85,7 @@ The Identity parameter specifies the mailbox that contains the deleted items tha - SamAccountName - User ID or user principal name (UPN) -In tExchange Online, you can specify multiple mailboxes separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +In Exchange Online, you can specify multiple mailboxes separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: GeneralMailboxOrMailUserIdParameter @@ -247,30 +246,16 @@ The SourceFolder parameter specifies where to search for deleted items in the ma - DeletedItems: The Deleted Items folder. - RecoverableItems: The Recoverable Items\Deletions folder. This folder contains items that have been deleted from the Deleted Items folder (soft-deleted items). -- PurgedItems: (Cloud only) The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). +- PurgedItems: The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). If you don't use this parameter, the command will search all of these folders. ```yaml Type: RecoverableItemsFolderType -Parameter Sets: OnPremises -Aliases: -Accepted values: DeletedItems | RecoverableItems -Applicable: Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: RecoverableItemsFolderType -Parameter Sets: Cloud +Parameter Sets: (All) Aliases: Accepted values: DeletedItems | RecoverableItems | PurgedItems -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Get-RemoteMailbox.md b/exchange/exchange-ps/exchange/Get-RemoteMailbox.md index c7b0bdfac6..4946b3478b 100644 --- a/exchange/exchange-ps/exchange/Get-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Get-RemoteMailbox.md @@ -71,7 +71,8 @@ This example returns a detailed information for the remote mailbox for the user ### Example 3 ```powershell -$Credentials = Get-Credential; Get-RemoteMailbox -Credential $Credentials +$Credentials = Get-Credential +Get-RemoteMailbox -Credential $Credentials ``` This example uses alternate credentials to retrieve a list of one or more mail-enabled users with mailboxes in the service. This is useful if the account you typically use doesn't have administrative permissions. The credentials are used to access the on-premises Active Directory domain controllers. @@ -285,7 +286,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-RoleGroup.md b/exchange/exchange-ps/exchange/Get-RoleGroup.md index fdc5f11030..358ea7267c 100644 --- a/exchange/exchange-ps/exchange/Get-RoleGroup.md +++ b/exchange/exchange-ps/exchange/Get-RoleGroup.md @@ -195,7 +195,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md index a3ea03ca1c..acc7d16dbf 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md @@ -28,7 +28,7 @@ Get-SafeAttachmentPolicy [[-Identity] ] ``` ## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Office 365 ATP](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md index a459896cff..04047425b2 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md @@ -29,7 +29,7 @@ Get-SafeAttachmentRule [[-Identity] ] ``` ## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Office 365 ATP](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md b/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md index 5dbb0fe9f8..7ff5fec914 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-SafeLinksAggregateReport cmdlet to return to return general data about Safe Links for the last 90 days. +Use the Get-SafeLinksAggregateReport cmdlet to return to return general information about Safe Links results for the last 90 days. Yesterday is the most recent date that you can specify. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -33,11 +33,13 @@ Get-SafeLinksAggregateReport ``` ## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. +**Note**: If you run Get-SafeLinksAggregateReport without specifying a date range, the command will return an unspecified error. + +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. For the reporting period you specify, the cmdlet returns the following information: -- Action +- Action (Allowed, Blocked, ClickedEventBlocked, and ClickedDuringScan) - App - MessageCount - RecipientCount @@ -91,7 +93,7 @@ The AppNameList parameter filters the results by the app where the link was foun - Visio - Word -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -111,6 +113,8 @@ The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Yesterday is the most recent date that you can specify. You can't specify a date that's older than 90 days. + ```yaml Type: System.DateTime Parameter Sets: (All) @@ -129,6 +133,8 @@ The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Yesterday is the most recent date that you can specify. You can't specify a date that's older than 90 days. + ```yaml Type: System.DateTime Parameter Sets: (All) diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md b/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md index 30579979f3..932058a68c 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-SafeLinksAggregateReport cmdlet to return to return detailed information about Safe Links. +Use the Get-SafeLinksDetailReport cmdlet to return to return detailed information about Safe Links results for the last 7 days. Yesterday is the most recent date that you can specify. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -36,8 +36,9 @@ Get-SafeLinksDetailReport [-Action ] ``` ## DESCRIPTION -The Get-SafeLinksDetailReport cmdlet returns information about URL clicks for the last 7 days. -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. +**Note**: If you run Get-SafeLinksDetailReport without specifying a date range, the command will return an unspecified error. + +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. This cmdlet returns the following information: @@ -52,7 +53,7 @@ This cmdlet returns the following information: - AppName - SourceId - Organization -- DetectedBy (ATP Safe Links) +- DetectedBy (Safe Links in Microsoft Defender for Office 365) - UrlType (currently empty) - Flags (0: Allowed 1: Blocked 2: ClickedEvenBlocked 3: ClickedDuringScan) @@ -62,7 +63,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Get-SafeLinksDetailReport -StartDate 06-07-2020 -EndDate 06-10-2020 -Action Allowed,Blocked -AppNameList "Email Client","Teams" -Domain google.com,teams.com -RecipientAddress faith@contoso.com,chris@contoso.com +Get-SafeLinksDetailReport -StartDate 06-07-2020 -EndDate 06-10-2020 -Action Allowed,Blocked -AppNameList "Email Client","Teams" -Domain google.com,teams.com -RecipientAddress faith@contoso.com,chris@contoso.com ``` This example returns filters the results by the following information: @@ -111,7 +112,7 @@ The AppNameList parameter filters the results by the app where the link was foun - Visio - Word -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -149,6 +150,8 @@ The EndDate parameter specifies the end date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Yesterday is the most recent date that you can specify. You can't specify a date that's older than 7 days. + ```yaml Type: System.DateTime Parameter Sets: (All) @@ -216,6 +219,8 @@ The StartDate parameter specifies the start date of the date range. Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Yesterday is the most recent date that you can specify. You can't specify a date that's older than 7 days. + ```yaml Type: System.DateTime Parameter Sets: (All) diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md index ac56d7a2c3..1a2cff1f7b 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md @@ -28,7 +28,7 @@ Get-SafeLinksPolicy [[-Identity] ] ``` ## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md b/exchange/exchange-ps/exchange/Get-SafeLinksRule.md index 0fb1da86c5..b19b3bb653 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksRule.md @@ -29,7 +29,7 @@ Get-SafeLinksRule [[-Identity] ] ``` ## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Get-ServerComponentState.md b/exchange/exchange-ps/exchange/Get-ServerComponentState.md index aec886d85d..2b5502c30f 100644 --- a/exchange/exchange-ps/exchange/Get-ServerComponentState.md +++ b/exchange/exchange-ps/exchange/Get-ServerComponentState.md @@ -69,7 +69,7 @@ Accept wildcard characters: False ``` ### -Component -The Component parameter specifies the component or endpoint for which you want to retrieve the state. To see the available values, run the following command: Get-ServerComponentState \. +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 diff --git a/exchange/exchange-ps/exchange/Get-SpoofMailReport.md b/exchange/exchange-ps/exchange/Get-SpoofMailReport.md index b3683fbe71..d25b962101 100644 --- a/exchange/exchange-ps/exchange/Get-SpoofMailReport.md +++ b/exchange/exchange-ps/exchange/Get-SpoofMailReport.md @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-SpoofMailReport cmdlet to view information about insider spoofing in your cloud-based organization for the past 10 days. Insider spoofing is where the sender's email address in an inbound message appears to represent your organization, but the actual identity of the sender is different. Insider spoofing is a common tactic that's used in phishing messages to obtain user credentials or steal money. -This cmdlet is only available in Microsoft 365 Enterprise E5, or with Advanced Threat Protection licenses. +This cmdlet is only available in Microsoft 365 Enterprise E5 or Microsoft Defender for Office 365 licenses. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -38,7 +38,7 @@ Get-SpoofMailReport [-Action ] ``` ## DESCRIPTION -The spoof mail report is a feature in Advanced Threat Protection that you can use to query information about insider spoofing detections in the last 30 days. For the reporting period you specify, the Get-SpoofMailReport cmdlet returns the following information: +The spoof mail report is a feature in Defender for Office 36 that you can use to query information about insider spoofing detections in the last 30 days. For the reporting period you specify, the Get-SpoofMailReport cmdlet returns the following information: - Date: Date the message was sent. - Event Type: Typically, this value is SpoofMail. diff --git a/exchange/exchange-ps/exchange/Get-SweepRule.md b/exchange/exchange-ps/exchange/Get-SweepRule.md index 6bc620fb30..34604f21b7 100644 --- a/exchange/exchange-ps/exchange/Get-SweepRule.md +++ b/exchange/exchange-ps/exchange/Get-SweepRule.md @@ -95,8 +95,8 @@ Accept wildcard characters: False The Identity parameter specifies the Sweep rule that you want to view. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). -- Exchange Online: \\\\ (for example, rzaher\\x2hlsdpGmUifjFgxxGIOJw==. -- On-premises Exchange: \\\\ (for example, contoso.com/Users/Rick Zaher\\x2hlsdpGmUifjFgxxGIOJw==. +- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). +- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). ```yaml Type: SweepRuleIdParameter diff --git a/exchange/exchange-ps/exchange/Get-SystemMessage.md b/exchange/exchange-ps/exchange/Get-SystemMessage.md index 5db7ef18b0..2c1290c532 100644 --- a/exchange/exchange-ps/exchange/Get-SystemMessage.md +++ b/exchange/exchange-ps/exchange/Get-SystemMessage.md @@ -102,14 +102,14 @@ You can't use this parameter with the Original switch. The identity value of a system message uses one of these formats: -- System messages for enhanced status codes:\\\\\\\. For example, En\\Internal\\5.1.2 or Ja\\External\\5.1.2. -- System messages for quotas:\\\\. For example, En\\ProhibitSendReceiveMailBox. +- System messages for enhanced status codes:`Language\\DSNCode`. For example, `En\Internal\5.1.2` or `Ja\External\5.1.2`. +- System messages for quotas:`Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailBox`. -\: For the list of supported language codes, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). +Language: For the list of supported language codes, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). -\: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. +DSNCode: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. -\: Valid value are: +QuotaMessageType: Valid value are: Mailbox size quotas: diff --git a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md index cbb9335b57..1b890c8bcb 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md @@ -7,7 +7,7 @@ schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: -ROBOTS: NOINDEX, NOFOLLOW +ROBOTS: NOINDEX --- # Get-TenantAllowBlockListItems diff --git a/exchange/exchange-ps/exchange/Get-TransportServer.md b/exchange/exchange-ps/exchange/Get-TransportServer.md index a1eddca1da..fcbfe129c6 100644 --- a/exchange/exchange-ps/exchange/Get-TransportServer.md +++ b/exchange/exchange-ps/exchange/Get-TransportServer.md @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-TransportServer cmdlet to view settings that are associated with the Hub Transport server role or the Edge Transport server role. -Note: In Exchange 2013 or later, use the Get-TransportService cmdlet instead. If you have scripts that use Get-TransportServer, update them to use Get-TransportService. +**Note**: In Exchange 2013 or later, use the Get-TransportService cmdlet instead. If you have scripts that use Get-TransportServer, update them to use Get-TransportService. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-UMActiveCalls.md b/exchange/exchange-ps/exchange/Get-UMActiveCalls.md index b932dd8824..f4b58df19b 100644 --- a/exchange/exchange-ps/exchange/Get-UMActiveCalls.md +++ b/exchange/exchange-ps/exchange/Get-UMActiveCalls.md @@ -128,7 +128,6 @@ Accept wildcard characters: False ### -IPGateway The IPGateway parameter specifies the UM IP gateway for which you want to retrieve active calls. - You can't use the DialPlan, InstanceServer, IPGateway, or Server parameters in the same command. ```yaml diff --git a/exchange/exchange-ps/exchange/Get-UMMailbox.md b/exchange/exchange-ps/exchange/Get-UMMailbox.md index 8668de4da6..bed028ec60 100644 --- a/exchange/exchange-ps/exchange/Get-UMMailbox.md +++ b/exchange/exchange-ps/exchange/Get-UMMailbox.md @@ -266,7 +266,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md index 071b639606..a0ac90f2bf 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md @@ -50,13 +50,12 @@ Get-UnifiedAuditLogRetentionPolicy -RecordType ExchangeItem | Format-List Name,D This example lists the configurable properties for all audit log retention policies that apply to audit records the record type of ExchangeItem. - ## PARAMETERS ### -Operation The Operations parameter filters the results by the operations that are specified in the policy. For a list of the available values for this parameter, see [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String @@ -93,12 +92,13 @@ The RetentionDuration parameter filters the policy results by the retention dura - SixMonths - NineMonths - TwelveMonths +- TenYears ```yaml Type: UnifiedAuditLogRetentionDuration Parameter Sets: (All) Aliases: -Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths +Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears Applicable: Security & Compliance Center Required: False @@ -111,7 +111,7 @@ Accept wildcard characters: False ### -UserId The UserIds parameter filters the policy results by the ID of the users who are specified in the policy. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md index 2678ce0efc..61c782ae3f 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md @@ -208,7 +208,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md index 6030cecfbb..39b8ce4e02 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md @@ -70,11 +70,10 @@ Accept wildcard characters: False ### -LinkType The LinkType parameter specifies the Microsoft 365 Group property that you want to view. Valid values are: +- Aggregators - Members - Owners - Subscribers -- Aggregators -- EventSubscribers ```yaml Type: LinkType diff --git a/exchange/exchange-ps/exchange/Get-UrlTrace.md b/exchange/exchange-ps/exchange/Get-UrlTrace.md index 93363a0684..fbcf7b2a24 100644 --- a/exchange/exchange-ps/exchange/Get-UrlTrace.md +++ b/exchange/exchange-ps/exchange/Get-UrlTrace.md @@ -37,7 +37,7 @@ Get-UrlTrace ``` ## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. For more information about Advanced Threat Protection Safe Links, see [Office 365 ATP Safe Links](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links). +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. For more information about Safe Links protection, see [Safe Links in Microsoft Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links). For the reporting period you specify, the cmdlet returns the following information: diff --git a/exchange/exchange-ps/exchange/Get-User.md b/exchange/exchange-ps/exchange/Get-User.md index e4608ffbf3..1dbc201321 100644 --- a/exchange/exchange-ps/exchange/Get-User.md +++ b/exchange/exchange-ps/exchange/Get-User.md @@ -407,7 +407,7 @@ Accept wildcard characters: False ### -Sortby The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the following properties: diff --git a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md b/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md index d30e2e35eb..bb5e572b61 100644 --- a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md @@ -14,8 +14,6 @@ ms.author: chrisda ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). -**Note**: This cmdlet is being replaced by the [Get-MyAnalyticsFeatureConfig](https://docs.microsoft.com/powershell/module/exchange/get-myanalyticsfeatureconfig) cmdlet. - Use the Get-UserBriefingConfig cmdlet to get the current state of the Briefing email flag for the specified user. For more details about configuring the Briefing email, see [Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Get-UserPhoto.md b/exchange/exchange-ps/exchange/Get-UserPhoto.md index df93eb4a10..be78fa7ab5 100644 --- a/exchange/exchange-ps/exchange/Get-UserPhoto.md +++ b/exchange/exchange-ps/exchange/Get-UserPhoto.md @@ -316,7 +316,7 @@ Accept wildcard characters: False ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. -If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \,\... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. +If the default view doesn't include the property you're sorting by, you can append the command with ` | Format-Table -Auto Property1,Property2,...PropertyX`. to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported. You can sort by the Id property. diff --git a/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md index 8a15cceb75..e7e5794b8c 100644 --- a/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md @@ -73,11 +73,11 @@ This example returns a summary list of all virtual directories in the client acc ### -Identity The Identity parameter specifies the EWS virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. You can't use the Identity and Server parameters in the same command. diff --git a/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md b/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md index 94331f7a1f..9d4f2f5a26 100644 --- a/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md +++ b/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md @@ -66,7 +66,7 @@ Accept wildcard characters: False ### -FileData The FileData parameter specifies the DLP policy collection file you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md index 99a71d63e2..c5c9e246ce 100644 --- a/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md @@ -44,7 +44,7 @@ This example imports the DLP policy template file C:\\My Documents\\External DLP ### -FileData The FileData parameter specifies the DLP policy template file you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md index 35773e0ea8..00241c3bcb 100644 --- a/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md @@ -94,9 +94,9 @@ This example imports a chain of certificates from the PKCS #7 file C:\\Certifica ### -FileData The FileData parameter specifies the contents of the certificate file that you want to import. Typically, you use this parameter for PKCS #7 text certificate files that have .p7b or .p7c filename extensions. These text files contain the text: -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- or -----BEGIN PKCS7----- and -----END PKCS7-----. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. -You can use a local path if the certificate file is located on the Exchange server where you're running the command, and this is the same server where you want to install the certificate. Otherwise, use a UNC path (`\\\`). +You can use a local path if the certificate file is located on the Exchange server where you're running the command, and this is the same server where you want to install the certificate. Otherwise, use a UNC path (`\\Server\Share`). If the value contains spaces, enclose the value in quotation marks ("). @@ -263,7 +263,7 @@ Accept wildcard characters: False ### -FileName The FileName parameter specifies the certificate file that you want to import. Typically, you use this parameter for PKCS #12 binary certificate files that have .cer, .crt, .der, .p12, or .pfx filename extensions. This type of binary certificate file is protected by a password when the file contains the private key or chain of trust. -You can use a local path if the certificate file is located on the Exchange server where you're running the command, and this is the same server where you want to install the certificate. Otherwise, use a UNC path (`\\\`). +You can use a local path if the certificate file is located on the Exchange server where you're running the command, and this is the same server where you want to install the certificate. Otherwise, use a UNC path (`\\Server\Share`). If the value contains spaces, enclose the value in quotation marks ("). diff --git a/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md b/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md index cab5d9918f..98d2827b22 100644 --- a/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md +++ b/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md @@ -43,7 +43,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -[Byte[]]$Data = Get-Content -Path "C:\JournalRules\ExportedJournalRules.xml" -Encoding Byte -ReadCount 0; Import-JournalRuleCollection -FileData $Data +[Byte[]]$Data = Get-Content -Path "C:\JournalRules\ExportedJournalRules.xml" -Encoding Byte -ReadCount 0 +Import-JournalRuleCollection -FileData $Data ``` This example imports journal rules from the XML file ExportedJournalRules.xml in a two-step process. @@ -71,7 +72,7 @@ Accept wildcard characters: False ### -FileData The FileData parameter specifies the variable name that contains the content of the XML file. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/Import-RMSTrustedPublishingDomain.md b/exchange/exchange-ps/exchange/Import-RMSTrustedPublishingDomain.md index 2be7b5947a..8a2bfa7d7c 100644 --- a/exchange/exchange-ps/exchange/Import-RMSTrustedPublishingDomain.md +++ b/exchange/exchange-ps/exchange/Import-RMSTrustedPublishingDomain.md @@ -81,8 +81,8 @@ This example imports a TPD from an AD RMS server into a cloud-based organization - Path to exported XML file: C:\\My Documents\\Contoso.xml - Password of exported XML file: Pa$$word1 -- External licensing URL: https://rms.contoso.com/\_wmcs/licensing -- Internal licensing URL: https://RMS01/\_wmcs/licensing +- External licensing URL: `https://rms.contoso.com/_wmcs/licensing` +- Internal licensing URL: `https://RMS01/_wmcs/licensing` - TPD name: Contoso TPD ## PARAMETERS @@ -90,7 +90,7 @@ This example imports a TPD from an AD RMS server into a cloud-based organization ### -ExtranetLicensingUrl The ExtranetLicensingUrl parameter specifies the external licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content. -By default, the value of the ExtranetLicensingUrl parameter is https://\/\_wmcs/licensing. +By default, the value of the ExtranetLicensingUrl parameter is `https:///_wmcs/licensing`. ```yaml Type: Uri @@ -108,7 +108,7 @@ Accept wildcard characters: False ### -FileData The FileData parameter specifies the XML file you want to import. The XML file contains the TPD you exported from the on-premises AD RMS server. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] @@ -126,7 +126,7 @@ Accept wildcard characters: False ### -IntranetLicensingUrl The IntranetLicensingUrl parameter specifies the internal licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content. -By default, the value of the IntranetLicensingUrl parameter is https://\/\_wmcs/licensing. +By default, the value of the IntranetLicensingUrl parameter is `https:///_wmcs/licensing`. ```yaml Type: Uri diff --git a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md b/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md index 36c7d5c424..540ca24c6c 100644 --- a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md +++ b/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md @@ -12,9 +12,7 @@ ms.reviewer: # Import-RecipientDataProperty ## SYNOPSIS -This cmdlet is available only in on-premises Exchange. - -Use the Import-RecipientDataProperty cmdlet to add a picture or an audio file of a spoken name to a mailbox or contact. The picture and audio files display on the Global Address List property dialog box, contact card, reading pane, and meeting requests in Microsoft Outlook and Outlook on the web. +Use the Import-RecipientDataProperty cmdlet to add a picture or an audio file of a spoken name to a mailbox or contact. The picture and audio files display on the global address list property dialog box, contact card, reading pane, and meeting requests in Outlook and Outlook on the web. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -87,7 +85,7 @@ Accept wildcard characters: False ### -FileData The FileData parameter specifies the location and file name of the picture or audio file. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] @@ -122,13 +120,15 @@ Accept wildcard characters: False ``` ### -DomainController +This parameter is available only in on-premises Exchange. + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +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-TransportRuleCollection.md b/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md index dddf08e6a7..742a2f52d4 100644 --- a/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md +++ b/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md @@ -42,10 +42,11 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -[Byte[]]$Data = Get-Content -Path "C:\TransportRules\ExportedRules.xml" -Encoding Byte -ReadCount 0; Import-TransportRuleCollection -FileData $Data +[Byte[]]$Data = Get-Content -Path "C:\TransportRules\ExportedRules.xml" -Encoding Byte -ReadCount 0 +Import-TransportRuleCollection -FileData $Data ``` -This example imports a transport rule collection from the XML file named ExportedRules.xml in the C:\\TransportRules folder. +This example imports a transport rule collection from the XML file named ExportedRules.xml in the C:\\TransportRules folder. **Note**: In PowerShell 6.0 or later, replace `-Encoding Byte` with `-AsByteStream`. @@ -54,7 +55,11 @@ This example imports a transport rule collection from the XML file named Exporte ### -Identity This cmdlet is available only in on-premises Exchange, and is only functional in Exchange Server 2010. -The Identity parameter specifies the transport rule to be imported. Use either the GUID or the name of the rule. You can omit the parameter label. +The Identity parameter specifies the transport rule that you want to import. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml Type: RuleIdParameter @@ -70,7 +75,11 @@ Accept wildcard characters: False ``` ### -FileData -The FileData parameter specifies the variable name that contains the content of the XML file. The content is retrieved using the Get-Content cmdlet. +The FileData parameter specifies the variable name that contains the content of the XML file. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `(Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0)`. + +**Note**: In PowerShell 6.0 or later, replace `-Encoding Byte` with `-AsByteStream`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/Import-UMPrompt.md b/exchange/exchange-ps/exchange/Import-UMPrompt.md index a18fc72ced..5adaca345c 100644 --- a/exchange/exchange-ps/exchange/Import-UMPrompt.md +++ b/exchange/exchange-ps/exchange/Import-UMPrompt.md @@ -67,21 +67,24 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -[byte[]]$c = Get-content -Path "d:\UMPrompts\welcomegreeting.wav" -Encoding Byte -ReadCount 0; Import-UMPrompt -UMDialPlan MyUMDialPlan -PromptFileName "welcomegreeting.wav" -PromptFileData $c +[byte[]]$c = Get-content -Path "d:\UMPrompts\welcomegreeting.wav" -Encoding Byte -ReadCount 0 +Import-UMPrompt -UMDialPlan MyUMDialPlan -PromptFileName "welcomegreeting.wav" -PromptFileData $c ``` This example imports the welcome greeting file welcomegreeting.wav from d:\\UMPrompts into the UM dial plan MyUMDialPlan. ### Example 2 ```powershell -[byte[]]$c = Get-content -Path "d:\UMPrompts\welcomegreeting.wav" -Encoding Byte -ReadCount 0; Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "welcomegreeting.wav" -PromptFileData $c +[byte[]]$c = Get-content -Path "d:\UMPrompts\welcomegreeting.wav" -Encoding Byte -ReadCount 0 +Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "welcomegreeting.wav" -PromptFileData $c ``` This example imports the welcome greeting file welcomegreeting.wav from d:\\UMPrompts into the UM auto attendant MyUMAutoAttendant. ### Example 3 ```powershell -[byte[]]$c = Get-content -Path "d:\UMPrompts\AfterHoursWelcomeGreeting.wav" -Encoding Byte -ReadCount 0; Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "AfterHoursWelcomeGreeting.wav" -PromptFileData $c +[byte[]]$c = Get-content -Path "d:\UMPrompts\AfterHoursWelcomeGreeting.wav" -Encoding Byte -ReadCount 0 +Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "AfterHoursWelcomeGreeting.wav" -PromptFileData $c ``` This example imports the welcome greeting file AfterHoursWelcomeGreeting.wav from d:\\UMPrompts into the UM auto attendant MyUMAutoAttendant. diff --git a/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md b/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md index daf346b36d..0997f14b36 100644 --- a/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md +++ b/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md @@ -329,7 +329,7 @@ Accept wildcard characters: False ### -SkipActiveCopyChecks The SkipActiveCopyChecks switch specifies whether to skip checking the current active copy to see if it's currently a seeding source for any passive databases. You don't need to specify a value with this switch. -Note: When you use this switch, you can move a database that's currently a seeding source, which cancels the seed operation. +**Note**: When you use this switch, you can move a database that's currently a seeding source, which cancels the seed operation. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/Move-AddressList.md b/exchange/exchange-ps/exchange/Move-AddressList.md index 725851d845..d2545d6897 100644 --- a/exchange/exchange-ps/exchange/Move-AddressList.md +++ b/exchange/exchange-ps/exchange/Move-AddressList.md @@ -48,7 +48,7 @@ The Identity parameter specifies the address list that you want to move. You can - Name - Distinguished name (DN) - GUID -- Path: (\\\) or [\\\\) +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) ```yaml Type: AddressListIdParameter @@ -69,7 +69,7 @@ The Container parameter specifies where to move the address list. Valid input fo - Name - Distinguished name (DN) - GUID -- Path: (\\\) or [\\\\) +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) ```yaml Type: AddressListIdParameter diff --git a/exchange/exchange-ps/exchange/Move-DatabasePath.md b/exchange/exchange-ps/exchange/Move-DatabasePath.md index 70f4334722..57a8f3a4ec 100644 --- a/exchange/exchange-ps/exchange/Move-DatabasePath.md +++ b/exchange/exchange-ps/exchange/Move-DatabasePath.md @@ -125,7 +125,7 @@ Accept wildcard characters: False ``` ### -EDBFilePath -The EdbFilePath parameter specifies a new file path for the database. All current database files are moved to this location. The default location is \\\Mailbox\\LocalCopies\\MBDatabase.edb. This file path can't be the same as the path for the backup copy of the database. +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 @@ -189,7 +189,7 @@ Accept wildcard characters: False ``` ### -EDBFilePath -The EdbFilePath parameter specifies a new file path for the database. All current database files are moved to this location. The default location is \\\Mailbox\\LocalCopies\\MBDatabase.edb. This file path can't be the same as the path for the backup copy of the database. +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 diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md index b37ffa6a98..1a388492ef 100644 --- a/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-ActiveSyncMailboxPolicy cmdlet to create a Microsoft Mobile Device mailbox policy object. -Note: In Exchange 2013 or later, use the New-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use New-ActiveSyncMailboxPolicy, update them to use New-MobileDeviceMailboxPolicy. +**Note**: In Exchange 2013 or later, use the New-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use New-ActiveSyncMailboxPolicy, update them to use New-MobileDeviceMailboxPolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md index 26cbc3489a..0b986eb965 100644 --- a/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md @@ -164,7 +164,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -186,9 +186,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/New-ActivityAlert.md b/exchange/exchange-ps/exchange/New-ActivityAlert.md index 8a703775fd..f2e9ab9422 100644 --- a/exchange/exchange-ps/exchange/New-ActivityAlert.md +++ b/exchange/exchange-ps/exchange/New-ActivityAlert.md @@ -131,7 +131,7 @@ Accept wildcard characters: False ### -NotifyUser The NotifyUser parameter specifies the email addressesfor notification messages. You can specify internal and external email addresses. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -225,7 +225,7 @@ The Type parameter specifies the type alert. Valid values are: - SimpleAggregation: An alert is created based on the activities defined by the Operation and Condition parameters, the number of activities specified by the Threshold parameter, and the time period specified by the TimeWindow parameter. - AnomalousAggregation: An alert is created based the activities defined by the Operation and Condition parameters, and the number of activities specified by the Multiplier parameter. -Note: You can't change the Type value in an existing activity alert. +**Note**: You can't change the Type value in an existing activity alert. ```yaml Type: AlertType diff --git a/exchange/exchange-ps/exchange/New-AddressList.md b/exchange/exchange-ps/exchange/New-AddressList.md index 1b46988ccc..1a2be3771b 100644 --- a/exchange/exchange-ps/exchange/New-AddressList.md +++ b/exchange/exchange-ps/exchange/New-AddressList.md @@ -555,7 +555,7 @@ The Container parameter specifies where to create the address list. Valid input - Name - Distinguished name (DN) - GUID -- Path: (\\\) or [\\\\) +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) If you don't use this parameter,the address list is created under the root (\\). diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md index 2bdb49eca5..726bc36f39 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md @@ -27,13 +27,13 @@ New-AntiPhishPolicy [-Name] [-AdminDisplayName ] [-AuthenticationFailAction ] [-Confirm] - [-EnableAntiSpoofEnforcement ] [-Enabled ] [-EnableMailboxIntelligence ] [-EnableMailboxIntelligenceProtection ] [-EnableOrganizationDomainsProtection ] [-EnableSimilarDomainsSafetyTips ] [-EnableSimilarUsersSafetyTips ] + [-EnableSpoofIntelligence ] [-EnableTargetedDomainsProtection ] [-EnableTargetedUserProtection ] [-EnableUnauthenticatedSender ] @@ -71,7 +71,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi New-AntiPhishPolicy -Name "Research Quarantine" -AdminDisplayName "Research department policy" -EnableOrganizationDomainsProtection $true -EnableTargetedDomainsProtection $true -TargetedDomainsToProtect fabrikam.com -TargetedDomainProtectionAction Quarantine -EnableTargetedUserProtection $true -TargetedUsersToProtect "Mai Fujito;mfujito@fabrikam.com" -TargetedUserProtectionAction Quarantine -EnableMailboxIntelligenceProtection $true -MailboxIntelligenceProtectionAction Quarantine -EnableSimilarUsersSafetyTips $true -EnableSimilarDomainsSafetyTips $true -EnableUnusualCharactersSafetyTips $true ``` -In Advanced Threat Protection, this example creates and enables an antiphish policy named Research Quarantine with the following settings: +In Microsoft Defender for Office 365, this example creates and enables an antiphish policy named Research Quarantine with the following settings: - The description is: Research department policy. - Enables organization domains protection for all accepted domains, and targeted domains protection for fabrikam.com. @@ -153,27 +153,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAntispoofEnforcement -This setting is part of spoof protection. - -The EnableAntispoofEnforcement parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: - -- $true: Antispoofing is enabled for the policy. This is the default and recommended value. You specify the spoofed senders to allow or block using the Set-PhishFilterPolicy cmdlet. -- $false: Antispoofing is disabled for the policy. We only recommend this value if you have a domain that's protected by another email filtering service. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Enabled The Enabled parameter specifies whether the policy is enabled. Valid values are: @@ -194,7 +173,7 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligence -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence (artificial intelligence that determines user email patterns with their frequent contacts). Valid values are: @@ -215,7 +194,7 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligenceProtection -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableMailboxIntelligenceProtection specifies whether to enable or disable enhanced impersonation results based on each user's individual sender map. This intelligence allows Microsoft 365 to customize user impersonation detection and better handle false positives. Valid values are: @@ -236,7 +215,7 @@ Accept wildcard characters: False ``` ### -EnableOrganizationDomainsProtection -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Microsoft 365 organization. Valid values are: @@ -257,7 +236,7 @@ Accept wildcard characters: False ``` ### -EnableSimilarDomainsSafetyTips -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for domain impersonation detections. Valid values are: @@ -278,7 +257,7 @@ Accept wildcard characters: False ``` ### -EnableSimilarUsersSafetyTips -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for user impersonation detections. Valid values are: @@ -298,8 +277,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableSpoofIntelligence +This setting is part of spoof protection. + +The EnableSpoofIntelligence parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: + +- $true: Antispoofing is enabled for the policy. This is the default and recommended value. You specify the spoofed senders to allow or block using the Set-PhishFilterPolicy cmdlet. +- $false: Antispoofing is disabled for the policy. We only recommend this value if you have a domain that's protected by another email filtering service. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EnableTargetedDomainsProtection -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableTargetedDomainsProtection parameter specifies whether to enable domain impersonation protection for a list of specified domains. Valid values are: @@ -320,7 +320,7 @@ Accept wildcard characters: False ``` ### -EnableTargetedUserProtection -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for a list of specified users. Valid values are: @@ -345,7 +345,7 @@ This setting is part of spoof protection. The EnableUnauthenticatedSender parameter enables or disables unauthenticated sender identification in Outlook. Valid values are: -- $true: This is the default value. A question mark (?) is applied to the sender's photo if the message does not pass SPF or DKIM checks AND the message does not pass DMARC or composite authentication. The via tag (chris@contoso.com via michelle@fabrikam.com) is added if the domain in the From address (the message sender that's displayed in email clients) is different from the domain in the DKIM signature or the MAIL FROM address. +- $true: This is the default value. A question mark (?) is applied to the sender's photo if the message does not pass SPF or DKIM checks AND the message does not pass DMARC or composite authentication. The via tag (chris@contoso.com via fabrikam.com) is added if the domain in the From address (the message sender that's displayed in email clients) is different from the domain in the DKIM signature or the MAIL FROM address. - $false: A question mark is never applied to the sender's photo. The via tag is still added if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. To prevent these identifiers from being added to messages from specific senders, you have the following options: @@ -367,7 +367,7 @@ Accept wildcard characters: False ``` ### -EnableUnusualCharactersSafetyTips -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for unusual characters in domain and user impersonation detections. Valid values are: @@ -388,7 +388,7 @@ Accept wildcard characters: False ``` ### -ExcludedDomains -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. @@ -406,7 +406,7 @@ Accept wildcard characters: False ``` ### -ExcludedSenders -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. @@ -424,7 +424,7 @@ Accept wildcard characters: False ``` ### -ImpersonationProtectionState -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The ImpersonationProtectionState parameter specifies the configuration of impersonation protection. Valid values are: @@ -446,7 +446,7 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionAction -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionAction parameter specifies what to do with messages that fail mailbox intelligence protection. Valid values are: @@ -471,7 +471,7 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionActionRecipients -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionActionRecipients parameter specifies the recipients to add to detected messages when the MailboxIntelligenceProtectionAction parameter is set to the value Redirect or BccMessage. @@ -491,7 +491,7 @@ Accept wildcard characters: False ``` ### -PhishThresholdLevel -This setting is part of advanced settings and is only available in Advanced Threat Protection. +This setting is part of advanced settings and is only available in Microsoft Defender for Office 365. The PhishThresholdLevel parameter specifies the tolerance level that's used by machine learning in the handling of phishing messages. Valid values are: @@ -546,7 +546,7 @@ Accept wildcard characters: False ``` ### -TargetedDomainActionRecipients -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. @@ -566,7 +566,7 @@ Accept wildcard characters: False ``` ### -TargetedDomainProtectionAction -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: @@ -591,7 +591,7 @@ Accept wildcard characters: False ``` ### -TargetedDomainsToProtect -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedDomainsToProtect parameter specifies the domains that are included in domain impersonation protection when the EnableTargetedDomainsProtection parameter is set to $true. @@ -611,13 +611,12 @@ Accept wildcard characters: False ``` ### -TargetedUserActionRecipients -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. - ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -632,7 +631,7 @@ Accept wildcard characters: False ``` ### -TargetedUserProtectionAction -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: @@ -657,7 +656,7 @@ Accept wildcard characters: False ``` ### -TargetedUsersToProtect -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedUsersToProtect parameter specifies the users that are included in user impersonation protection when the EnableTargetedUserProtection parameter is set to $true. diff --git a/exchange/exchange-ps/exchange/New-AntiPhishRule.md b/exchange/exchange-ps/exchange/New-AntiPhishRule.md index 2059e154b2..85e92366b4 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishRule.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishRule.md @@ -179,7 +179,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -204,7 +204,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception that looks for messa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. @@ -271,7 +271,7 @@ The SentTo parameter specifies a condition that looks for recipients in messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -296,7 +296,7 @@ The SentToMemberOf parameter specifies a condition that looks for messages sent - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. diff --git a/exchange/exchange-ps/exchange/New-App.md b/exchange/exchange-ps/exchange/New-App.md index 5d2fe34c6b..6fb9eeeb6f 100644 --- a/exchange/exchange-ps/exchange/New-App.md +++ b/exchange/exchange-ps/exchange/New-App.md @@ -255,7 +255,7 @@ Accept wildcard characters: False ### -FileData The FileData parameter specifies the location of the app manifest file. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] @@ -463,7 +463,9 @@ Accept wildcard characters: False ``` ### -UserList -The UserList parameter specifies who can use an organizational app. Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. For example: +The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). + +Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. For example: - Name - Alias @@ -476,7 +478,7 @@ The UserList parameter specifies who can use an organizational app. Valid values - SamAccountName - User ID or user principal name (UPN) -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You use this parameter with the OrganizationApp switch. diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md index d2d3f9126c..36aeb576c8 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md @@ -72,7 +72,7 @@ Accept wildcard characters: False ``` ### -ApplySensitivityLabel -The AppleSensitivityLabel parameter specifies which label to use for the autolabel policy. +The ApplySensitivityLabel parameter specifies the label to use for the autolabel policy. ```yaml Type: String @@ -155,7 +155,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -205,7 +205,7 @@ Accept wildcard characters: False ### -ExchangeSenderMemberOf The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the auto-labeling policy. You identify the group by its email address. -To enter multiple values, use the following syntax: \,\,...\. +You can enter multiple values separated by commas. ```yaml Type: SmtpAddress[] @@ -223,7 +223,7 @@ Accept wildcard characters: False ### -ExchangeSenderMemberOfException The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the auto-labeling policy. You identify the group by its email address. -To enter multiple values, use the following syntax: \,\,...\. +You can enter multiple values separated by commas. You can't use this parameter to specify Microsoft 365 Groups. @@ -280,7 +280,7 @@ Accept wildcard characters: False ### -OneDriveLocation The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value. The value All is currently not supported. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -298,7 +298,7 @@ Accept wildcard characters: False ### -OneDriveLocationException This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -331,7 +331,7 @@ Accept wildcard characters: False ### -SharePointLocation The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value. The value All is currently not supported. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". SharePoint Online sites can't be added to a policy until they have been indexed. +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to a policy until they have been indexed. ```yaml Type: MultiValuedProperty @@ -349,7 +349,7 @@ Accept wildcard characters: False ### -SharePointLocationException This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md index 263966eec8..aea63fb6db 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md @@ -183,7 +183,7 @@ Accept wildcard characters: False ### -ContentContainsSensitiveInformation The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. -This parameter uses the basic syntax @(@{Name="\";[minCount="\"],@{Name="\";[minCount="\"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). +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"})`. ```yaml Type: PswsHashtable[] @@ -295,7 +295,7 @@ Accept wildcard characters: False ### -ExceptIfContentContainsSensitiveInformation The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the auto-labeling policy rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. -This parameter uses the basic syntax @(@{Name="\";[minCount="\"],@{Name="\";[minCount="\"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). ```yaml Type: PswsHashtable[] @@ -390,7 +390,7 @@ Accept wildcard characters: False ### -ExceptIfFromMemberOf The ExceptIfFromMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent by group members. You identify the group members by their email addresses. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: SmtpAddress[] @@ -472,7 +472,7 @@ The ExceptIfSentTo parameter specifies an exception for the auto-labeling policy - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -699,7 +699,7 @@ The SentTo parameter specifies a condition for the auto-sensitivity policy rule - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use this condition in auto-sensitivity policies that are scoped only to Exchange. diff --git a/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md index 8328e1f287..a27e86e807 100644 --- a/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md @@ -192,7 +192,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -214,9 +214,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md index bb174ce4fa..049a395700 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md @@ -154,7 +154,7 @@ To specify a mailbox or distribution group, you can use the following values: - SMTP address - Azure AD ObjectId (You can use the [Get-AzureADUser](https://docs.microsoft.com/powershell/module/azuread/get-azureaduser) cmdlet to obtain this value.) -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If no mailboxes are specified, then no mailboxes are placed on hold. @@ -206,7 +206,7 @@ Accept wildcard characters: False ### -SharePointLocation The SharePointLocation parameter specifies the SharePoint Online and OneDrive for Business sites to include. You identify a site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. Sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. diff --git a/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md index 6cb8f67b5b..5fc018b5e8 100644 --- a/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md @@ -47,7 +47,7 @@ This example imports the classification rule collection file C:\\My Documents\\E ### -FileData The FileData parameter specifies the classification rule collection file you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/exchange/New-ClientAccessRule.md index 3efef0cd86..ede06de2cb 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/New-ClientAccessRule.md @@ -43,7 +43,7 @@ New-ClientAccessRule [-Name] -Action ## DESCRIPTION Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. -Note: Currently, not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: +**Note**: Currently, not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: - ExchangeActiveSync: BasicAuthentication, OAuthAuthentication, and CertificateBasedAuthentication. - ExchangeAdminCenter: BasicAuthentication and AdfsAuthentication. @@ -330,7 +330,7 @@ Accept wildcard characters: False ### -ExceptUsernameMatchesAnyOfPatterns This parameter is available only in the cloud-based service. -The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that's based on the user's account name in the format \\\\ (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. +The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. You can enter multiple values separated by commas. @@ -393,7 +393,7 @@ Accept wildcard characters: False ### -UsernameMatchesAnyOfPatterns This parameter is available only in the cloud-based service. -The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that's based on the user's account name in the format \\\\ (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. +The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. This parameter does not work with the -AnyOfProtocols UniversalOutlook parameter. You can enter multiple values separated by commas. diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearch.md b/exchange/exchange-ps/exchange/New-ComplianceSearch.md index 6d79b8bd86..112d69b676 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSearch.md @@ -431,7 +431,7 @@ Accept wildcard characters: False ### -SharePointLocation The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] @@ -449,7 +449,7 @@ Accept wildcard characters: False ### -SharePointLocationExclusion This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md index a7fd5b9ad7..0cfb82185b 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md @@ -453,7 +453,7 @@ Accept wildcard characters: False ### -Purge The Purge switch specifies the action for the content search is to remove items that match the search criteria. You don't need to specify a value with this switch. -Notes: +**Notes**: - A maximum of 10 items per mailbox can be removed at one time. Because the capability to search for and remove messages is intended to be an incident-response tool, this limit helps ensure that messages are quickly removed from mailboxes. This action isn't intended to clean up user mailboxes. - You can remove items from a maximum of 50,000 mailboxes using a single content search. To remove items from more than 50,000 mailboxes, you'll have to create separate content searches. For more information, see [Search for and delete email messages in your Microsoft 365 organization](https://docs.microsoft.com/microsoft-365/compliance/search-for-and-delete-messages-in-your-organization). diff --git a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md index 6bd65c9146..2941c3781d 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md @@ -60,7 +60,8 @@ This example allows members of the US Discovery Managers role group to perform a ### Example 4 ```powershell -$DG = Get-DistributionGroup "Ottawa Users"; New-ComplianceSecurityFilter -FilterName DGFilter -Users eDiscoveryManager -Filters "Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'" -Action Search +$DG = Get-DistributionGroup "Ottawa Users" +New-ComplianceSecurityFilter -FilterName DGFilter -Users eDiscoveryManager -Filters "Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'" -Action Search ``` This example assigns allows members of the eDiscovery Manager role group to only search the mailboxes of members of the Ottawa Users distribution group. @@ -69,7 +70,8 @@ This example requires you to connect to Security & Compliance Center PowerShell ### Example 5 ```powershell -$DG = Get-DistributionGroup "Executive Team"; New-ComplianceSecurityFilter -FilterName NoExecutivesPreview -Users all -Filters "Mailbox_MemberOfGroup -ne '$($DG.DistinguishedName)'" -Action Purge +$DG = Get-DistributionGroup "Executive Team" +New-ComplianceSecurityFilter -FilterName NoExecutivesPreview -Users all -Filters "Mailbox_MemberOfGroup -ne '$($DG.DistinguishedName)'" -Action Purge ``` This example prevents any user from deleting content from the mailboxes of members of the Executive Team distribution group. diff --git a/exchange/exchange-ps/exchange/New-DataClassification.md b/exchange/exchange-ps/exchange/New-DataClassification.md index 7c1a82b975..96fed502fa 100644 --- a/exchange/exchange-ps/exchange/New-DataClassification.md +++ b/exchange/exchange-ps/exchange/New-DataClassification.md @@ -41,7 +41,11 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$Employee_Template = Get-Content "C:\My Documents\Contoso Employee Template.docx" -Encoding byte; $Employee_Fingerprint = New-Fingerprint -FileData $Employee_Template -Description "Contoso Employee Template"; $Customer_Template = Get-Content "D:\Data\Contoso Customer Template.docx" -Encoding byte; $Customer_Fingerprint = New-Fingerprint -FileData $Customer_Template -Description "Contoso Customer Template"; New-DataClassification -Name "Contoso Employee-Customer Confidential" -Fingerprints $Employee_Fingerprint,$Customer_Fingerprint -Description "Message contains Contoso employee or customer information." +$Employee_Template = Get-Content "C:\My Documents\Contoso Employee Template.docx" -Encoding byte +$Employee_Fingerprint = New-Fingerprint -FileData $Employee_Template -Description "Contoso Employee Template" +$Customer_Template = Get-Content "D:\Data\Contoso Customer Template.docx" -Encoding byte +$Customer_Fingerprint = New-Fingerprint -FileData $Customer_Template -Description "Contoso Customer Template" +New-DataClassification -Name "Contoso Employee-Customer Confidential" -Fingerprints $Employee_Fingerprint,$Customer_Fingerprint -Description "Message contains Contoso employee or customer information." ``` This example creates a new data classification rule named "Contoso Employee-Customer Confidential" that uses the document fingerprints of the files C:\\My Documents\\Contoso Employee Template.docx and D:\\Data\\Contoso Customer Template.docx. diff --git a/exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md index 8ceebf206a..4e454cfcc0 100644 --- a/exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/New-DataEncryptionPolicy.md @@ -51,9 +51,9 @@ This example creates a data encryption policy named US Mailboxes with the specif ## PARAMETERS ### -AzureKeyIDs -The AzureKeyIDs parameter specifies the URI values of the Azure Key Vault keys to associate with the data encryption policy. You need to specify at least two Azure Key Vault keys separated by commas. For example, "https://contosoWestUSvault01.vault.azure.net/keys/USA\_Key\_01","https://contosoEastUSvault01.vault.azure.net/keys/USA\_Key\_02" +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://docs.microsoft.com/azure/key-vault/general/overview). +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://docs.microsoft.com/azure/key-vault/general/overview). ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md b/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md index e71e54e1a6..223ccfe733 100644 --- a/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md @@ -62,7 +62,7 @@ The address space for the connector is c=US;a=Fabrikam;p=Contoso. ## PARAMETERS ### -AddressSpaces -The AddressSpaces parameter specifies the domain names for which this delivery agent connector is responsible. The syntax for entering an address space is as follows: \:\;\. You must enclose each address space in quotation marks ("). +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 diff --git a/exchange/exchange-ps/exchange/New-DistributionGroup.md b/exchange/exchange-ps/exchange/New-DistributionGroup.md index 07cfb441a6..765b8fdb56 100644 --- a/exchange/exchange-ps/exchange/New-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/New-DistributionGroup.md @@ -100,9 +100,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -289,7 +289,7 @@ The owner you specify for this parameter must be a mailbox, mail user or mail-en - SamAccountName - User ID or user principal name (UPN) -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. An owner that you specify with this parameter isn't automatically a member of the group. You need to manually add the owner as a member. @@ -357,7 +357,7 @@ The Members parameter specifies the recipients (mail-enabled objects) that are m - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. After you create the group, you use the Get-DistributionGroupMember cmdlet to view the group members, and the Add-DistributionGroupMember, Remove-DistributionGroupMember, and Update-DistributionGroupMember cmdlets to manage group membership. @@ -386,7 +386,7 @@ The ModeratedBy parameter specifies one or more moderators for this group. A mod - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. For mail-enabled security groups, you need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -539,7 +539,7 @@ Accept wildcard characters: False ### -SamAccountName This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md index 64f11377ba..122af671c4 100644 --- a/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-DlpCompliancePolicy.md @@ -133,7 +133,7 @@ Accept wildcard characters: False ### -ExchangeSenderMemberOf The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the DLP policy. You identify the group by its email address. -To enter multiple values, use the following syntax: \,\,...\. +You can enter multiple values separated by commas. You can't use this parameter to specify Microsoft 365 Groups. @@ -153,7 +153,7 @@ Accept wildcard characters: False ### -ExchangeSenderMemberOfException The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the DLP policy. You identify the group by its email address. -To enter multiple values, use the following syntax: \,\,...\. +You can enter multiple values separated by commas. You can't use this parameter to specify Microsoft 365 Groups. @@ -210,7 +210,7 @@ Accept wildcard characters: False ### -OneDriveLocation The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value, or you can use the value All to include all sites. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -228,7 +228,7 @@ Accept wildcard characters: False ### -OneDriveLocationException This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -270,7 +270,7 @@ Accept wildcard characters: False ### -SharePointLocation The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". SharePoint Online sites can't be added to a policy until they have been indexed. +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to a policy until they have been indexed. ```yaml Type: MultiValuedProperty @@ -288,7 +288,7 @@ Accept wildcard characters: False ### -SharePointLocationException This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -338,7 +338,7 @@ Accept wildcard characters: False ### -TeamsLocation The TeamsLocation parameter specifies the Teams accounts to include in the DLP policy. You identify the account by its name or email address, or you can use the value All to include all accounts. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -356,7 +356,7 @@ Accept wildcard characters: False ### -TeamsLocationException The TeamsLocation parameter specifies the Teams accounts to exclude form the DLP policy when you use the value All for the TeamsLocation parameter. You identify the account by its name or email address. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index b418da7bb6..13fdf48247 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -27,10 +27,12 @@ New-DlpComplianceRule [-Name] -Policy [-AddRecipients ] [-AnyOfRecipientAddressContainsWords ] [-AnyOfRecipientAddressMatchesPatterns ] + [-ApplyHtmlDisclaimer ] [-BlockAccess ] [-BlockAccessScope ] [-Comment ] [-Confirm] + [-ContentCharacterSetContainsWords ] [-ContentContainsSensitiveInformation ] [-ContentExtensionMatchesWords ] [-ContentPropertyContainsWords ] @@ -44,6 +46,7 @@ New-DlpComplianceRule [-Name] -Policy [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] + [-ExceptIfContentCharacterSetContainsWords ] [-ExceptIfContentContainsSensitiveInformation ] [-ExceptIfContentExtensionMatchesWords ] [-ExceptIfContentPropertyContainsWords ] @@ -55,8 +58,11 @@ New-DlpComplianceRule [-Name] -Policy [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] [-ExceptIfFromAddressMatchesPatterns ] + [-ExceptIfFromScope ] + [-ExceptIfHasSenderOverride ] [-ExceptIfHeaderContainsWords ] [-ExceptIfHeaderMatchesPatterns ] + [-ExceptIfMessageTypeMatches ] [-ExceptIfProcessingLimitExceeded ] [-ExceptIfRecipientDomainIs ] [-ExceptIfSenderDomainIs ] @@ -65,23 +71,30 @@ New-DlpComplianceRule [-Name] -Policy [-ExceptIfSentToMemberOf ] [-ExceptIfSubjectContainsWords ] [-ExceptIfSubjectMatchesPatterns ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-ExceptIfSubjectOrBodyMatchesPatterns ] + [-ExceptIfWithImportance ] [-ExpiryDate ] [-From ] [-FromAddressContainsWords ] [-FromAddressMatchesPatterns ] [-FromMemberOf ] + [-FromScope ] [-GenerateAlert ] [-GenerateIncidentReport ] + [-HasSenderOverride ] [-HeaderContainsWords ] [-HeaderMatchesPatterns ] [-ImmutableId ] [-IncidentReportContent ] + [-MessageTypeMatches ] [-Moderate ] [-NotifyAllowOverride ] [-NotifyEmailCustomText ] [-NotifyPolicyTipCustomText ] [-NotifyPolicyTipCustomTextTranslations ] [-NotifyUser ] + [-PrependSubject ] [-Priority ] [-ProcessingLimitExceeded ] [-RecipientDomainIs ] @@ -97,7 +110,10 @@ New-DlpComplianceRule [-Name] -Policy [-StopPolicyProcessing ] [-SubjectContainsWords ] [-SubjectMatchesPatterns ] + [-SubjectOrBodyContainsWords ] + [-SubjectOrBodyMatchesPatterns ] [-WhatIf] + [-WithImportance ] [] ``` @@ -255,6 +271,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ApplyHtmlDisclaimer +The ApplyHtmlDisclaimer parameter specifies an action for the rule that adds disclaimer text to messages.This parameter uses the syntax: `@{Text = "Disclaimer text"; Location = ; FallbackAction = }`. + +- Text: Specifies the disclaimer text to add. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. +- Location: Specifies where to insert the HTML disclaimer text in the body of messages. Append = Add to the end of the message body. Prepend = Insert at the beginning of the message body. +- FallbackAction: Specifies what to do if the HTML disclaimer can't be added to a message. Wrap = The original message is wrapped in a new message envelope, and the disclaimer is used as the message body for the new message. Ignore = The rule is ignored and the message is delivered without the disclaimer. Reject = The message is rejected. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BlockAccess The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: @@ -329,6 +367,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContentCharacterSetContainsWords +The ContentCharacterSetContainsWords parameter specifies a condition for the rule that looks for character set names in messages. You can specify multiple values separated by commas. + +Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ContentContainsSensitiveInformation The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. @@ -590,6 +646,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExceptIfContentCharacterSetContainsWords +The ExceptIfContentCharacterSetContainsWords parameter specifies an exception for the rule that looks for character set names in messages. + +To specify multiple words, this parameter uses the syntax: `Word1,word2,...wordN`. Don't use leading or trailing spaces. + +Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExceptIfContentContainsSensitiveInformation The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. @@ -812,6 +888,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExceptIfFromScope +The ExceptIfFromScope parameter specifies an exception for the rule that looks for the location of message senders. Valid values are: + +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: FromScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHasSenderOverride +The ExceptIfHasSenderOverride parameter specifies an exception for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: + +- $true: Look for messages where the sender took action to override a DLP policy. +- $false: Don't look for messages where the sender took action to override a DLP policy. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExceptIfHeaderContainsWords The HeaderContainsWords parameter specifies an exception for the DLP rule that looks for words in a header field. @@ -850,6 +968,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExceptIfMessageTypeMatches +The ExceptIfMessageTypeMatches parameter specifies an exception for the rule that looks for messages of the specified type. Valid values are: + +- ApprovalRequest: Moderation request messages sent to moderators. +- AutomaticForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). +- AutomaticReply: Out of office (OOF) messages configured by the user. +- Calendaring: Meeting requests and responses. +- Encrypted: Encrypted messages. +- PermissionControlled: Messages that have specific permissions configured. +- ReadReceipt: Read receipts. +- Signed: Digitally signed messages. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MessageTypes +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExceptIfProcessingLimitExceeded The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP rule that looks for files where scanning couldn't complete. Valid values are: @@ -1005,6 +1150,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExceptIfSubjectOrBodyContainsWords +The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the rule that looks for words in the Subject field or body of messages. + +To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyMatchesPatterns +The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfWithImportance +The ExceptIfWithImportance parameter specifies an exception for the rule that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: WithImportance +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExpiryDate This parameter is reserved for internal Microsoft use. @@ -1099,6 +1304,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FromScope +The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: + +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: FromScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GenerateAlert The GenerateAlert parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: @@ -1143,6 +1369,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HasSenderOverride +The SenderOverride parameter specifies a condition for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: + +- $true: Look for messages where the sender took action to override a DLP policy. +- $false: Don't look for messages where the sender took action to override a DLP policy. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HeaderContainsWords The HeaderContainsWords parameter specifies a condition for the DLP rule that looks for words in a header field. @@ -1236,6 +1483,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MessageTypeMatches +The MessageTypeMatches parameter specifies a condition for the rule that looks for messages of the specified type. Valid values are: + +- ApprovalRequest: Moderation request messages sent to moderators. +- AutomaticForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). +- AutomaticReply: Out of office (OOF) messages configured by the user. +- Calendaring: Meeting requests and responses. +- Encrypted: Encrypted messages. +- PermissionControlled: Messages that have specific permissions configured. +- ReadReceipt: Read receipts. +- Signed: Digitally signed messages. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MessageTypes +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Moderate The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser = @("emailaddress1","emailaddress2",..."emailaddressN")}`. @@ -1353,6 +1627,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PrependSubject +The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). + +Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Priority The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. @@ -1649,6 +1943,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SubjectOrBodyContainsWords +The SubjectOrBodyContainsWords parameter specifies a condition for the rule that looks for words in the Subject field or body of messages. + +To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectOrBodyMatchesPatterns +The SubjectOrBodyMatchesPatterns parameter specifies a condition for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf The WhatIf switch doesn't work in Security & Compliance Center PowerShell. @@ -1665,6 +1997,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WithImportance +The WithImportance parameter specifies a condition for the rule that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: WithImportance +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). diff --git a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md b/exchange/exchange-ps/exchange/New-DlpEdmSchema.md index 330f6aac8b..82a060c7d6 100644 --- a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/New-DlpEdmSchema.md @@ -36,7 +36,8 @@ You need to be assigned permissions in the Security & Compliance Center before y ### Example 1 ```powershell -$edmSchemaXml = Get-Content "C:\My Documents\edm.xml" -Encoding Byte -ReadCount 0; New-DlpEdmSchema -FileData $edmSchemaXml -Confirm:$true +$edmSchemaXml = Get-Content "C:\My Documents\edm.xml" -Encoding Byte -ReadCount 0 +New-DlpEdmSchema -FileData $edmSchemaXml -Confirm:$true ``` This example creates a new DLP EDM schema. The first command reads the schema in the XML file to a variable, and the second command uses that information to create the DLP EDM schema. @@ -46,7 +47,7 @@ This example creates a new DLP EDM schema. The first command reads the schema in ### -FileData The FileData parameter specifies the DLP EDM schema that you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/New-DlpFingerprint.md b/exchange/exchange-ps/exchange/New-DlpFingerprint.md index 6080595194..9409255da4 100644 --- a/exchange/exchange-ps/exchange/New-DlpFingerprint.md +++ b/exchange/exchange-ps/exchange/New-DlpFingerprint.md @@ -36,7 +36,8 @@ You need to be assigned permissions in the Security & Compliance Center before y ### Example 1 ```powershell -$Patent_Template = Get-Content "C:\My Documents\Contoso Patent Template.docx" -Encoding byte; $Patent_Fingerprint = New-DlpFingerprint -FileData $Patent_Template -Description "Contoso Patent Template" +$Patent_Template = Get-Content "C:\My Documents\Contoso Patent Template.docx" -Encoding byte +$Patent_Fingerprint = New-DlpFingerprint -FileData $Patent_Template -Description "Contoso Patent Template" ``` This example creates a new document fingerprint based on the file C:\\My Documents\\Contoso Patent Template.docx. You store the new fingerprint as a variable so you can use it with the New-DlpSensitiveInformationType cmdlet in the same PowerShell session. diff --git a/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md index a35d60c8dd..1c2bf5c6d8 100644 --- a/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md @@ -38,8 +38,8 @@ You need to be assigned permissions in the Security & Compliance Center before y ### Example 1 ```powershell -$Keywords = @("Aarskog's syndrome","Abandonment","Abasia","Abderhalden-Kaufmann-Lignac","Abdominalgia","Abduction contracture","Abetalipo proteinemia","Abiotrophy","Ablatio","ablation","Ablepharia","Abocclusion","Abolition","Aborter","Abortion","Abortus","Aboulomania","Abrami's disease","Abramo"); -$EncodedKeywords = $Keywords | ForEach-Object{[System.Text.Encoding]::UTF8.GetBytes($_+"`r`n")}; +$Keywords = @("Aarskog's syndrome","Abandonment","Abasia","Abderhalden-Kaufmann-Lignac","Abdominalgia","Abduction contracture","Abetalipo proteinemia","Abiotrophy","Ablatio","ablation","Ablepharia","Abocclusion","Abolition","Aborter","Abortion","Abortus","Aboulomania","Abrami's disease","Abramo") +$EncodedKeywords = $Keywords | ForEach-Object{[System.Text.Encoding]::UTF8.GetBytes($_+"`r`n")} New-DlpKeywordDictionary -Name "Diseases" -Description "Names of diseases and injuries from ICD-10-CM lexicon" -FileData $EncodedKeywords ``` @@ -47,8 +47,8 @@ This example creates a DLP keyword dictionary named Diseases by using the specif ### Example 2 ```powershell -$Keywords = Get-Content "C:\My Documents\InappropriateTerms.txt"; -$EncodedKeywords = $Keywords | ForEach-Object{[System.Text.Encoding]::UTF8.GetBytes($_+"`r`n")}; +$Keywords = Get-Content "C:\My Documents\InappropriateTerms.txt" +$EncodedKeywords = $Keywords | ForEach-Object{[System.Text.Encoding]::UTF8.GetBytes($_+"`r`n")} New-DlpKeywordDictionary -Name "Inappropriate Language" -Description "Unprofessional and inappropriate terminology" -FileData $EncodedKeywords ``` diff --git a/exchange/exchange-ps/exchange/New-DlpPolicy.md b/exchange/exchange-ps/exchange/New-DlpPolicy.md index 95ac461a2f..11c751c257 100644 --- a/exchange/exchange-ps/exchange/New-DlpPolicy.md +++ b/exchange/exchange-ps/exchange/New-DlpPolicy.md @@ -145,7 +145,7 @@ Accept wildcard characters: False ### -Parameters The Parameters parameter specifies the parameter values that are required by the DLP policy template that you specify using the Template or TemplateData parameters. DLP policy templates may contain parameters that need to be populated with values from your organization. For example, a DLP policy template may include an exception group that defines users who are exempt from the DLP policy. -Valid input for this parameter is in the format: @{\="\";\="\"...}. +This parameter uses the syntax: `@{Parameter1="Value1";Parameter2="Value2"...}`. ```yaml Type: Hashtable @@ -195,7 +195,7 @@ Accept wildcard characters: False ### -TemplateData The TemplateData parameter specifies an external DLP policy template file from which you can create a new DLP policy. You can't use the TemplateData and Template parameters in the same command. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md index da9502559e..aebe7eb29e 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md @@ -38,7 +38,11 @@ You need to be assigned permissions in the Security & Compliance Center before y ### Example 1 ```powershell -$Employee_Template = Get-Content "C:\My Documents\Contoso Employee Template.docx" -Encoding byte -ReadCount 0; $Employee_Fingerprint = New-DlpFingerprint -FileData $Employee_Template -Description "Contoso Employee Template"; $Customer_Template = Get-Content "D:\Data\Contoso Customer Template.docx" -Encoding byte; $Customer_Fingerprint = New-DlpFingerprint -FileData $Customer_Template -Description "Contoso Customer Template"; New-DlpSensitiveInformationType -Name "Contoso Employee-Customer Confidential" -Fingerprints $Employee_Fingerprint[0],$Customer_Fingerprint[0] -Description "Message contains Contoso employee or customer information." +$Employee_Template = Get-Content "C:\My Documents\Contoso Employee Template.docx" -Encoding byte -ReadCount 0 +$Employee_Fingerprint = New-DlpFingerprint -FileData $Employee_Template -Description "Contoso Employee Template" +$Customer_Template = Get-Content "D:\Data\Contoso Customer Template.docx" -Encoding byte +$Customer_Fingerprint = New-DlpFingerprint -FileData $Customer_Template -Description "Contoso Customer Template" +New-DlpSensitiveInformationType -Name "Contoso Employee-Customer Confidential" -Fingerprints $Employee_Fingerprint[0],$Customer_Fingerprint[0] -Description "Message contains Contoso employee or customer information." ``` This example creates a new sensitive information type rule named "Contoso Employee-Customer Confidential" that uses the document fingerprints of the files C:\\My Documents\\Contoso Employee Template.docx and D:\\Data\\Contoso Customer Template.docx. diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md index 4176e4c664..25901adfe5 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md @@ -47,7 +47,7 @@ This example imports the sensitive information type rule package C:\\My Document ### -FileData The FileData parameter specifies the sensitive information type rule package that you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md index 1913aec468..5c6761dee1 100644 --- a/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md @@ -180,9 +180,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -678,7 +678,7 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. diff --git a/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md index 4937e4515b..197e9a57ae 100644 --- a/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md +++ b/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md @@ -91,7 +91,7 @@ The ManagedBy parameter specifies a user who owns the group. You need to use thi - Email address - GUID -You can specify multiple owners by using the following syntax: @("\","\"...). +You can specify multiple owners by using the following syntax: `@("User1","User2",..."UserN")`. The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. @@ -111,7 +111,7 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the email alias of the distribution group. The Alias parameter value is used to generate the primary SMTP email address if you don't use the PrimarySmtpAddress parameter. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. If you don't use the Alias parameter when you create a group, the value of the Name parameter is used for the alias. This value is also used in the primary SMTP email address. Spaces are removed and unsupported characters are converted to question marks (?). @@ -160,7 +160,7 @@ You can use any value that uniquely identifies the recipient. For example: - Email address - GUID -You can specify multiple recipients by using the following syntax: @("\","\"...). +You can specify multiple recipients by using the following syntax: `@("Recipient1","Recipient2",..."RecipientN")`. ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/New-EOPMailUser.md b/exchange/exchange-ps/exchange/New-EOPMailUser.md index bc56f3bea8..97e5115767 100644 --- a/exchange/exchange-ps/exchange/New-EOPMailUser.md +++ b/exchange/exchange-ps/exchange/New-EOPMailUser.md @@ -104,7 +104,7 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the alias of the mail user. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. If you don't use the Alias parameter when you create a mail user, the left side of the MicrosoftOnlineServicesID parameter value is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias value helpdesk. diff --git a/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md index 3409f353ec..591ba91d9c 100644 --- a/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md @@ -130,7 +130,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -152,9 +152,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/New-EdgeSubscription.md b/exchange/exchange-ps/exchange/New-EdgeSubscription.md index 26a0b81eb9..09142ca0a5 100644 --- a/exchange/exchange-ps/exchange/New-EdgeSubscription.md +++ b/exchange/exchange-ps/exchange/New-EdgeSubscription.md @@ -50,7 +50,8 @@ This example creates the Edge Subscription file. It should be run on your Edge T ### Example 2 ```powershell -[byte[]]$Temp = Get-Content -Path "C:\EdgeServerSubscription.xml" -Encoding Byte -ReadCount 0; New-EdgeSubscription -FileData $Temp -Site "Default-First-Site-Name" +[byte[]]$Temp = Get-Content -Path "C:\EdgeServerSubscription.xml" -Encoding Byte -ReadCount 0 +New-EdgeSubscription -FileData $Temp -Site "Default-First-Site-Name" ``` This example imports the Edge Subscription file generated in Example 1 to the Active Directory site Default-First-Site-Name. Importing the Edge Subscription file completes the Edge Subscription process. You must run this command on the Mailbox server. @@ -158,7 +159,7 @@ Accept wildcard characters: False ### -FileData The FileData parameter specifies the byte-encoded data object that contains the Edge Subscription file information. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. You can only use this parameter when you're running this command on a Mailbox server. diff --git a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md index 463927dce0..b9415377e5 100644 --- a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md @@ -153,8 +153,8 @@ This example creates an email address policy in an on-premises Exchange organiza - Name: Southeast Offices - Precanned recipient filter: All users with mailboxes where the State or province value is GA, AL, or LA (Georgia, Alabama, or Louisiana). -- Primary SMTP email address: \.\@contoso.com -- Additional proxy email addresses: \.\@contoso.net +- Primary SMTP email address: `.@contoso.com` +- Additional proxy email addresses: `.@contoso.net` - Priority:N+1, where N is the number of manually created email address policies that already exist (we didn't use the Priority parameter, and the default value is N+1). ### Example 2 @@ -166,7 +166,7 @@ This example creates an email address policy in an on-premises Exchange organiza - Name: Northwest Executives - Custom recipient filter: All users with mailboxes where the Title value contains Director or Manager, and the State or province value is WA, OR, or ID (Washington, Oregon, or Idaho). -- Primary SMTP email address: \\@contoso.com +- Primary SMTP email address: `@contoso.com` - Additional proxy email addresses: None - Priority: 2 @@ -191,14 +191,14 @@ Accept wildcard characters: False ### -EnabledEmailAddressTemplates The EnabledEmailAddressTemplates parameter specifies the rules in the email address policy that are used to generate email addresses for recipients. -Valid syntax for this parameter is \:\: +Valid syntax for this parameter is `Type:AddressFormat`: -- \: A valid email address type as described in "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. -- \: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: \@contoso.com requires the value %m@contoso.com, and \.\@contoso.com requires the value %g.%s@contoso.com. +- Type: A valid email address type as described in "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. +- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. -This parameter requires at least one template with the \ value SMTP (to define the primary SMTP email address). After that, if you don't include a \ prefix for a template, the value smtp (an SMTP proxy address) is assumed. +This parameter requires at least one template with the Type value SMTP (to define the primary SMTP email address). After that, if you don't include a Type prefix for a template, the value smtp (an SMTP proxy address) is assumed. -You can specify multiple email address templates separated by commas: "SMTP:\","[\]:\","[\]:\",..."[\]:\". +You can specify multiple email address templates separated by commas: `"SMTP:PrimarySMTPEmailAddress","[Type1:]EmailAddress1","[Type2:]EmailAddress2",..."[TypeN:]EmailAddressN"`. You can't use this parameter with the EnabledPrimarySMTPAddressTemplate parameter. @@ -220,7 +220,7 @@ Accept wildcard characters: False ### -EnabledPrimarySMTPAddressTemplate The EnabledPrimarySMTPAddressTemplate parameter specifies the specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. -Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: \@contoso.com requires the value %m@contoso.com, and \.\@contoso.com requires the value %g.%s@contoso.com. +Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. You can't use this parameter with the EnabledEmailAddressTemplates parameter. @@ -737,12 +737,12 @@ This parameter is available only in on-premises Exchange. The DisabledEmailAddressTemplates parameter specifies the proxy email addresses templates that are included in an email address policy, but aren't used to configure the email addresses of recipients. -Valid syntax for this parameter is \:\: +Valid syntax for this parameter is `Type:AddressFormat`: -- \: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. -- \: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: \@contoso.com requires the value %m@contoso.com, and \.\@contoso.com requires the value %g.%s@contoso.com. +- Type: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. +- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. -You can specify multiple disabled email address templates separated by commas: "[\]:\","[\]:\",..."[\]:\". +You can specify multiple disabled email address templates separated by commas: `"[Type1:]EmailAddress1","[Type2:]EmailAddress2",..."[TypeN:]EmailAddressN"`. ```yaml Type: ProxyAddressTemplateCollection @@ -812,7 +812,7 @@ The Priority parameter specifies the order that the email address policies are e If you set this parameter to a value that's the same as another email address policy, the priority of the policy that you added first is incremented by 1. -Note: The first email address policy that identifies a recipient configures the recipient's email addresses. All other policies are ignored, even if the first policy is unapplied and can't configure the recipient's email addresses. +**Note**: The first email address policy that identifies a recipient configures the recipient's email addresses. All other policies are ignored, even if the first policy is unapplied and can't configure the recipient's email addresses. ```yaml Type: EmailAddressPolicyPriority diff --git a/exchange/exchange-ps/exchange/New-ExchangeCertificate.md b/exchange/exchange-ps/exchange/New-ExchangeCertificate.md index 18c26c90f3..c33b193d73 100644 --- a/exchange/exchange-ps/exchange/New-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/New-ExchangeCertificate.md @@ -84,9 +84,9 @@ New-ExchangeCertificate This example creates a self-signed certificate with the following settings: -The Subject value is CN=\ (for example, CN=Mailbox01). +The Subject value is `CN=` (for example, CN=Mailbox01). -The Domains (subject alternative names) value is \, \ (for example, Mailbox01,Mailbox01.contoso.com). +The Domains (subject alternative names) value is `,` (for example, `Mailbox01,Mailbox01.contoso.com`). The Services value is IMAP,POP,SMTP @@ -323,7 +323,7 @@ For example, if the organization has the accepted domains woodgrovebank.com and When you use this switch: -- If you've already included the value autodiscover.\ in the DomainName parameter, the value isn't duplicated in the Subject Alternative Name field. +- If you've already included the value `autodiscover.` in the DomainName parameter, the value isn't duplicated in the Subject Alternative Name field. - For new self-signed certificates, if you don't use the Services parameter, the certificate is only assigned to SMTP. ```yaml @@ -435,7 +435,7 @@ Accept wildcard characters: False ### -RequestFile The RequestFile parameter specifies the name and path of the certificate request file. The file contains the same information that's displayed on-screen when you generate a Base64 encoded certificate request (you don't use the BinaryEncoded switch). -You can use a local path if the certificate or certificate request is located on the same Exchange server where you're running the command. Otherwise, use a UNC path (`\\\`). If the value contains spaces, enclose the value in quotation marks ("). +You can use a local path if the certificate or certificate request is located on the same Exchange server where you're running the command. Otherwise, use a UNC path (`\\Server\Share`). If the value contains spaces, enclose the value in quotation marks ("). You can use this parameter only when you use the GenerateRequest switch. @@ -527,7 +527,7 @@ The SubjectName parameter specifies the Subject field of the certificate request Every certificate requires a value for the Subject field, and only one value is allowed. The requestor attempts to match the destination server name or FQDN with the common name (CN) value of subject. -This parameter uses the syntax: [C=\,S=\,L=LocalityOrCity,O=\,OU=\],CN=\. Although the only required value is CN=\, you should always include C=\ for certificate requests, but other values might also be required by the certification authority. +This parameter uses the syntax: `[C=CountryOrRegion,S=StateOrProvince,L=LocalityOrCity,O=Organization,OU=Department],CN=HostNameOrFQDN`. Although the only required value is `CN=HostNameOrFQDN`, you should always include `C=CountryOrRegion` for certificate requests, but other values might also be required by the certification authority. For example, if you want the certificate's subject to be mail.contoso.com in the United States, you can use any of the following values: diff --git a/exchange/exchange-ps/exchange/New-Fingerprint.md b/exchange/exchange-ps/exchange/New-Fingerprint.md index 8d501427c0..1e3edbbd93 100644 --- a/exchange/exchange-ps/exchange/New-Fingerprint.md +++ b/exchange/exchange-ps/exchange/New-Fingerprint.md @@ -38,7 +38,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$Patent_Template = Get-Content "C:\My Documents\Contoso Patent Template.docx" -Encoding byte; $Patent_Fingerprint = New-Fingerprint -FileData $Patent_Template -Description "Contoso Patent Template" +$Patent_Template = Get-Content "C:\My Documents\Contoso Patent Template.docx" -Encoding byte +$Patent_Fingerprint = New-Fingerprint -FileData $Patent_Template -Description "Contoso Patent Template" ``` This example creates a new document fingerprint based on the file C:\\My Documents\\Contoso Patent Template.docx. You store the new fingerprint as a variable so you can use it with the New-DataClassification cmdlet in the same PowerShell session. diff --git a/exchange/exchange-ps/exchange/New-ForeignConnector.md b/exchange/exchange-ps/exchange/New-ForeignConnector.md index 9f208aef46..4fe7fbc9e7 100644 --- a/exchange/exchange-ps/exchange/New-ForeignConnector.md +++ b/exchange/exchange-ps/exchange/New-ForeignConnector.md @@ -53,7 +53,7 @@ This example creates a Foreign connector with the following properties: ## PARAMETERS ### -AddressSpaces -The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is as follows: \:\;\ +The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. - AddressSpaceType: The address space type may be SMTP, X400, or any other text string. If you omit the address space type, an SMTP address space type is assumed. - AddressSpace: For SMTP address space types, the address space that you enter must be RFC 1035-compliant. For example, \*, \*.com, and \*.contoso.com are permitted, but \*contoso.com isn't permitted. For X.400 address space types, the address space that you enter must be RFC 1685-compliant, such as o=MySite;p=MyOrg;a=adatum;c=us. For all other values of an address type, you can enter any text for the address space. @@ -66,7 +66,7 @@ If you specify the address space type or the address space cost, you must enclos - "SMTP:contoso.com" - contoso.com -You may specify multiple address spaces by separating the address spaces with commas, for example: contoso.com,fabrikam.com. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("), for example: "contoso.com;2","fabrikam.com;3". +You may specify multiple address spaces by separating the address spaces with commas, for example: `contoso.com,fabrikam.com`. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("), for example: `"contoso.com;2","fabrikam.com;3"`. ```yaml Type: MultiValuedProperty @@ -153,7 +153,7 @@ Accept wildcard characters: False ### -SourceTransportServers The SourceTransportServers parameter specifies the names of the Mailbox servers that use this Foreign connector. Having a single Foreign connector homed on multiple servers provides fault tolerance and high availability if one of the Mailbox servers fails. The default value of this parameter is the name of the server on which this Foreign connector is first installed. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md index 63440b676d..b47e0f6f03 100644 --- a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md @@ -16,7 +16,7 @@ This cmdlet is available only in Security & Compliance Center PowerShell. For mo Use the New-HoldCompliancePolicy cmdlet to create new preservation policies in the Security & Compliance Center. -Note: The New-HoldCompliancePolicy cmdlet has been replaced by the New-RetentionCompliancePolicy cmdlet. If you have scripts that use New-HoldCompliancePolicy, update them to use New-RetentionCompliancePolicy. +**Note**: The New-HoldCompliancePolicy cmdlet has been replaced by the New-RetentionCompliancePolicy cmdlet. If you have scripts that use New-HoldCompliancePolicy, update them to use New-RetentionCompliancePolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -134,7 +134,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If no mailboxes are specified, then no mailboxes are placed on hold. @@ -186,7 +186,7 @@ Accept wildcard characters: False ### -SharePointLocation The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. diff --git a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md b/exchange/exchange-ps/exchange/New-HoldComplianceRule.md index 1d2814c640..9d9af5c2db 100644 --- a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-HoldComplianceRule.md @@ -16,7 +16,7 @@ This cmdlet is available only in Security & Compliance Center PowerShell. For mo Use the New-HoldComplianceRule cmdlet to create new preservation rules in the Security & Compliance Center. -Note: The New-HoldComplianceRule cmdlet has been replaced by the New-RetentionComplianceRule cmdlet. If you have scripts that use New-HoldComplianceRule, update them to use New-RetentionComplianceRule. +**Note**: The New-HoldComplianceRule cmdlet has been replaced by the New-RetentionComplianceRule cmdlet. If you have scripts that use New-HoldComplianceRule, update them to use New-RetentionComplianceRule. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md index 01ec781954..dd8b2fae73 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md @@ -74,7 +74,6 @@ New-HostedContentFilterPolicy [-Name] [-TestModeAction ] [-TestModeBccToRecipients ] [-WhatIf] - [-ZapEnabled ] [] ``` @@ -100,7 +99,7 @@ This example creates a spam filter policy named Contoso Executives with the foll ### -Name The Name parameter specifies a unique name for the spam filter policy. If the value contains spaces, enclose the value in quotation marks ("). -Don't use the following characters in the name value: \\, %, &, \*, +, /, =, ?, {, }, \|, \<, \>, (, ), ;, :, [, ], comma (,), or double quotation mark ("). +Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. ```yaml Type: String @@ -165,9 +164,9 @@ The AllowedSenderDomains parameter specifies trusted domains that aren't process **Caution**: Think very carefully before you add domains here. For more information, see [Create safe sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -187,9 +186,9 @@ The AllowedSenders parameter specifies a list of trusted senders that skip spam **Caution**: Think very carefully before you add senders here. For more information, see [Create safe sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -209,9 +208,9 @@ The BlockedSenderDomains parameter specifies domains that are always marked as s **Note**: Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -231,9 +230,9 @@ The BlockedSenders parameter specifies senders that are always marked as spam so **Note**: Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -648,9 +647,9 @@ af, ar, az, be, bg, bn, br, bs, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, A reference for two-letter language codes is available at [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/code_list.php). Note that not all possible language codes are available as input for this parameter. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. To empty the list, use the value $null. @@ -1002,7 +1001,7 @@ The QuarantineRetentionPeriod parameter specifies the number of days that spam m - PhishSpamAction - SpamAction -A valid value is an integer between 1 and 30. The default value is 30. +A valid value is an integer between 1 and 30. The default value is 15. After the time period expires, the message is deleted. @@ -1049,9 +1048,9 @@ AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. To empty the list, use the value $null. @@ -1172,22 +1171,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ZapEnabled -This parameter has been deprecated and is no longer used. Use the PhishZapEnabled and SpamZapEnabled parameters instead. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md index 0e06c8b045..c80384a8d0 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md @@ -79,7 +79,7 @@ Accept wildcard characters: False ### -Name The Name parameter specifies a unique name for the spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). -Don't use the following characters in the name value: \\, %, &, \*, +, /, =, ?, {, }, \|, \<, \>, (, ), ;, :, [, ], comma (,), or double quotation mark ("). +Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. ```yaml Type: String @@ -171,7 +171,7 @@ The ExceptIfSentTo parameter specifies an exception for the rule that looks for - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -196,7 +196,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception for the rule that lo - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. @@ -263,7 +263,7 @@ The SentTo parameter specifies a condition for the rule that looks for recipient - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -288,7 +288,7 @@ The SentToMemberOf parameter specifies a condition for the rule that looks for m - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. diff --git a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md index 74ab63219d..277872db1f 100644 --- a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md @@ -55,7 +55,7 @@ This example creates a new outbound spam filter rule named Contoso Executives th ### -Name The Name parameter specifies a unique name for the outbound spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). -The value itself can't contain the following characters: \\, %, &, \*, +, /, =, ?, {, }, \|, \<, \>, (, ), ;, :, [, ], comma (,), or double quotation mark ("). +Don't use the following characters: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. ```yaml Type: String @@ -160,7 +160,7 @@ The ExceptIfFrom parameter specifies an exception that looks for messages from s - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -185,7 +185,7 @@ The ExceptIfFromMemberOf parameter specifies an exception that looks for message - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -226,7 +226,7 @@ The From parameter specifies a condition that looks for messages from specific s - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -251,7 +251,7 @@ The FromMemberOf parameter specifies a condition that looks for messages sent by - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] diff --git a/exchange/exchange-ps/exchange/New-HybridConfiguration.md b/exchange/exchange-ps/exchange/New-HybridConfiguration.md index 0d10a725e6..b7ec5c0d6b 100644 --- a/exchange/exchange-ps/exchange/New-HybridConfiguration.md +++ b/exchange/exchange-ps/exchange/New-HybridConfiguration.md @@ -277,7 +277,7 @@ Accept wildcard characters: False ``` ### -TlsCertificateName -The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is "\X.500Issuer\X.500Subject". The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command $TLSCert = Get-ExchangeCertificate -Thumbprint \, run the command $TLSCertName = "\$($TLSCert.Issuer)\$($TLSCert.Subject)", and then use the value $TLSCertName for this parameter. +The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier diff --git a/exchange/exchange-ps/exchange/New-InboundConnector.md b/exchange/exchange-ps/exchange/New-InboundConnector.md index 2400064c54..71897c22a2 100644 --- a/exchange/exchange-ps/exchange/New-InboundConnector.md +++ b/exchange/exchange-ps/exchange/New-InboundConnector.md @@ -121,7 +121,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. diff --git a/exchange/exchange-ps/exchange/New-InboxRule.md b/exchange/exchange-ps/exchange/New-InboxRule.md index a21d7bf5a5..1360967240 100644 --- a/exchange/exchange-ps/exchange/New-InboxRule.md +++ b/exchange/exchange-ps/exchange/New-InboxRule.md @@ -474,7 +474,7 @@ The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. The corresponding condition parameter to this exception is From. @@ -795,7 +795,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. The corresponding condition parameter to this exception is SentTo. @@ -1013,7 +1013,7 @@ The ForwardAsAttachmentTo parameter specifies an action for the Inbox rule that - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1038,7 +1038,7 @@ The ForwardTo parameter specifies an action for the Inbox rule that forwards the - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1063,7 +1063,7 @@ The From parameter specifies a condition for the Inbox rule that looks for the s - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. The corresponding exception parameter to this condition is ExceptIfFrom. @@ -1495,7 +1495,7 @@ The RedirectTo parameter specifies an action for the Inbox rule that redirects t - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1559,7 +1559,7 @@ The SentTo parameter specifies a condition for the Inbox rule that looks for mes - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. The corresponding exception parameter to this condition is ExceptIfSentTo. diff --git a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md index 79bada56de..777ab1f66e 100644 --- a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md @@ -188,10 +188,7 @@ Accept wildcard characters: False ``` ### -Confirm -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +The Confirm switch doesn't work on this cmdlet. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/New-Label.md b/exchange/exchange-ps/exchange/New-Label.md index 5c42d07b0e..f1dbdf5738 100644 --- a/exchange/exchange-ps/exchange/New-Label.md +++ b/exchange/exchange-ps/exchange/New-Label.md @@ -140,7 +140,7 @@ Accept wildcard characters: False ``` ### -AdvancedSettings -The AdvancedSettings parameter enables client-specific features and capabilities on the sensitivity label. The settings that you configure with this parameter only affect apps that are designed for the setting. For more information, see [How to configure advanced settings for the client by using Security & Compliance Center PowerShell](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations#how-to-configure-advanced-settings-for-the-client-by-using-office-365-security--compliance-center-powershell). +The AdvancedSettings parameter enables client-specific features and capabilities for a sensitivity label. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see [Custom configurations for the Azure Information Protection unified labeling client](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). ```yaml Type: PswsHashtable diff --git a/exchange/exchange-ps/exchange/New-LabelPolicy.md b/exchange/exchange-ps/exchange/New-LabelPolicy.md index a091148661..68be12a8ca 100644 --- a/exchange/exchange-ps/exchange/New-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-LabelPolicy.md @@ -69,7 +69,7 @@ The Labels parameter specifies the sensitivity labels that are associated with t - Distinguished name (DN) - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -85,7 +85,7 @@ Accept wildcard characters: False ``` ### -AdvancedSettings -The AdvancedSettings parameter enables client-specific features and capabilities on the sensitivity label policy. The settings that you configure with this parameter only affect apps that are designed for the setting. For more information, see [How to configure advanced settings for the client by using Security & Compliance Center PowerShell](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations#how-to-configure-advanced-settings-for-the-client-by-using-office-365-security--compliance-center-powershell). +The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see [Custom configurations for the Azure Information Protection unified labeling client](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). ```yaml Type: PswsHashtable @@ -145,7 +145,7 @@ To specify the mailbox, you can use any value that uniquely identifies it. For e - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -170,7 +170,7 @@ To specify the mailbox, you can use any value that uniquely identifies it. For e - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -188,7 +188,7 @@ Accept wildcard characters: False ### -ModernGroupLocation The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. To identify the Microsoft 365 Group, you must use the primary SMTP address. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md new file mode 100644 index 0000000000..2a17d50205 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.Exchange.WebClient-Help.xml +online version: https://docs.microsoft.com/powershell/module/exchange/new-m365dataatrestencryptionpolicy +applicable: Exchange Online +title: New-M365DataAtRestEncryptionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-M365DataAtRestEncryptionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-M365DataAtRestEncryptionPolicy cmdlet to create a new Microsoft 365 data-at-rest encryption policy. + +**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-M365DataAtRestEncryptionPolicy [-Name] -AzureKeyIDs + [-Confirm] + [-Description ] + [-DomainController ] + [-Enabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the New-M365DataAtRestEncryptionPolicy cmdlet to create a new Microsoft 365 data-at-rest encryption policy. For more information, see [Overview of M365 Customer Key at the tenant level](https://docs.microsoft.com/microsoft-365/compliance/customer-key-tenant-level#get-policy-details). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-M365DataAtRestEncryptionPolicy -Name "Default_Policy" -AzureKeyIDs "https://contosoWestUSvault01.vault.azure.net/keys/Key_01","https://contosoEastUSvault01.vault.azure.net/keys/Key_02" -Description "Tenant default policy" +``` + +This example creates a Microsoft 365 data-at-rest encryption policy named Default_Policy with the specified Azure Key Vault keys and description. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the Microsoft 365 data-at-rest encryption policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureKeyIDs +The AzureKeyIDs parameter specifies the URL of the encryption key in the Azure Key Vault that's used for encryption. For example, `https://contoso.vault.azure.net/keys/key1/`. + +You can specify multiple values separated by commas using the following syntax: `"AzureKeyID1","AzureKeyID2",..."AzureKeyIDN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The Description parameter specifies an optional description for the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### + +## OUTPUTS + +### + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-MailContact.md b/exchange/exchange-ps/exchange/New-MailContact.md index 76f7c30291..3cba601b19 100644 --- a/exchange/exchange-ps/exchange/New-MailContact.md +++ b/exchange/exchange-ps/exchange/New-MailContact.md @@ -97,9 +97,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -341,7 +341,7 @@ The ModeratedBy parameter specifies one or more moderators for this mail contact - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. diff --git a/exchange/exchange-ps/exchange/New-MailUser.md b/exchange/exchange-ps/exchange/New-MailUser.md index 9c5637958d..691548645b 100644 --- a/exchange/exchange-ps/exchange/New-MailUser.md +++ b/exchange/exchange-ps/exchange/New-MailUser.md @@ -190,7 +190,8 @@ This example creates a new mail user for Ed Meadows in the contoso.com cloud-bas ### Example 2 ```powershell -$password = Read-Host "Enter password" -AsSecureString; New-MailUser -Name "Ed Meadows" -ExternalEmailAddress ed@tailspintoys.com -UserPrincipalName ed@contoso.com -Password $password +$password = Read-Host "Enter password" -AsSecureString +New-MailUser -Name "Ed Meadows" -ExternalEmailAddress ed@tailspintoys.com -UserPrincipalName ed@contoso.com -Password $password ``` This example is similar to the first, except contoso.com is now an on-premises Exchange organization, and you use a separate command to enter the password so it isn't stored in clear text. @@ -332,9 +333,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -613,7 +614,7 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -739,7 +740,7 @@ Accept wildcard characters: False ### -SamAccountName This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-Mailbox.md b/exchange/exchange-ps/exchange/New-Mailbox.md index 027166f55a..e73bc23ee2 100644 --- a/exchange/exchange-ps/exchange/New-Mailbox.md +++ b/exchange/exchange-ps/exchange/New-Mailbox.md @@ -769,7 +769,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$password = Read-Host "Enter password" -AsSecureString; New-Mailbox -UserPrincipalName chris@contoso.com -Alias chris -Database "Mailbox Database 1" -Name ChrisAshton -OrganizationalUnit Users -Password $password -FirstName Chris -LastName Ashton -DisplayName "Chris Ashton" -ResetPasswordOnNextLogon $true +$password = Read-Host "Enter password" -AsSecureString +New-Mailbox -UserPrincipalName chris@contoso.com -Alias chris -Database "Mailbox Database 1" -Name ChrisAshton -OrganizationalUnit Users -Password $password -FirstName Chris -LastName Ashton -DisplayName "Chris Ashton" -ResetPasswordOnNextLogon $true ``` This example creates a user Chris Ashton in Active Directory and creates a mailbox for the user. The mailbox is located on Mailbox Database 1. The password must be reset at the next logon. To set the initial value of the password, this example creates a variable ($password), prompts you to enter a password, and assigns that password to the variable as a SecureString object. @@ -790,7 +791,9 @@ This example creates an enabled user account in Active Directory and a room mail ### Example 4 ```powershell -New-Mailbox -Shared -Name "Sales Department" -DisplayName "Sales Department" -Alias Sales; Set-Mailbox -Identity Sales -GrantSendOnBehalfTo MarketingSG; Add-MailboxPermission -Identity Sales -User MarketingSG -AccessRights FullAccess -InheritanceType All +New-Mailbox -Shared -Name "Sales Department" -DisplayName "Sales Department" -Alias Sales +Set-Mailbox -Identity Sales -GrantSendOnBehalfTo MarketingSG +Add-MailboxPermission -Identity Sales -User MarketingSG -AccessRights FullAccess -InheritanceType All ``` This example creates the shared mailbox "Sales Department" and grants Full Access and Send on Behalf permissions for the security group "MarketingSG". Users who are members of the security group will be granted the permissions to the mailbox. @@ -1231,7 +1234,7 @@ Accept wildcard characters: False ### -UserPrincipalName This parameter is available only in on-premises Exchange. -The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format \@\. Typically, the \ value is the domain where the user account resides. +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 @@ -1308,9 +1311,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -1693,7 +1696,11 @@ Accept wildcard characters: False ### -MailboxRegion This parameter is available only in the cloud-based service. -This parameter is reserved for internal Microsoft use. +The MailboxRegion parameter specifies the geo location for the mailbox in multi-geo environments. + +To see the list of configured geo locations in Microsoft 365 Multi-Geo, run the following command: `Get-OrganizationConfig | Select -ExpandProperty AllowedMailboxRegions | Format-Table`. To view your central geo location, run the following command: `Get-OrganizationConfig | Select DefaultMailboxRegion`. + + For more information, see [Administering Exchange Online mailboxes in a multi-geo environment](https://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). ```yaml Type: String @@ -1756,7 +1763,7 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -2021,7 +2028,7 @@ Accept wildcard characters: False ### -SamAccountName This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md b/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md index f99aab6c58..8be33f9672 100644 --- a/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md +++ b/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md @@ -233,7 +233,7 @@ Accept wildcard characters: False ### -Mailboxes The Mailboxes parameter specifies the mailbox to retrieve mailbox audit log entries from. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you don't specify a value, mailbox audit logs for all mailboxes in the organization are returned. diff --git a/exchange/exchange-ps/exchange/New-MailboxDatabase.md b/exchange/exchange-ps/exchange/New-MailboxDatabase.md index 536e30a122..f88f8f0278 100644 --- a/exchange/exchange-ps/exchange/New-MailboxDatabase.md +++ b/exchange/exchange-ps/exchange/New-MailboxDatabase.md @@ -183,7 +183,7 @@ Accept wildcard characters: False ``` ### -EdbFilePath -The EdbFilePath parameter specifies the path to the database files. The default value is %programfiles%\\Microsoft\\Exchange Server\\V15\\Mailbox\\\.edb. +The EdbFilePath parameter specifies the path to the database files. The default location is `%ExchangeInstallPath%Mailbox\\.edb`. ```yaml Type: EdbFilePath @@ -247,7 +247,7 @@ Accept wildcard characters: False ``` ### -LogFolderPath -The LogFolderPath parameter specifies the folder location for log files. +The LogFolderPath parameter specifies the folder location for log files.The default location is `%ExchangeInstallPath%Mailbox\` ```yaml Type: NonRootLocalLongFullPath diff --git a/exchange/exchange-ps/exchange/New-MailboxExportRequest.md b/exchange/exchange-ps/exchange/New-MailboxExportRequest.md index 7bfddad04f..c5a0d08e12 100644 --- a/exchange/exchange-ps/exchange/New-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxExportRequest.md @@ -117,7 +117,7 @@ New-MailboxExportRequest [-Mailbox] -ComplianceStor ``` ## DESCRIPTION -You can create more than one mailbox export request per mailbox, and each mailbox export request must have a unique name. Microsoft Exchange automatically generates up to 10 unique names for a mailbox export request. However, to create more than 10 export requests for a mailbox, you need to specify a unique name when creating the export request. You can remove existing export requests with the Remove-MailboxExportRequest cmdlet before starting a new request with the default request name \\\MailboxExportX (where X = 0-9). +You can create more than one mailbox export request per mailbox, and each mailbox export request must have a unique name. Microsoft Exchange automatically generates up to 10 unique names for a mailbox export request. However, to create more than 10 export requests for a mailbox, you need to specify a unique name when creating the export request. You can remove existing export requests with the Remove-MailboxExportRequest cmdlet before starting a new request with the default request name `\MailboxExportX` (where X = 0-9). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -492,9 +492,9 @@ The ExcludeFolders parameter specifies the list of folders to exclude during the Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: -\/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". -\#\\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - Inbox - SentItems @@ -514,7 +514,7 @@ Folder names aren't case-sensitive, and there are no character restrictions. Use - LocalFailures - ServerFailures -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. Wildcard characters can't be used in folder names. @@ -536,9 +536,9 @@ The IncludeFolders parameter specifies the list of folders to include during the Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: -\/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". -\#\\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - Inbox - SentItems @@ -558,7 +558,7 @@ Folder names aren't case-sensitive, and there are no character restrictions. Use - LocalFailures - ServerFailures -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. Wildcard characters can't be used in folder names. @@ -653,7 +653,7 @@ Accept wildcard characters: False ### -Name The Name parameter specifies the name of the specific request for tracking and display purposes. Because you can have multiple export requests per mailbox, Exchange precedes the name with the mailbox's alias. For example, if you create an export request for a user's mailbox that has the alias Kweku and specify the value of this parameter as PC1toArchive, the identity of this export request is Kweku\\PC1toArchive. -If you don't specify a name using this parameter, Exchange generates up to 10 request names per mailbox, which is MailboxExportX (where X = 0-9). The identity of the request is displayed and searchable as \\\MailboxExportX. +If you don't specify a name using this parameter, Exchange generates up to 10 request names per mailbox, which is MailboxExportX (where X = 0-9). The identity of the request is displayed and searchable as `\MailboxExportX`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-MailboxImportRequest.md b/exchange/exchange-ps/exchange/New-MailboxImportRequest.md index a501f0b268..912b8e6b86 100644 --- a/exchange/exchange-ps/exchange/New-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxImportRequest.md @@ -160,7 +160,7 @@ New-MailboxImportRequest [-Mailbox] -RemoteFilePath ``` ## DESCRIPTION -You can create more than one mailbox import request per mailbox and each mailbox import request must have a unique name. Microsoft Exchange automatically generates up to 10 unique names for a mailbox import request. However, to create more than 10 import requests for a mailbox, you need to specify a unique name when creating the import request, or you can remove existing import requests with the Remove-MailboxExportRequest cmdlet before starting a new import request with the default request \\\MailboxImportX (where X = 0-9). +You can create more than one mailbox import request per mailbox and each mailbox import request must have a unique name. Microsoft Exchange automatically generates up to 10 unique names for a mailbox import request. However, to create more than 10 import requests for a mailbox, you need to specify a unique name when creating the import request, or you can remove existing import requests with the Remove-MailboxExportRequest cmdlet before starting a new import request with the default request `\MailboxImportX` (where X = 0-9). By default, the import checks for duplication of items and doesn't copy the data from the .pst file into the mailbox or archive if a matching item exists in the target mailbox or target archive. @@ -482,12 +482,12 @@ Accept wildcard characters: False ### -ConflictResolutionOption The ConflictResolutionOption parameter specifies what to do if there are multiple matching messages in the target. Valid values are: -- ForceCopy +- ForceCopy (Exchange 2016 or later) - KeepAll - KeepLatestItem -- KeepSourceItem (This is the default value.) -- KeepTargetItem -- UpdateFromSource +- KeepSourceItem (This is the default value) +- KeepTargetItem (Exchage 2016 or later) +- UpdateFromSource (Exchange 2016 or later) ```yaml Type: ConflictResolutionOption @@ -561,9 +561,9 @@ The ExcludeFolders parameter specifies the list of folders to exclude during the Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: -\/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". -\#\\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - Inbox - SentItems @@ -583,7 +583,7 @@ Folder names aren't case-sensitive, and there are no character restrictions. Use - LocalFailures - ServerFailures -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. Wildcard characters can't be used in folder names. @@ -607,9 +607,9 @@ The IncludeFolders parameter specifies the list of folders to include during the Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: -\/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". -\#\\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - Inbox - SentItems @@ -629,7 +629,7 @@ Folder names aren't case-sensitive, and there are no character restrictions. Use - LocalFailures - ServerFailures -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. Wildcard characters can't be used in folder names. @@ -760,7 +760,7 @@ Accept wildcard characters: False ### -Name The Name parameter specifies the name of the specific request for tracking and display purposes. Because you can have multiple import requests per mailbox, Exchange precedes the name with the mailbox's alias. For example, if you create an import request for a user's mailbox that has the alias Kweku and specify the value of this parameter as PC1toArchive, the identity of this import request is Kweku\\PC1toArchive. -If you don't specify a name using this parameter, Exchange generates up to 10 request names per mailbox, which is MailboxImportX (where X = 0-9). The identity of the request is displayed and searchable as \\\MailboxImportX. +If you don't specify a name using this parameter, Exchange generates up to 10 request names per mailbox, which is MailboxImportX (where X = 0-9). The identity of the request is displayed and searchable as `\MailboxImportX`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md index dab8978f83..22d9b478db 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md @@ -84,7 +84,8 @@ This example detects and repairs all corruption types for Ayla Kol's mailbox and ### Example 5 ```powershell -$Mailbox = Get-MailboxStatistics annb; New-MailboxRepairRequest -Database $Mailbox.Database -StoreMailbox $Mailbox.MailboxGuid -CorruptionType ProvisionedFolder,SearchFolder,AggregateCounts,Folderview +$Mailbox = Get-MailboxStatistics annb +New-MailboxRepairRequest -Database $Mailbox.Database -StoreMailbox $Mailbox.MailboxGuid -CorruptionType ProvisionedFolder,SearchFolder,AggregateCounts,Folderview ``` This example creates a variable that identifies Ann Beebe's mailbox and then uses the variable to specify the values for the Database and StoreMailbox parameters to create a request to detect and repair all corruption types. diff --git a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md index 14db8b6b23..b71b7d6681 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md @@ -586,9 +586,9 @@ The ExcludeFolders parameter specifies the list of folders to exclude during the Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: -\/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". -\#\\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - Inbox - SentItems @@ -608,7 +608,7 @@ Folder names aren't case-sensitive, and there are no character restrictions. Use - LocalFailures - ServerFailures -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. Wildcard characters can't be used in folder names. @@ -630,9 +630,9 @@ The IncludeFolders parameter specifies the list of folder to include during the Folder names aren't case-sensitive, and there are no character restrictions. Use the following syntax: -\/\*: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". +`/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, "MyProjects" or "MyProjects/FY2010". -\#\\#/\*: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - Inbox - SentItems @@ -652,7 +652,7 @@ Folder names aren't case-sensitive, and there are no character restrictions. Use - LocalFailures - ServerFailures -If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a back slash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder, but not the well-known Notes folder, use the following syntax: \\\#Notes\\\#. +If the user creates a personal folder with the same name as a well-known folder and the \# symbol surrounding it, you can use a backslash (\\) as an escape character to specify that folder. For example, if a user creates a folder named \#Notes\# and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. Wildcard characters can't be used in folder names. diff --git a/exchange/exchange-ps/exchange/New-MailboxSearch.md b/exchange/exchange-ps/exchange/New-MailboxSearch.md index 2c0ca961bd..e084946eb0 100644 --- a/exchange/exchange-ps/exchange/New-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/New-MailboxSearch.md @@ -14,13 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -On July 1, 2018, you'll no longer be able to use the New-MailboxSearch cmdlet to create In-Place eDiscovery searches and In-Place Holds in Exchange Online. To create eDiscovery searches and eDiscovery case holds, please start using New-ComplianceSearch and New-CaseHoldPolicy in the Security & Compliance Center. You'll still be able to use Set-MailboxSearch to modify existing In-Place eDiscovery searches and In-Place Holds. Creating new searches and holds in Exchange Server 2013 will still be supported, and searches run from your on-premises organization in an Exchange hybrid deployment aren't affected by this change. - Use the New-MailboxSearch cmdlet to create a mailbox search and either get an estimate of search results, place search results on In-Place Hold or copy them to a Discovery mailbox. You can also place all contents in a mailbox on hold by not specifying a search query, which accomplishes similar results as Litigation Hold. -By default, mailbox searches are performed across all Exchange 2013 or later Mailbox servers in an Exchange organization, unless you constrain the search to fewer mailboxes by using the SourceMailboxes parameter. To search mailboxes on Exchange 2010 Mailbox servers, run the command on an Exchange 2010 server. - -For more information, see [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and [In-Place Hold and Litigation Hold in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/holds/holds). +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -59,7 +55,11 @@ New-MailboxSearch [-Name] ``` ## DESCRIPTION -The New-MailboxSearch cmdlet creates an In-Place eDiscovery search or an In-Place Hold. Unless specified, mailboxes on all Mailbox servers in an organization are searched. You can stop, start, modify, or remove the search. +The New-MailboxSearch cmdlet creates an In-Place eDiscovery search or an In-Place Hold. You can stop, start, modify, or remove the search. + +By default, mailbox searches are performed across all Exchange 2013 or later Mailbox servers in an organization, unless you constrain the search to fewer mailboxes by using the SourceMailboxes parameter. To search mailboxes on Exchange 2010 Mailbox servers, run the command on an Exchange 2010 server. + +For more information, see [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and [In-Place Hold and Litigation Hold in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/holds/holds). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -555,7 +555,7 @@ The SourceMailboxes parameter specifies the identity of one or more mailboxes to - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. To use this parameter, the AllSourceMailboxes parameter needs to be $false (the default value). @@ -607,7 +607,7 @@ The StatusMailRecipients parameter specifies one or more recipients to receive a - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md index 784081a339..bb0ee885a2 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md @@ -500,7 +500,7 @@ You enable or disable common attachment blocking by using the EnableFileFilter p Common attachment blocking uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, .ps1 files are Windows PowerShell scripts, but their true type is text. -To replace the existing list of file types with the values you specify, use the syntax \,\,...\. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. +To replace the existing list of file types with the values you specify, use the syntax `FileType1,FileType2,...FileTypeN`. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. To add or remove file types without affecting the other file type entries, see the Examples section in the Set-MalwareFilterPolicy cmdlet topic. diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterRule.md b/exchange/exchange-ps/exchange/New-MalwareFilterRule.md index cd3fb00f97..516294b74f 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/New-MalwareFilterRule.md @@ -186,7 +186,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -211,7 +211,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception that looks for messa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. @@ -278,7 +278,7 @@ The SentTo parameter specifies a condition that looks for recipients in messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -303,7 +303,7 @@ The SentToMemberOf parameter specifies a condition that looks for messages sent - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. diff --git a/exchange/exchange-ps/exchange/New-ManagedContentSettings.md b/exchange/exchange-ps/exchange/New-ManagedContentSettings.md index c1c362f0ac..e81864beac 100644 --- a/exchange/exchange-ps/exchange/New-ManagedContentSettings.md +++ b/exchange/exchange-ps/exchange/New-ManagedContentSettings.md @@ -106,7 +106,7 @@ Valid parameter values for custom message classes include: - The asterisk (\*) wildcard character, which indicates that the content settings apply to all message classes. - A specific message class that has the asterisk wildcard character. The asterisk wildcard character must appear as the last character in the message class. For example, IPM.NOTE\* (includes IPM.NOTE and all subclasses) or IPM.NOTE.\* (includes the subclasses for IPM.NOTE but not IPM.NOTE itself). \*.NOTE and IPM.\*.NOTE aren't valid values. -Notes: +**Notes**: - When wildcard characters are used, these policies apply only to message classes that don't have a specific content setting. Therefore, IPM.NOTE.SMIME overrides IPM.NOTE.\*. - Specific settings supersede general settings, for example, Voicemail supersedes AllMailboxContent. diff --git a/exchange/exchange-ps/exchange/New-ManagementRole.md b/exchange/exchange-ps/exchange/New-ManagementRole.md index 855f9c21f7..32d48d4340 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRole.md +++ b/exchange/exchange-ps/exchange/New-ManagementRole.md @@ -61,7 +61,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -New-ManagementRole -Name "Redmond Journaling View-Only" -Parent Journaling; Get-ManagementRoleEntry "Redmond Journaling View-Only\*" | Where { $_.Name -NotLike "Get*" } | %{Remove-ManagementRoleEntry -Identity "$($_.id)\$($_.name)"} +New-ManagementRole -Name "Redmond Journaling View-Only" -Parent Journaling +Get-ManagementRoleEntry "Redmond Journaling View-Only\*" | Where { $_.Name -NotLike "Get*" } | %{Remove-ManagementRoleEntry -Identity "$($_.id)\$($_.name)"} ``` This example creates the management role Redmond Journaling View-Only based on the Journaling parent role. diff --git a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md index c5a5db4e68..0a4707b50a 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md @@ -113,7 +113,8 @@ This example assigns the Mail Recipients role to the Tier 2 Help Desk role group ### Example 2 ```powershell -Get-ManagementRole "MyVoiceMail" | Format-Table Name, IsEndUserRole; New-ManagementRoleAssignment -Role "MyVoiceMail" -Policy "Sales end-users" +Get-ManagementRole "MyVoiceMail" | Format-Table Name, IsEndUserRole +New-ManagementRoleAssignment -Role "MyVoiceMail" -Policy "Sales end-users" ``` This example assigns the MyVoiceMail role to the "Sales end-users" role assignment policy. First, the IsEndUserRole property on the MyVoiceMail role is verified to be sure it's set to $true, indicating it's an end-user role. diff --git a/exchange/exchange-ps/exchange/New-ManagementScope.md b/exchange/exchange-ps/exchange/New-ManagementScope.md index 2a5b481b1f..9b62c15ca0 100644 --- a/exchange/exchange-ps/exchange/New-ManagementScope.md +++ b/exchange/exchange-ps/exchange/New-ManagementScope.md @@ -108,7 +108,8 @@ This example creates the Executive Mailboxes scope. Only mailboxes located withi ### Example 4 ```powershell -New-ManagementScope -Name "Protected Exec Users" -RecipientRestrictionFilter "Title -like 'VP*'" -Exclusive; New-ManagementRoleAssignment -SecurityGroup "Executive Administrators" -Role "Mail Recipients" -CustomRecipientWriteScope "Protected Exec Users" +New-ManagementScope -Name "Protected Exec Users" -RecipientRestrictionFilter "Title -like 'VP*'" -Exclusive +New-ManagementRoleAssignment -SecurityGroup "Executive Administrators" -Role "Mail Recipients" -CustomRecipientWriteScope "Protected Exec Users" ``` This example creates the Protected Exec Users exclusive scope. Users that contain the string "VP" in their title match the recipient filter for the scope. When the exclusive scope is created, all users are immediately blocked from modifying the recipients that match the exclusive scope until the scope is associated with a management role assignment. If other role assignments are associated with other exclusive scopes that match the same recipients, those assignments can still modify the recipients. @@ -149,7 +150,7 @@ The DatabaseList parameter specifies a list of databases to which the scope shou - Distinguished name (DN) - GUID -You can specify multiple values separated by commas. If the values contain spaces, use the following syntax: \"","\",..."\". +You can specify multiple values separated by commas. If the values contain spaces, use the following syntax: `"Value1","Value2",..."ValueN"`. You can't use this parameter with the DatabaseRestrictionFilter, ServerList, RecipientRestrictionFilter, RecipientRoot, or ServerRestrictionFilter parameters. @@ -232,7 +233,7 @@ The ServerList parameter specifies a list of servers to which the scope should b - Distinguished name (DN) - Exchange Legacy DN -You can specify multiple values separated by commas. If the values contains spaces or otherwise require quotation marks, use the following syntax: "\","\,"..."\". +You can specify multiple values separated by commas. If the values contains spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can't use this parameter with the RecipientRestrictionFilter, RecipientRoot, DatabaseRestrictionFilter, DatabaseList, or ServerRestrictionFilter parameters. diff --git a/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md index 19fa079824..1861792ed8 100644 --- a/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md @@ -119,7 +119,7 @@ This parameter is available only in Exchange 2013. The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -143,9 +143,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode @@ -163,7 +161,7 @@ Accept wildcard characters: False ### -ExternalUrl The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. -This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. Valid input for this parameter uses the syntax https://\/mapi. +This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. This parameter uses the syntax: `https:///mapi`. For example, `https://external.contoso.com/mapi`. When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. @@ -210,7 +208,7 @@ Accept wildcard characters: False ### -InternalUrl The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. -This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. Valid input for this parameter uses the syntax https://\/mapi. +This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. This parameter uses the syntax: `https:///mapi`. For example, `https://internal.contoso.com/mapi`. When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. diff --git a/exchange/exchange-ps/exchange/New-MessageClassification.md b/exchange/exchange-ps/exchange/New-MessageClassification.md index f637dd922e..d01016fc27 100644 --- a/exchange/exchange-ps/exchange/New-MessageClassification.md +++ b/exchange/exchange-ps/exchange/New-MessageClassification.md @@ -145,7 +145,7 @@ Accept wildcard characters: False ### -ClassificationID The ClassificationID parameter specifies the classification ID (GUID) of an existing message classification that you want to import and use in your Exchange organization. Use this parameter if you're configuring message classifications that span two Exchange forests in the same organization. -To find the ClassificationID value of the message classification, replace \ with the name of the message classification and run the following command: Get-MessageCalssification -Identity "\. +To find the ClassificationID value of the message classification, replace `` with the name of the message classification and run the following command: `Get-MessageClassification -Identity ""`. ```yaml Type: Guid diff --git a/exchange/exchange-ps/exchange/New-MigrationBatch.md b/exchange/exchange-ps/exchange/New-MigrationBatch.md index 0ca69093c9..4982215ab0 100644 --- a/exchange/exchange-ps/exchange/New-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/New-MigrationBatch.md @@ -809,7 +809,7 @@ Folder names aren't case-sensitive, and there are no character restrictions. Use `/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, `MyProjects` or `MyProjects/FY2010`. -`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, `#Inbox#` denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - Inbox - SentItems @@ -829,7 +829,7 @@ Folder names aren't case-sensitive, and there are no character restrictions. Use - LocalFailures - ServerFailures -If the user creates a personal folder with the same name as a well-known folder and the `#` symbol surrounding it, you can use a back slash (`\`) as an escape character to specify that folder. For example, if a user creates a folder named `#Notes#` and you want to specify that folder, but not the well-known Notes folder, use the following syntax: `\#Notes\#`. +If the user creates a personal folder with the same name as a well-known folder and the `#` symbol surrounding it, you can use a backslash (`\`) as an escape character to specify that folder. For example, if a user creates a folder named `#Notes#` and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. Wildcard characters can't be used in folder names. @@ -857,7 +857,7 @@ Folder names aren't case-sensitive, and there are no character restrictions. Use `/*`: Use this syntax to denote a personal folder under the folder specified in the SourceRootFolder parameter, for example, `MyProjects` or `MyProjects/FY2010`. -`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, `#Inbox#` denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: +`##/*`: Use this syntax to denote a well-known folder regardless of the folder's name in another language. For example, \#Inbox\# denotes the Inbox folder even if the Inbox is localized in Turkish, which is Gelen Kutusu. Well-known folders include the following types: - Inbox - SentItems @@ -877,7 +877,7 @@ Folder names aren't case-sensitive, and there are no character restrictions. Use - LocalFailures - ServerFailures -If the user creates a personal folder with the same name as a well-known folder and the `#` symbol surrounding it, you can use a back slash (`\`) as an escape character to specify that folder. For example, if a user creates a folder named `#Notes#` and you want to specify that folder, but not the well-known Notes folder, use the following syntax: `\#Notes\#`. +If the user creates a personal folder with the same name as a well-known folder and the `#` symbol surrounding it, you can use a backslash (`\`) as an escape character to specify that folder. For example, if a user creates a folder named `#Notes#` and you want to specify that folder instead of the well-known Notes folder, use the following syntax: `\#Notes\#`. Wildcard characters can't be used in folder names. ```yaml diff --git a/exchange/exchange-ps/exchange/New-MigrationEndpoint.md b/exchange/exchange-ps/exchange/New-MigrationEndpoint.md index 701d4cf9f3..9fcae032a8 100644 --- a/exchange/exchange-ps/exchange/New-MigrationEndpoint.md +++ b/exchange/exchange-ps/exchange/New-MigrationEndpoint.md @@ -243,7 +243,8 @@ This example creates an endpoint for remote moves by specifying the settings man ### Example 3 ```powershell -$Credentials = Get-Credential; New-MigrationEndpoint -ExchangeOutlookAnywhere -Name EXCH-AutoDiscover -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials +$Credentials = Get-Credential +New-MigrationEndpoint -ExchangeOutlookAnywhere -Name EXCH-AutoDiscover -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials ``` This example creates an Outlook Anywhere migration endpoint by using the Autodiscover parameter to detect the connection settings to the on-premises organization. Outlook Anywhere endpoints are used for cutover and staged Exchange migrations. The Get-Credential cmdlet is used to obtain the credentials for an on-premises account that has the necessary administrative privileges in the domain and that can access the mailboxes that will be migrated. When prompted for the user name, you can use either the email address or the domain\\username format for the administrator account. This account can be the same one that is specified by the EmailAddress parameter. @@ -576,7 +577,7 @@ This parameter is available only in the cloud-based service. The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. -Use the following format for the value of this parameter: ([System.IO.File]::ReadAllBytes(\)). For example: -CSVData ([System.IO.File]::ReadAllBytes("C:\\Users\\Administrator\\Desktop\\service-account.json")) +Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes())`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json"))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/New-MoveRequest.md b/exchange/exchange-ps/exchange/New-MoveRequest.md index 4e5b30113f..b3c2994ca0 100644 --- a/exchange/exchange-ps/exchange/New-MoveRequest.md +++ b/exchange/exchange-ps/exchange/New-MoveRequest.md @@ -563,7 +563,6 @@ The ArchiveTargetDatabase parameter specifies the destination mailbox database f If you don't use this parameter, the archive is moved to the same database as the primary mailbox. - ```yaml Type: DatabaseIdParameter Parameter Sets: MigrationRemote, MigrationLocal, MigrationRemoteCrossTenant diff --git a/exchange/exchange-ps/exchange/New-OMEConfiguration.md b/exchange/exchange-ps/exchange/New-OMEConfiguration.md index 23f87bed4d..3be4ba9c11 100644 --- a/exchange/exchange-ps/exchange/New-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/New-OMEConfiguration.md @@ -70,9 +70,9 @@ Accept wildcard characters: False ### -BackgroundColor The BackgroundColor parameter specifies the background color. Valid values are: -- An available HTML hexadecimal \(hex triplet\) color code value \(for example, 0x000000 is white\). -- An available text value \(for example, yellow is 0x00FFFF00\). -- $null \(blank\). This is the default value. +- An available HTML hexadecimal (hex triplet) color code value (for example, `0x000000` is white). +- An available text value (for example, `yellow` is 0x00FFFF00). +- $null (blank). This is the default value. For more information, see [Add your organization's brand to your encrypted messages](https://docs.microsoft.com/microsoft-365/compliance/add-your-organization-brand-to-encrypted-messages). diff --git a/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md index f9fdb79ac2..82ae44935b 100644 --- a/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md @@ -118,7 +118,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -140,9 +140,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/New-OfflineAddressBook.md b/exchange/exchange-ps/exchange/New-OfflineAddressBook.md index 6bdeee4d9c..df3c2be4db 100644 --- a/exchange/exchange-ps/exchange/New-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/New-OfflineAddressBook.md @@ -49,7 +49,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$a = Get-AddressList | Where {$_.Name -Like "*AgencyB*"}; New-OfflineAddressBook -Name "OAB_AgencyB" -Server myserver.contoso.com -AddressLists $a -Schedule "Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00" +$a = Get-AddressList | Where {$_.Name -Like "*AgencyB*"} +New-OfflineAddressBook -Name "OAB_AgencyB" -Server myserver.contoso.com -AddressLists $a -Schedule "Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00" ``` In Exchange Server 2010 and 2013, this example uses two commands to create the OAB named OAB\_AgencyB that includes all address lists in which AgencyB is part of the name. By using the settings shown, an OAB is generated by myserver.contoso.com on Mondays and Wednesdays from 01:00 (1 A.M.) to 02:00 (2 A.M.). This example command also creates the default OAB for the organization. @@ -109,7 +110,7 @@ The AddressLists parameter specifies the address lists or global address lists t - Distinguished name (DN) - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can find the identify values of address lists and global address lists by using the Get-AddressList and Get-GlobalAddressList cmdlets. @@ -301,7 +302,7 @@ This parameter is available or functional only in Exchange Server 2010. The Schedule parameter specifies the interval for generating the OAB in Exchange 2010 or earlier. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can use the following values for days: @@ -430,11 +431,11 @@ The VirtualDirectories parameter specifies the OAB virtual directories that acce You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. The default value of this parameter is the Client Access services (frontend) and backend OAB virtual directories on the Mailbox server that holds the OAB generation mailbox (the GeneratingMailbox parameter or SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}). For example, Mailbox01\\OAB (Default Web Site),Mailbox01\\OAB (Exchange Back End. diff --git a/exchange/exchange-ps/exchange/New-OutboundConnector.md b/exchange/exchange-ps/exchange/New-OutboundConnector.md index bf6fa5436c..b12ce6b1ec 100644 --- a/exchange/exchange-ps/exchange/New-OutboundConnector.md +++ b/exchange/exchange-ps/exchange/New-OutboundConnector.md @@ -99,7 +99,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. diff --git a/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md index 905a961cb2..3a104badd9 100644 --- a/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md +++ b/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md @@ -200,7 +200,7 @@ The SentTo parameter specifies one or more recipients as a rule condition. You c You can also specify the SMTP email address of an external recipient. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. When you specify multiple recipients, messages sent to any of the specified recipients are considered a match. diff --git a/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md index e1c3444fab..71dc250479 100644 --- a/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md @@ -150,7 +150,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -172,9 +172,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/New-PolicyTipConfig.md b/exchange/exchange-ps/exchange/New-PolicyTipConfig.md index 2d1a6cf8ec..c3d75c9154 100644 --- a/exchange/exchange-ps/exchange/New-PolicyTipConfig.md +++ b/exchange/exchange-ps/exchange/New-PolicyTipConfig.md @@ -56,7 +56,7 @@ This example sets the informational URL in Policy Tips to the value `https://www ### -Name The Name parameter specifies the custom Policy Tip you want to modify. Valid input for this parameter is one of the following values: -- \\\\: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - Url There can be only one custom Policy Tip with the value Url for the Name parameter. For the remaining Policy Tip actions, there can be only one custom Policy Tip for each combination of locale and action. For example, there can be only one custom Policy Tip with the Name value en\\NotifyOnly, but you can create additional custom Policy Tips with the values de\\NotifyOnly and fr\\NotifyOnly for the Name parameter. diff --git a/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md index d8cb4e6f75..3b356bbcf6 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md +++ b/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md @@ -122,7 +122,7 @@ Accept wildcard characters: False ``` ### -EdbFilePath -The EdbFilePath parameter specifies the full path of the public folder database files. +The EdbFilePath parameter specifies the full path of the public folder database files. The default location is `%ExchangeInstallPath%Mailbox\\.edb` ```yaml Type: EdbFilePath @@ -138,7 +138,7 @@ Accept wildcard characters: False ``` ### -LogFolderPath -The LogFolderPath parameter specifies the folder location for log files. The default path is \V14\\Mailbox. +The LogFolderPath parameter specifies the folder location for log files. The default location is `%ExchangeInstallPath%Mailbox\`. ```yaml Type: NonRootLocalLongFullPath diff --git a/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md index a86f75b195..4b42250c61 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md @@ -69,7 +69,8 @@ You can also move a branch of public folders by using the Move-PublicFolderBranc ### Example 3 ```powershell -$folders = Get-PublicFolder \ -Recurse -Mailbox PUB1 -ResidentFolders | ?{$_.Name -ne "IPM_SUBTREE"} | %{$_.Identity};New-PublicFolderMoveRequest -TargetMailbox PUB2 -Folders $folders +$folders = Get-PublicFolder \ -Recurse -Mailbox PUB1 -ResidentFolders | ?{$_.Name -ne "IPM_SUBTREE"} | %{$_.Identity} +New-PublicFolderMoveRequest -TargetMailbox PUB2 -Folders $folders ``` This example moves all public folders from public folder mailbox Pub1 to public folder mailbox Pub2. diff --git a/exchange/exchange-ps/exchange/New-ReceiveConnector.md b/exchange/exchange-ps/exchange/New-ReceiveConnector.md index 4b9129fffd..5fe1ca1548 100644 --- a/exchange/exchange-ps/exchange/New-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/New-ReceiveConnector.md @@ -417,7 +417,7 @@ Accept wildcard characters: False ``` ### -Bindings -The Bindings parameter specifies the local IP address and TCP port number that's used by the Receive connector. This parameter uses the syntax "\:\","\:\". You can specify an IPv4 address and port, and IPv6 address and port, or both. The IP address values 0.0.0.0 or [::]: indicate that the Receive connector uses all available local IPv4 or all IPv6 addresses. +The Bindings parameter specifies the local IP address and TCP port number that's used by the Receive connector. This parameter uses the syntax `"IPv4Address:TCPPort","IPv6Address:TCPPort"`. You can specify an IPv4 address and port, an IPv6 address and port, or both. The IP address values 0.0.0.0 or `[::]` indicate that the Receive connector uses all available local IPv4 or all IPv6 addresses. You need to specify a valid local IP address from the network adapters of the Exchange server. If you specify an invalid local IP address, the Microsoft Exchange Transport service might fail to start when the service is restarted. @@ -570,7 +570,7 @@ The RemoteIPRanges parameter specifies the remote IP addresses that the Receive - IP address range: For example, 192.168.1.1-192.168.1.254. - Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.1.1/24 or 2001:0DB8::CD3/60. -You can specify multiple value separated by commas ("\","\"...). +You can specify multiple value separated by commas: `"Value1","Value2",..."ValueN"`. Multiple Receive connectors on the same server can have overlapping remote IP address ranges as long as one IP address range is completely overlapped by another. For example, you can configure the following remote IP address ranges on different Receive connectors on the same server: @@ -732,7 +732,7 @@ The Banner parameter specifies a custom SMTP 220 banner that's displayed to remo The default value of this parameter is blank ($null), which uses the following SMTP banner: -220 \ Microsoft ESMTP MAIL service ready at \\ +`220 Microsoft ESMTP MAIL service ready at ` ```yaml Type: String @@ -908,7 +908,7 @@ The DefaultDomain parameter specifies the default accepted domain to use for the Although you can configure any accepted domain as the default domain, you typically specify an authoritative domain. The default domain is used by: -- The external postmaster address: postmaster@\. +- The external postmaster address: `postmaster@`. - Encapsulated non-SMTP email addresses (Internet Mail Connector Encapsulated Address or IMCEA encapsulation). - The primary address for all recipients in the default email address policy. If you configure another accepted domain as the default domain, the default email address policy isn't automatically updated. @@ -1713,7 +1713,7 @@ Accept wildcard characters: False ``` ### -TlsCertificateName -The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is "\X.500Issuer\X.500Subject". The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command $TLSCert = Get-ExchangeCertificate -Thumbprint \, run the command $TLSCertName = "\$($TLSCert.Issuer)\$($TLSCert.Subject)", and then use the value $TLSCertName for this parameter. +The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier @@ -1733,18 +1733,18 @@ The TlsDomainCapabilities parameter specifies the capabilities that the Receive This parameter uses the following syntax: -"\:\,\\>"...,"\:\,\..."... +`"Domain1:Capability1,Capability2,"...,"Domain2:Capability1,Capability2,...",...` -At the moment, this parameter can only be used in Exchange hybrid deployments and the available \ values for this scenario are: +You can only use this parameter in Exchange hybrid deployments, and the valid Capability values are: - AcceptCloudServicesMail (Exchange 2013 or later) - AcceptOorgProtocol (Exchange 2010) -There are more available values but there is no scenario to use them. For more information, see [Advanced Office 365 Routing](https://techcommunity.microsoft.com/t5/exchange-team-blog/advanced-office-365-routing-locking-down-exchange-on-premises/ba-p/609238). +More Capability values are available, but there is no scenario to use them. For more information, see [Advanced Office 365 Routing](https://techcommunity.microsoft.com/t5/exchange-team-blog/advanced-office-365-routing-locking-down-exchange-on-premises/ba-p/609238). -The available \ values are an SMTP domain (for example, contoso.com), or the value NO-TLS for non-TLS encrypted inbound connections. +The available Domain values are an SMTP domain (for example, contoso.com), or the value NO-TLS for non-TLS encrypted inbound connections. -For example, "contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptCloudServicesMail". +For example, `"contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptCloudServicesMail"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/New-RemoteMailbox.md b/exchange/exchange-ps/exchange/New-RemoteMailbox.md index 38f78cd419..dfa0693b91 100644 --- a/exchange/exchange-ps/exchange/New-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/New-RemoteMailbox.md @@ -168,7 +168,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$Credentials = Get-Credential; New-RemoteMailbox -Name "Kim Akers" -Password $Credentials.Password -UserPrincipalName kim@corp.contoso.com +$Credentials = Get-Credential +New-RemoteMailbox -Name "Kim Akers" -Password $Credentials.Password -UserPrincipalName kim@corp.contoso.com ``` This example creates an on-premises mail user and its associated mailbox in the service. The remote routing address doesn't need to be specified because mail flow between the on-premises organization and the service has been configured. Using this configuration, the New-RemoteMailbox cmdlet automatically calculates the SMTP address of the mailbox to be used with the RemoteRoutingAddress parameter. This example also assumes directory synchronization has been configured. @@ -179,7 +180,8 @@ After the new mail user is created, directory synchronization synchronizes the n ### Example 2 ```powershell -$Credentials = Get-Credential; New-RemoteMailbox -Name "Kim Akers" -Password $Credentials.Password -UserPrincipalName kim@corp.contoso.com -OnPremisesOrganizationalUnit "corp.contoso.com/Archive Users" -Archive +$Credentials = Get-Credential +New-RemoteMailbox -Name "Kim Akers" -Password $Credentials.Password -UserPrincipalName kim@corp.contoso.com -OnPremisesOrganizationalUnit "corp.contoso.com/Archive Users" -Archive ``` This example does the following steps: @@ -316,7 +318,7 @@ Accept wildcard characters: False ``` ### -UserPrincipalName -The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format \@\. Typically, the \ value is the domain where the user account resides. +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 @@ -363,9 +365,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -563,7 +565,7 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -662,7 +664,7 @@ Accept wildcard characters: False ``` ### -RemoteRoutingAddress -The RemoteRoutingAddress parameter specifies the SMTP address of the mailbox in the service that this user is associated with. This address is created automatically when the service is initially configured in the format of \.mail.onmicrosoft.com. +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. @@ -699,7 +701,7 @@ Accept wildcard characters: False ``` ### -SamAccountName -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, \_, {, } and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +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 diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md index de16e5ce46..7e47377837 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md @@ -176,7 +176,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If no mailboxes are specified, then no mailboxes are placed on hold. @@ -206,7 +206,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -250,7 +250,7 @@ To identify the Microsoft 365 Group, you can use any value that uniquely identif - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -275,7 +275,7 @@ You can use any value that uniquely identifies the Microsoft 365 Group. For exam - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -293,7 +293,7 @@ Accept wildcard characters: False ### -OneDriveLocation The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value, or you can use the value All to include all sites. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -311,7 +311,7 @@ Accept wildcard characters: False ### -OneDriveLocationException This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -368,7 +368,7 @@ Accept wildcard characters: False ### -SharePointLocation The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. @@ -388,7 +388,7 @@ Accept wildcard characters: False ### -SharePointLocationException This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -413,7 +413,7 @@ You can use any value that uniquely identifies the user. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -453,7 +453,7 @@ You can use any value that uniquely identifies the team. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -475,7 +475,7 @@ The TeamsChannelLocationException parameter specifies the Teams to exclude when - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -500,7 +500,7 @@ You can use any value that uniquely identifies the user. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -523,7 +523,7 @@ The TeamsChatLocationException parameter specifies the Teams users to exclude wh - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md index d142a1a72b..1b21cd4f23 100644 --- a/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md @@ -80,6 +80,8 @@ You view and create labels by using the Get-ComplianceTag and New-ComplianceTag You can't use this parameter with the Name or PublishComplianceTag parameters. +You can't use this parameter for Teams retention rules. + ```yaml Type: String Parameter Sets: ComplianceTag @@ -134,6 +136,8 @@ You view and create labels by using the Get-ComplianceTag and New-ComplianceTag You can't use this parameter with the Name or ApplyComplianceTag parameters. +You can't use this parameter for Teams retention rules. + ```yaml Type: String Parameter Sets: PublishComplianceTag @@ -185,12 +189,14 @@ Accept wildcard characters: False ### -ContentContainsSensitiveInformation The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. -This parameter uses the basic syntax @(@{Name="\";[minCount="\"],@{Name="\";[minCount="\"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). You can use this parameter with the ApplyComplianceTag parameter. +You can't use this parameter for Teams retention rules. + ```yaml Type: PswsHashtable[] Parameter Sets: ComplianceTag @@ -209,6 +215,8 @@ The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +You can't use this parameter for Teams retention rules. + ```yaml Type: String Parameter Sets: ComplianceTag, Default @@ -236,7 +244,9 @@ The ExcludedItemClasses parameter specifies the types of messages to exclude fro Additionally, you can specify [message classes for Exchange items](https://docs.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. -You can specify multiple item class values by using the syntax "Value1","Value2",..."ValueN". +You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. + +You can't use this parameter for Teams retention rules. ```yaml Type: MultiValuedProperty @@ -257,6 +267,8 @@ The ExpirationDateOption parameter specifies whether the expiration date is calc - CreationAgeInDays - ModificationAgeInDays +You can't use this parameter for Teams retention rules. + ```yaml Type: String Parameter Sets: (All) @@ -318,6 +330,8 @@ The RetentionDurationDisplayHint parameter specifies the units that are used to For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Security & Compliance Center will display 1 year as the content hold duration. +You can't use this parameter for Teams retention rules. + ```yaml Type: HoldDurationHint Parameter Sets: Default diff --git a/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md index a2c27b8f79..fa1dc5d663 100644 --- a/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md @@ -405,7 +405,7 @@ The RetentionEnabled parameter specifies whether the tag is enabled. When set to Messages with a disabled tag are still considered tagged, so any tags of the same type as the disabled tag in the user's retention policy aren't applied to such messages. -When you set the RetentionEnabled parameter to $false, the retention period for the tag is shown as Never. Users may apply this tag to items they want to indicate should never be deleted or should never be moved to the archive. Enabling the tag later may result in unintentional deletion or archiving of items. To avoid this situation, if a retention policy is disabled temporarily, it may be advisable to change the name of that tag so that users are discouraged from using it, such as DISABLED\_\. +When you set the RetentionEnabled parameter to $false, the retention period for the tag is shown as Never. Users may apply this tag to items they want to indicate should never be deleted or should never be moved to the archive. Enabling the tag later may result in unintentional deletion or archiving of items. To avoid this situation, if a retention policy is disabled temporarily, it may be advisable to change the name of that tag so that users are discouraged from using it, such as `DISABLED_`. ```yaml Type: Boolean diff --git a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md index 13188c9e53..57976f7ead 100644 --- a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md @@ -44,7 +44,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -New-RoleAssignmentPolicy -Name "End User Policy"; Set-Mailbox -Identity Joe -RoleAssignmentPolicy "End User Policy" +New-RoleAssignmentPolicy -Name "End User Policy" +Set-Mailbox -Identity Joe -RoleAssignmentPolicy "End User Policy" ``` This example creates an assignment policy. After the assignment policy is created, you can assign the assignment policy to a mailbox using the Set-Mailbox cmdlet. @@ -58,7 +59,8 @@ This example creates an assignment policy using the IsDefault switch. ### Example 3 ```powershell -New-RoleAssignmentPolicy -Name "Limited End User Policy" -Roles "MyPersonalInformation", "MyDistributionGroupMembership", "MyVoiceMail" -IsDefault; Get-Mailbox -ResultSize Unlimited | Set-Mailbox -RoleAssignmentPolicy "Limited End User Policy" +New-RoleAssignmentPolicy -Name "Limited End User Policy" -Roles "MyPersonalInformation", "MyDistributionGroupMembership", "MyVoiceMail" -IsDefault +Get-Mailbox -ResultSize Unlimited | Set-Mailbox -RoleAssignmentPolicy "Limited End User Policy" ``` This example creates an assignment policy that enables users to modify their personal information, manage their distribution group membership, and manage their voice mail. The new assignment policy is created as the new default assignment policy. Then, all existing mailboxes are configured to use the new assignment policy. diff --git a/exchange/exchange-ps/exchange/New-RoleGroup.md b/exchange/exchange-ps/exchange/New-RoleGroup.md index 4d7ad35bfb..c80427b225 100644 --- a/exchange/exchange-ps/exchange/New-RoleGroup.md +++ b/exchange/exchange-ps/exchange/New-RoleGroup.md @@ -93,7 +93,8 @@ This example creates a role group and enables Isabel to add or remove members to ### Example 4 ```powershell -$Credentials = Get-Credential; New-RoleGroup -Name "ContosoUsers: Toronto Recipient Admins" -LinkedDomainController dc02.contosousers.contoso.com -LinkedCredential $Credentials -LinkedForeignGroup "Toronto Administrators" -CustomRecipientWriteScope "Toronto Recipients" -Roles "Mail Recipients" +$Credentials = Get-Credential +New-RoleGroup -Name "ContosoUsers: Toronto Recipient Admins" -LinkedDomainController dc02.contosousers.contoso.com -LinkedCredential $Credentials -LinkedForeignGroup "Toronto Administrators" -CustomRecipientWriteScope "Toronto Recipients" -Roles "Mail Recipients" ``` This example creates a linked role group that enables the members of the Toronto Administrators USG in the Contoso user forest to manage recipients located in the Toronto office. The custom recipient scope, Toronto Recipients, limits the scope of the roles assigned to the role group to recipients who have their City property set to Toronto. The Mail Recipients role is assigned to the role group. @@ -102,7 +103,8 @@ The first command retrieves the credentials using the Get-Credential cmdlet and ### Example 5 ```powershell -$RoleGroup = Get-RoleGroup "Recipient Management"; New-RoleGroup "Limited Recipient Management" -Roles $RoleGroup.Roles +$RoleGroup = Get-RoleGroup "Recipient Management" +New-RoleGroup "Limited Recipient Management" -Roles $RoleGroup.Roles ``` This example takes an existing role group and copies the roles from that role group into a new custom role group. This can be useful if you want to create a role group similar to an existing role group but don't want to manually create all the role assignments. For example, you might want to create a role group that has most, but not all, of the management roles assigned to the Recipient Management role group. @@ -163,7 +165,7 @@ Accept wildcard characters: False ### -Name The Name parameter specifies the name of the new role group. The name can have a maximum of 64 characters. If the name contains spaces, enclose the name in quotation marks ("). -Note: If you create a linked role group, we recommend that you include the name of the foreign forest in the name of the role group so that you can more easily associate the linked role group and the associated foreign forest. This is especially important if you have multiple forests. +**Note**: If you create a linked role group, we recommend that you include the name of the foreign forest in the name of the role group so that you can more easily associate the linked role group and the associated foreign forest. This is especially important if you have multiple forests. ```yaml Type: String @@ -398,7 +400,7 @@ Accept wildcard characters: False ### -SamAccountName This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, \_, {, } and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-RpcClientAccess.md b/exchange/exchange-ps/exchange/New-RpcClientAccess.md index 66011bff50..700a2c6f64 100644 --- a/exchange/exchange-ps/exchange/New-RpcClientAccess.md +++ b/exchange/exchange-ps/exchange/New-RpcClientAccess.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in Exchange Server 2010. -Use the New-RpcClientAccess cmdlet to create configuration information for the Exchange RPC Client Access service on a Client Access server. This setup task is performed by default on new installations of the Client Access server role on Microsoft Exchange Server 2010. +Use the New-RpcClientAccess cmdlet to create configuration information for the Exchange RPC Client Access service on a Client Access server. This set up task is performed by default on new installations of the Client Access server role on Microsoft Exchange Server 2010. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md index ab42a8b40e..8df4ac6586 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md @@ -36,7 +36,7 @@ New-SafeAttachmentPolicy [-Name] ``` ## DESCRIPTION -Safe Attachments is a feature in Office 365 Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Office 365 ATP](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the SafeAttachmentPolicy parameter on the New-SafeAttachmentRule or Set-SafeAttachmentRule cmdlets to associate the policy with a rule. diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md index c68eb779e0..720e7009df 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md @@ -43,7 +43,7 @@ You need to specify at least one condition for the rule. You need to add the safe attachment rule to an existing policy by using the SafeAttachmentPolicy parameter. You create safe attachment policies by using the New-SafeAttachmentPolicy cmdlet. -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Office 365 ATP](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -184,7 +184,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -209,7 +209,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception that looks for messa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. @@ -276,7 +276,7 @@ The SentTo parameter specifies a condition that looks for recipients in messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -301,7 +301,7 @@ The SentToMemberOf parameter specifies a condition that looks for messages sent - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. diff --git a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md index acb3ca4d50..72d5917d67 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md @@ -43,7 +43,7 @@ New-SafeLinksPolicy [-Name] ``` ## DESCRIPTION -Safe Links is a feature in Office 365 Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the SafeLinksPolicy parameter on the New-SafeLinksRule or Set-SafeLinksRule cmdlets to associate the policy with a rule. @@ -134,7 +134,7 @@ Accept wildcard characters: False ### -DeliverMessageAfterScan The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: -- $true: Wait until Safe Links scanning is complete before delivering the message. +- $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. - $false: If Safe Links scanning can't complete, deliver the message anyway. This is the default value. ```yaml @@ -172,11 +172,11 @@ Accept wildcard characters: False ### -DoNotRewriteUrls The DoNotRewriteUrls parameter specifies the URLs that are not rewritten by Safe Links scanning. The list of entries allows users who are included in the policy to access the specified URLs that would otherwise be blocked by Safe Links. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -For details about the entry syntax, see [Entry syntax for the "Do not rewrite the following URLs" list](https://docs.microsoft.com/en-us/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). +For details about the entry syntax, see [Entry syntax for the "Do not rewrite the following URLs" list](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/New-SafeLinksRule.md b/exchange/exchange-ps/exchange/New-SafeLinksRule.md index 5f1515f6bc..67543e3144 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/New-SafeLinksRule.md @@ -41,7 +41,7 @@ New-SafeLinksRule [-Name] -SafeLinksPolicy ## DESCRIPTION You need to specify at least one condition for the rule. -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -182,7 +182,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -207,7 +207,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception that looks for messa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. @@ -274,7 +274,7 @@ The SentTo parameter specifies a condition that looks for recipients in messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -299,7 +299,7 @@ The SentToMemberOf parameter specifies a condition that looks for messages sent - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. diff --git a/exchange/exchange-ps/exchange/New-SendConnector.md b/exchange/exchange-ps/exchange/New-SendConnector.md index cd74f6fd8f..1f62a66f9a 100644 --- a/exchange/exchange-ps/exchange/New-SendConnector.md +++ b/exchange/exchange-ps/exchange/New-SendConnector.md @@ -121,7 +121,8 @@ This example creates the Send connector named MySendConnector with the following ### Example 2 ```powershell -$CredentialObject = Get-Credential; New-SendConnector -Name "Secure Email to Contoso.com" -AddressSpaces contoso.com -AuthenticationCredential $CredentialObject -SmartHostAuthMechanism BasicAuth +$CredentialObject = Get-Credential +New-SendConnector -Name "Secure Email to Contoso.com" -AddressSpaces contoso.com -AuthenticationCredential $CredentialObject -SmartHostAuthMechanism BasicAuth ``` This example creates the Send connector Secure Email to Contoso.com with the following properties: @@ -151,7 +152,7 @@ Accept wildcard characters: False ``` ### -AddressSpaces -The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The complete syntax for entering each address space is as follows: \:\;\ +The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. - AddressSpaceType: On an Edge server, the address space type must be SMTP. In the Transport service on a Mailbox server, the address space type may be SMTP, X400, or any other text string. If you omit the address space type, SMTP is assumed. - AddressSpace: For SMTP address space types, the address space that you enter must be RFC 1035-compliant. For example, \*, \*.com, and \*.contoso.com are permitted, but \*contoso.com is not. For X.400 address space types, the address space that you enter must be RFC 1685-compliant, such as o=MySite;p=MyOrg;a=adatum;c=us. For all other values of address space type, you can enter any text for the address space. @@ -205,7 +206,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -601,14 +602,14 @@ The LinkedReceiveConnector parameter specifies whether to force all messages rec - GUID - Distinguished name (DN) -- Servername\\ConnectorName +- ServerName\\ConnectorName When you use the LinkReceiveConnector parameter with this command, you must also use the following parameters with the specified values: -- DNSRoutingEnabled $false -- MaxMessageSize unlimited -- Smarthosts \ -- SmarthostAuthMechanism \ +- `DNSRoutingEnabled $false` +- `MaxMessageSize unlimited` +- `Smarthosts ` +- `SmarthostAuthMechanism ` When you use the LinkedReceiveConnector parameter, you can't use the AddressSpaces parameter. @@ -759,7 +760,7 @@ Accept wildcard characters: False ### -SmartHosts The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameter is required if you set the DNSRoutingEnabled parameter to $false and it must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. If you enter an IP address, you must enter the IP address as a literal. For example, 10.10.1.1. The smart host identity can be the FQDN of a smart-host server, a mail exchanger (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart host server. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -809,7 +810,7 @@ Accept wildcard characters: False ### -SourceTransportServers The SourceTransportServers parameter specifies the names of the Mailbox servers that can use this Send connector. This parameter isn't valid for Send connectors configured on an Edge server. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -847,7 +848,7 @@ Accept wildcard characters: False ``` ### -TlsCertificateName -The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is "\X.500Issuer\X.500Subject". The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command $TLSCert = Get-ExchangeCertificate -Thumbprint \, run the command $TLSCertName = "\$($TLSCert.Issuer)\$($TLSCert.Subject)", and then use the value $TLSCertName for this parameter. +The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier diff --git a/exchange/exchange-ps/exchange/New-SettingOverride.md b/exchange/exchange-ps/exchange/New-SettingOverride.md index e4837b1b00..ac1cd69ff7 100644 --- a/exchange/exchange-ps/exchange/New-SettingOverride.md +++ b/exchange/exchange-ps/exchange/New-SettingOverride.md @@ -97,10 +97,10 @@ Accept wildcard characters: False ``` ### -Parameters -The Parameters parameter specifies one or more parameters for the override that are available for the combination of the Component and Section parameter values. This parameter uses the syntax @("\=\","\=\"...). For example: +The Parameters parameter specifies one or more parameters for the override that are available for the combination of the Component and Section parameter values. This parameter uses the syntax: `@("Parameter1=Value1","Parameter2=Value2"...)`. For example: -- @("Enabled=true") -- @("IMServerName=\","IMCertificateThumbprint=\") +- `@("Enabled=true")` +- `@("IMServerName=","IMCertificateThumbprint=")` ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md index b4bc2b4b30..41fb5aabc9 100644 --- a/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md @@ -127,7 +127,7 @@ Accept wildcard characters: False ### -DefaultAliasPrefixEnabled The DefaultAliasPrefixEnabled parameter specifies whether new site mailboxes have the default prefix text added to the alias. Valid values are: -- $true: Aliases get the default prefix text. This is the default value. In Microsoft 365, the default prefix text is SMO- (for example, the alias value BugBash\_2016 becomes SMO-BugBash\_2016). In on-premises Exchange, the default prefix text is SM- (for example, the alias value BugBash\_2016 becomes SM-BugBash\_2016). +- $true: Aliases get the default prefix text. This is the default value. In Microsoft 365, the default prefix text is `SMO-` (for example, the alias value `BugBash_2016` becomes `SMO-BugBash_2016`). In on-premises Exchange, the default prefix text is `SM-` (for example, the alias value `BugBash_2016` becomes `SM-BugBash_2016`). - $false: Aliases don't get the default prefix text. The value of this parameter is related to the value of the AliasPrefix parameter. If you specify a text string for AliasPrefix, the DefaultAliasPrefixEnabled value is ignored. Specifying a text value for AliasPrefix automatically sets the value to $false, but even if you set it to $true, the default alias prefix text isn't used. diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md index d2bfc5e046..19f40b4af8 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md @@ -87,15 +87,15 @@ Accept wildcard characters: False ### -Condition The Condition parameter specifies the conditions and exceptions for the rule. This parameter uses the following syntax: -- User or group communications to supervise: "((Reviewee:\) -OR (Reviewee:\)...)". Exceptions use the syntax "(NOT((Reviewee:\) -OR (Reviewee:\)...))". -- Direction: "((Direction:Inbound) -OR (Direction:Outbound) -OR (Direction:Internal))". -- Message contains words: "((\) -OR (\)...)". Exceptions use the syntax "(NOT((\)-OR (\)...))". -- Any attachment contains words: "((Attachment:\) -OR (Attachment:\)...)". Exceptions use the syntax "(NOT((Attachment:\)-OR (Attachment:\)...))". -- Any attachment has the extension: "((AttachmentName:.\) -OR (AttachmentName:.\)...)". Exceptions use the syntax "(NOT((AttachmentName:.\)-OR (AttachmentName:.\)...))". -- Message size is larger than: "(MessageSize:\)". For example "(MessageSize:300KB)". Exceptions use the syntax "(NOT(MessageSize:\))". -- Any attachment is larger than: "(AttachmentSize:\)". For example "(AttachmentSize:3MB)". Exceptions use the syntax "(NOT(AttachmentSize:\))". +- User or group communications to supervise: `"((Reviewee:) -OR (Reviewee:)...)"`. Exceptions use the syntax `"(NOT((Reviewee:) -OR (Reviewee:)...))"`. +- Direction: `"((Direction:Inbound) -OR (Direction:Outbound) -OR (Direction:Internal))"`. +- Message contains words: `"(() -OR ()...)"`. Exceptions use the syntax `"(NOT(() -OR ()...))"`. +- Any attachment contains words: `"((Attachment:) -OR (Attachment:)...)"`. Exceptions use the syntax `"(NOT((Attachment:) -OR (Attachment:)...))"`. +- Any attachment has the extension: `"((AttachmentName:.) -OR (AttachmentName:.)...)"`. Exceptions use the syntax `"(NOT((AttachmentName:.) -OR (AttachmentName:.)...))"`. +- Message size is larger than: `"(MessageSize:)"`. For example `"(MessageSize:300KB)"`. Exceptions use the syntax `"(NOT(MessageSize:))"`. +- Any attachment is larger than: `"(AttachmentSize:)"`. For example `"(AttachmentSize:3MB)"`. Exceptions use the syntax `"(NOT(AttachmentSize:))"`. - Parentheses ( ) are required around the whole filter. -- Separate multiple conditions or exception types with the -AND operator. For example, "((Reviewee:chris@contoso.com) -AND (AttachmentSize:3MB))". +- Separate multiple conditions or exception types with the AND operator. For example, `"((Reviewee:chris@contoso.com) -AND (AttachmentSize:3MB))"`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md b/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md index 7af3aa1fb9..5b95574275 100644 --- a/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md +++ b/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md @@ -96,9 +96,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -150,7 +150,7 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -To enter multiple senders, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can specify multiple senders separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -200,7 +200,7 @@ Valid values for this parameter are recipients in your organization. You can use - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -515,23 +515,21 @@ Accept wildcard characters: False ### -EmailAddresses The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is \:\,\:\,...\:\. The optional \ value specifies the type of email address. Some examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a \ value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: -- Use the \ value SMTP on the address. -- The first email address when you don't use any \ values, or when you use multiple \ values of smtp. +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. - If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. -To enter multiple proxy email addresses, use the following syntax: "\:\","\:\",..."\:\". - ```yaml Type: ProxyAddress[] Parameter Sets: (All) @@ -592,7 +590,7 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo -The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mail-enabled public folder. Although messages send on behalf of the public folder clearly show the sender in the From field (\ on behalf of \), replies to these messages are delivered to the public folder, not the sender. +The 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: @@ -603,7 +601,7 @@ The sender you specify for this parameter must be a mailbox, mail user or mail-e - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. By default, this parameter is blank, which means no one else has permission to send on behalf of this public folder. @@ -741,7 +739,7 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -To enter multiple senders, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can specify multiple senders separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. diff --git a/exchange/exchange-ps/exchange/New-SystemMessage.md b/exchange/exchange-ps/exchange/New-SystemMessage.md index afbe33eea7..4f679b857a 100644 --- a/exchange/exchange-ps/exchange/New-SystemMessage.md +++ b/exchange/exchange-ps/exchange/New-SystemMessage.md @@ -66,7 +66,7 @@ The DsnCode parameter specifies the enhanced status code for the custom system m Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. You can specify a default code that's included with Exchange, or you can specify a custom code. -To generate a list of default enhanced status codes that are used by Exchange, run this command: Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\\My Documents\\Default DSNs.html". +To generate a list of default enhanced status codes that are used by Exchange, run this command: `Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\My Documents\Default DSNs.html"`. You need to use this parameter with the Language and Internal parameters. @@ -109,7 +109,7 @@ Accept wildcard characters: False ``` ### -Language -The Language parameter specifies the language of the message \(for example, en for English or ja for Japanese). For the list of supported language codes, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). +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://docs.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. @@ -189,22 +189,22 @@ This parameter can contain text and HTML tags. The maximum length is 512 charact The following HTML tags are available: -- \ and \ (bold) -- \ and \ (italic) -- \ (line break) -- \ and \ (paragraph) -- \ and \ (hyperlink). Note: You need to use single quotation marks (not double quotation marks) around the complete text string if you use this tag. Otherwise, you'll receive an error (because of the double quotation marks in the tag). +- `` and `` (bold) +- `` and `` (italic) +- `
` (line break) +- `

` and `

` (paragraph) +- `` and `` (hyperlink). Note: You need to use single quotation marks (not double quotation marks) around the complete text string if you use this tag. Otherwise, you'll receive an error (because of the double quotation marks in the tag). Use the following escape codes for these special characters: -- < for \<. -- > for \>. -- " for ". -- & for &. +- `<` for \< +- `>` for \> +- `"` for " +- `&` for & Here's an example value for this parameter that uses HTML tags and special characters: -'You tried to send a message to a \disabled\ mailbox. Please visit \Internal Support\ or contact "InfoSec" for more information.' +`'You tried to send a message to a disabled mailbox. Please visit Internal Support or contact "InfoSec" for more information.'` ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md index cb9e2f2a2b..21c814f3d1 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -7,7 +7,7 @@ schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: -ROBOTS: NOINDEX, NOFOLLOW +ROBOTS: NOINDEX --- # New-TenantAllowBlockListItems @@ -89,7 +89,7 @@ The Entries parameter specifies the URL or files that you want to add to the Ten - URLs: Use IPv4 or IPv6 addresses or hostnames. Wildcards (* and ~) are supported in hostnames. Protocols, TCP/UDP ports, or user credentials are not supported. For details, see [URL syntax for the Tenant Allow/Block List](https://docs.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list#url-syntax-for-the-tenant-allowedblocked-list). - Files: Use the SHA256 hash value of the file. In Windows, you can find the SHA256 hash value by running the following command in a Command Prompt: `certutil.exe -hashfile "\" SHA256`. An example value is `768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3`. -To enter multiple values, use the following syntax: "\","\",..."\". +To enter multiple values, use the following syntax: `"Value1","Value2",..."ValueN"`. You can't mix URL and file values or allow and block actions in the same command. You can't modify existing URL or file values after you create the entry (there's no Entries parameter on the Set-TenantAllowBlockListItems cmdlet). diff --git a/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md index 425bbd0cf7..7934dd2e2a 100644 --- a/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md +++ b/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md @@ -173,7 +173,7 @@ New-ThrottlingPolicy [-Name] ``` ## DESCRIPTION -By default, there is one default throttling policy named GlobalThrottlingPolicy\_\ with a throttling scope of Global. Microsoft Exchange Setup creates a default client throttling policy as part of the Client Access server role. You should not replace, re-create, or remove the existing default throttling policy. However, you can create additional throttling policies with the scope of Organization or Regular to change your user throttling settings. You can also edit policies with the scope of Organization and Regular that you've created using the Set-ThrottlingPolicy cmdlet. +By default, there is one default throttling policy named `GlobalThrottlingPolicy_` with a throttling scope of Global. Microsoft Exchange Setup creates a default client throttling policy as part of the Client Access server role. You should not replace, re-create, or remove the existing default throttling policy. However, you can create additional throttling policies with the scope of Organization or Regular to change your user throttling settings. You can also edit policies with the scope of Organization and Regular that you've created using the Set-ThrottlingPolicy cmdlet. For more information about how to control how resources are consumed by individual users, see [User workload management in Exchange Server](https://docs.microsoft.com/Exchange/server-health/workload-management). @@ -193,7 +193,7 @@ In Exchange Server 2010, this example creates a non-default throttling policy. A New-ThrottlingPolicy -Name ITUserPolicy -EwsMaxConcurrency 4 -ThrottlingPolicyScope Regular ``` -This example creates a non-default user throttling policy that can be associated with specific users. Any parameters that you omit inherit the values from the default throttling policy GlobalThrottlingPolicy\_\. After you create this policy, you must associate it with specific users. +This example creates a non-default user throttling policy that can be associated with specific users. Any parameters that you omit inherit the values from the default throttling policy `GlobalThrottlingPolicy_`. After you create this policy, you must associate it with specific users. ### Example 3 ```powershell @@ -207,7 +207,7 @@ In Exchange Server 2010, this example creates a policy for a tenant that sets th New-ThrottlingPolicy -Name AllUsersEWSPolicy -EwsMaxConcurrency 4 -ThrottlingPolicyScope Organization ``` -This example creates a policy that applies to all users in your organization. Any parameters that you omit inherit the values from the default throttling policy GlobalThrottlingPolicy\_\. +This example creates a policy that applies to all users in your organization. Any parameters that you omit inherit the values from the default throttling policy `GlobalThrottlingPolicy_`. ### Example 5 ```powershell @@ -233,7 +233,7 @@ This example creates a throttling policy that restricts a user to be able to onl ## PARAMETERS ### -Name -The Name parameter specifies the name of the object in Active Directory. The default policy is named DefaultThrottlingPolicy\. +The Name parameter specifies the name of the object in Active Directory. The default policy is named `DefaultThrottlingPolicy`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index ef7f992fcd..431eec6291 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -374,7 +374,7 @@ The AddToRecipients parameter specifies an action that adds recipients to the To - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -403,11 +403,11 @@ The AnyOfCcHeader parameter specifies a condition that looks for recipients in t - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -436,11 +436,11 @@ The AnyOfCcHeaderMemberOf parameter specifies a condition that looks for group m - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -464,7 +464,7 @@ The AnyOfRecipientAddressContainsWords parameter specifies a condition that look A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: Word[] @@ -484,11 +484,11 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. -The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: Pattern[] @@ -517,11 +517,11 @@ The AnyOfToCcHeader parameter specifies a condition that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -550,11 +550,11 @@ The AnyOfToCcHeaderMemberOf parameter specifies a condition that looks for group - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -583,11 +583,11 @@ The AnyOfToHeader parameter specifies a condition that looks for recipients in t - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -616,11 +616,11 @@ The AnyOfToHeaderMemberOf parameter specifies a condition that looks for group m - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -691,7 +691,7 @@ In on-premises Exchange, this action is only available on Mailbox servers. The ApplyHtmlDisclaimerLocation parameter specifies where to insert the HTML disclaimer text in the body of messages. Valid values are: - Append: The disclaimer is added to the end of the message body. This is the default value. -- Prepend: The disclaimer is inserted to the beginning of the message body. +- Prepend: The disclaimer is inserted at the beginning of the message body. If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Append is used. @@ -919,7 +919,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The AttachmentMatchesPatterns parameter specifies a condition that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. -You can specify multiple text patterns by using the following syntax: "\","\",..."\". +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. Only the first 150 kilobytes (KB) of the attachment is scanned when trying to match a text pattern. @@ -941,7 +941,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. -The AttachmentNameMatchesPatterns parameter specifies a condition that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The AttachmentNameMatchesPatterns parameter specifies a condition that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] @@ -1066,7 +1066,7 @@ The BetweenMemberOf1 parameter specifies a condition that looks for messages tha - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1095,7 +1095,7 @@ The BetweenMemberOf2 parameter specifies a condition that looks for messages tha - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1124,7 +1124,7 @@ The BlindCopyTo parameter specifies an action that adds recipients to the Bcc fi - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1210,7 +1210,7 @@ The CopyTo parameter specifies an action that adds recipients to the Cc field of - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1417,11 +1417,11 @@ The ExceptIfAnyOfCcHeader parameter specifies an exception that looks for recipi - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1450,11 +1450,11 @@ The ExceptIfAnyOfCcHeaderMemberOf parameter specifies an exception that looks fo - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1478,7 +1478,7 @@ The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: Word[] @@ -1498,11 +1498,11 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. -The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: Pattern[] @@ -1531,11 +1531,11 @@ The ExceptIfAnyOfToCcHeader parameter specifies an exception that looks for reci - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1564,11 +1564,11 @@ The ExceptIfAnyOfToCcHeaderMemberOf parameter specifies an exception that looks - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1597,11 +1597,11 @@ The ExceptIfAnyOfToHeader parameter specifies an exception that looks for recipi - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1630,11 +1630,11 @@ The ExceptIfAnyOfToHeaderMemberOf parameter specifies an exception that looks fo - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1769,7 +1769,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfAttachmentMatchesPatterns parameter specifies an exception that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. -You can specify multiple text patterns by using the following syntax: "\","\",..."\". +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. Only the first 150 KB of the attachment is scanned when trying to match a text pattern. @@ -1791,7 +1791,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is only available on Mailbox servers. -The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] @@ -1914,7 +1914,7 @@ The ExceptIfBetweenMemberOf1 parameter specifies an exception that looks for mes - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1943,7 +1943,7 @@ The ExceptIfBetweenMemberOf2 parameter specifies an exception that looks for mes - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1994,7 +1994,7 @@ The ExceptIfFrom parameter specifies an exception that looks for messages from s - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -2038,7 +2038,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. -The ExceptIfFromAddressMatchesPatterns parameter specifies an exception that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfFromAddressMatchesPatterns parameter specifies an exception that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -2069,7 +2069,7 @@ The ExceptIfFromMemberOf parameter specifies an exception that looks for message - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -2250,7 +2250,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. -The ExceptIfHeaderMatchesPatterns parameter specifies an exception that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfHeaderMatchesPatterns parameter specifies an exception that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. You specify the header field to search by using the ExceptIfHeaderMatchesMessageHeader parameter. @@ -2281,7 +2281,7 @@ The ExceptIfManagerAddresses parameter specifies the users (managers) for the Ex - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You specify if you want to look for these users as managers of senders or recipients by using the ExceptIfManagerForEvaluatedUser parameter. @@ -2348,7 +2348,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfMessageContainsDataClassifications parameter specifies an exception that looks for sensitive information types in the body of messages, and in any attachments. -This parameter uses the syntax @{\},@{\},...@{\}. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. +This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). @@ -2560,7 +2560,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is only available on Mailbox servers. -The ExceptIfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -2859,7 +2859,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -2884,7 +2884,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception that looks for messa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. @@ -2953,7 +2953,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. -The ExceptIfSubjectMatchesPatterns parameter specifies an exception that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfSubjectMatchesPatterns parameter specifies an exception that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] @@ -2995,7 +2995,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. -The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] @@ -3068,7 +3068,7 @@ The From parameter specifies a condition that looks for messages from specific s - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -3112,7 +3112,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. -The FromAddressMatchesPatterns parameter specifies a condition that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The FromAddressMatchesPatterns parameter specifies a condition that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -3143,7 +3143,7 @@ The FromMemberOf parameter specifies a condition that looks for messages sent by - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -3382,7 +3382,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. -The HeaderMatchesPatterns parameter specifies a condition that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The HeaderMatchesPatterns parameter specifies a condition that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. You specify the header field to search by using the HeaderMatchesMessageHeader parameter. @@ -3478,7 +3478,7 @@ The entry contains the following information: - Source: MSExchange Messaging Policies - Event ID: 4000 - Task Category: Rules -- EventData: The following message is logged by an action in the rules: \ +- EventData: `The following message is logged by an action in the rules: ` ```yaml Type: EventLogText @@ -3507,7 +3507,7 @@ The ManagerAddresses parameter specifies the users (managers) for the ExceptIfMa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You specify if you want to look for these users as managers of senders or recipients by using the ManagerForEvaluatedUser parameter. @@ -3574,7 +3574,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The MessageContainsDataClassifications parameter specifies a condition that looks for sensitive information types in the body of messages, and in any attachments. -This parameter uses the syntax @{\},@{\},...@{\}. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. +This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). @@ -3712,7 +3712,7 @@ The ModerateMessageByUser parameter specifies an action that forwards messages f - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can't use a distribution group as a moderator. @@ -3764,7 +3764,7 @@ This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. -The PrependSubject parameter specifies an action that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks (")\> +The PrependSubject parameter specifies an action that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. @@ -3963,7 +3963,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. -The RecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The RecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -4034,7 +4034,7 @@ The RedirectMessageTo parameter specifies a rule action that redirects messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -4522,7 +4522,7 @@ The SentTo parameter specifies a condition that looks for recipients in messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -4551,7 +4551,7 @@ The SentToMemberOf parameter specifies a condition that looks for messages sent - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. @@ -4775,7 +4775,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. -The SubjectMatchesPatterns parameter specifies a condition that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The SubjectMatchesPatterns parameter specifies a condition that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] @@ -4817,7 +4817,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. -The SubjectOrBodyMatchesPatterns parameter specifies a condition that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The SubjectOrBodyMatchesPatterns parameter specifies a condition that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] diff --git a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md index fc5f98cc9c..28bd961542 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md @@ -100,12 +100,13 @@ The RetentionDuration parameter specifies how long audit log records are kept. V - SixMonths - NineMonths - TwelveMonths +- TenYears ```yaml Type: UnifiedAuditLogRetentionDuration Parameter Sets: (All) Aliases: -Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths +Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears Applicable: Security & Compliance Center Required: True @@ -153,7 +154,7 @@ Accept wildcard characters: False ### -Operations The Operations parameter specifies the audit log operations that are retained by the policy. For a list of the available values for this parameter, see [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you use this parameter, you must also use the RecordTypes parameter to specify the record type. You can't use this parameter if you've specified more than one value for the RecordTypes parameter. @@ -191,7 +192,7 @@ Accept wildcard characters: False ### -UserIds The UserIds parameter specifies the audit logs that are retained by the policy based on the ID of the user who performed the action. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/New-UnifiedGroup.md b/exchange/exchange-ps/exchange/New-UnifiedGroup.md index bcfca74024..28d13f4425 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/New-UnifiedGroup.md @@ -128,7 +128,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -New-UnifiedGroup -DisplayName "Engineering Department" -Alias engineering +New-UnifiedGroup -DisplayName "Engineering Department" -Alias "engineering" ``` This example creates a new Microsoft 365 Group named Engineering Department. @@ -165,7 +165,7 @@ The DlIdentity parameter specifies the distribution group (also known as a distr All the properties and membership of the distribution group are copied to the Microsoft 365 Group. -The alias and proxy addresses of the distribution group are moved to the Microsoft 365 Group, and are replaced on the distribution group by the values DLMigrated\_\. The original proxy addresses are copied to the ExtensionCustomAttribute5 property of the distribution group. +The alias and proxy addresses of the distribution group are moved to the Microsoft 365 Group, and are replaced on the distribution group by the values `DLMigrated_`. The original proxy addresses are copied to the ExtensionCustomAttribute5 property of the distribution group. Microsoft 365 Groups don't have ReportToManager and ReportToOriginator parameters, so the values of these parameters aren't migrated from the distribution group to the Microsoft 365 Group. The Microsoft 365 Group behaves as if the default values of these parameters were set (ReportToManager is $false and ReportToOriginator is $true). In other words, delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the message sender and not to the owner of the Microsoft 365 Group. @@ -190,7 +190,7 @@ The AccessType parameter specifies the privacy type for the Microsoft 365 Group. You can change the privacy type at any point in the lifecycle of the group. -Note: Although a user needs to be a member to participate in a private group, anyone can send email to a private group, and receive replies from the private group. +**Note**: Although a user needs to be a member to participate in a private group, anyone can send email to a private group, and receive replies from the private group. ```yaml Type: ModernGroupTypeInfo @@ -208,13 +208,13 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Microsoft 365 Group. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. If you don't use the Alias parameter when you create a Microsoft 365 Group, the value of the DisplayName parameter is used for the Alias value. Spaces are removed, unsupported characters are converted to question marks (?), and numbers may be added to maintain the uniqueness of the Alias value. -When you create a Microsoft 365 Group without using the EmailAddresses parameter, the Alias value is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a Microsoft 365 Group without using the EmailAddresses parameter, the Alias value is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. -The Alias value is appended with the ExternalDirectoryObjectId property value and used as the Name property value for the Microsoft 365 Group ("Alias\_\"\). +The Alias value is appended with the ExternalDirectoryObjectId property value and used as the Name property value for the Microsoft 365 Group (`_`). ```yaml Type: String @@ -368,23 +368,21 @@ Accept wildcard characters: False ### -EmailAddresses The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is \:\,\:\,...\:\. The optional \ value specifies the type of email address. Some examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a \ value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: -- Use the \ value SMTP on the address. -- The first email address when you don't use any \ values, or when you use multiple \ values of smtp. +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. - Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. -To enter multiple proxy email addresses, use the following syntax: "\:\","\:\",..."\:\". - ```yaml Type: ProxyAddressCollection Parameter Sets: Identity, ProvisioningOptions, SegmentationOption @@ -437,7 +435,7 @@ The HiddenGroupMembershipEnabled switch specifies whether to hide the members of You can use this setting to help comply with regulations that require you to hide group membership from outsiders (for example, a Microsoft 365 Group group that represents students enrolled in a class). -Note: You can't change this setting after you create the group. If you create the group with hidden membership, you can't edit the group later to reveal the membership to the group. +**Note**: You can't change this setting after you create the group. If you create the group with hidden membership, you can't edit the group later to reveal the membership to the group. ```yaml Type: SwitchParameter @@ -512,7 +510,7 @@ The Members parameter specifies the recipients (mail-enabled objects) that are m - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -530,7 +528,7 @@ Accept wildcard characters: False ### -Name This parameter has been deprecated and is no longer used. -Previously, if you specified a value for this parameter, a random GUID value was added and used as the Name property value for the Microsoft 365 Group \("Name\_\"\). Now, the value of the Name property is populated by the Alias parameter value and the ExternalDirectoryObjectId property value ("Alias\_\"\). +Previously, if you specified a value for this parameter, a random GUID value was added and used as the Name property value for the Microsoft 365 Group (`Name_`). Now, the value of the Name property is populated by the Alias parameter value and the ExternalDirectoryObjectId property value (`_`). ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md index fb3377a239..19c53b4765 100644 --- a/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md @@ -212,7 +212,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -234,9 +234,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md index 47abb882ab..b9da42598f 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md @@ -14,9 +14,7 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Preview-QuarantineMessage cmdlet to preview the contents of quarantined messages in your cloud-based organization. - -**Note**: This cmdlet isn't available for files that are protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business, and Microsoft Teams. +Use the Preview-QuarantineMessage cmdlet to preview the contents of quarantined messages in your cloud-based organization. This cmdlet doesn't work on files that were quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md index 909602cdef..414f3bd590 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Release-QuarantineMessage cmdlet to release messages from quarantine in your cloud-based organization. You can release messages to all original recipients, or to specific recipients. -For files that are protected by Office 365 Advanced Threat Protection in SharePoint Online, OneDrive for Business and Microsoft Teams, you can unblock the files in the respective team sites and document libraries by using the Release-QuarantineMessage cmdlet so users can access, share, and download the files. +For files that were quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, you can unblock the files in the respective team sites and document libraries by using the Release-QuarantineMessage cmdlet so users can access, share, and download the files. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -102,10 +102,11 @@ This example releases all messages to all original recipients. ### Example 4 ```powershell -$q = Get-QuarantineMessage -QuarantineTypes SPOMalware; $q[-1] | Release-QuarantineMessage -ReleaseToAll +$q = Get-QuarantineMessage -QuarantineTypes SPOMalware +$q[-1] | Release-QuarantineMessage -ReleaseToAll ``` -This example releases a file that was quarantined as part of Office 365 Advanced Threat Protection. The first command stores all SharePoint Online, OneDrive for Business and Microsoft Teams quarantined files in the variable $q. The second command releases the last file in the list. For more information about elements in arrays and index numbers, see [Accessing and Using Array Elements](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_arrays#accessing-and-using-array-elements). +This example releases a file that was quarantined as part of Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. The first command stores all quarantined files in the variable $q. The second command releases the last file in the list. For more information about elements in arrays and index numbers, see [Accessing and Using Array Elements](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_arrays#accessing-and-using-array-elements). ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md index eb2daa8584..c9df40f102 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-ActiveSyncDevice cmdlet to remove mobile device partnerships that identify the devices that are configured to synchronize with user mailboxes. -Note: In Exchange 2013 or later, use the Remove-MobileDevice cmdlet instead. If you have scripts that use Remove-ActiveSyncDevice, update them to use Remove-MobileDevice. +**Note**: In Exchange 2013 or later, use the Remove-MobileDevice cmdlet instead. If you have scripts that use Remove-ActiveSyncDevice, update them to use Remove-MobileDevice. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md index cff2475bd3..db1b77ed36 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-ActiveSyncMailboxPolicy cmdlet to remove mobile device mailbox policies. -Note: In Exchange 2013 or later, use the Remove-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Remove-ActiveSyncMailboxPolicy, update them to use Remove-MobileDeviceMailboxPolicy. +**Note**: In Exchange 2013 or later, use the Remove-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Remove-ActiveSyncMailboxPolicy, update them to use Remove-MobileDeviceMailboxPolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md index 904ebb7439..7e5295f25b 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md @@ -61,11 +61,11 @@ This example removes a custom Exchange ActiveSync virtual directory from the ser ### -Identity The Identity parameter specifies the Exchange ActiveSync virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter diff --git a/exchange/exchange-ps/exchange/Remove-AddressList.md b/exchange/exchange-ps/exchange/Remove-AddressList.md index bfffa25d77..303c1ca999 100644 --- a/exchange/exchange-ps/exchange/Remove-AddressList.md +++ b/exchange/exchange-ps/exchange/Remove-AddressList.md @@ -56,7 +56,7 @@ The Identity parameter specifies the address list that you want to remove. You c - Name - Distinguished name (DN) - GUID -- Path: (\\\) or [\\\\) +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) If the address list has child address lists that you also want to remove, you need to use the Recursive switch. diff --git a/exchange/exchange-ps/exchange/Remove-AuthRedirect.md b/exchange/exchange-ps/exchange/Remove-AuthRedirect.md index e3bedb6e7d..8dfdeaf8b0 100644 --- a/exchange/exchange-ps/exchange/Remove-AuthRedirect.md +++ b/exchange/exchange-ps/exchange/Remove-AuthRedirect.md @@ -50,7 +50,7 @@ This example removes all existing OAuth redirection objects from your organizati ## PARAMETERS ### -Identity -The Identity parameter specifies the existing OAuth redirection object that you want to remove. The object name uses the syntax AuthRedirect-Bearer-\. The easiest way to find the name of the OAuth redirection object is to run Get-AuthRedirect. +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 diff --git a/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md index 4e813e82d2..49eced377b 100644 --- a/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md @@ -45,11 +45,11 @@ This example removes the Autodiscover virtual directory from the site autodiscov ### -Identity The Identity parameter specifies the Autodiscover virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md index ccf1400ed6..8d7a508a30 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md @@ -37,14 +37,14 @@ You need to be assigned permissions in the Security & Compliance Center before y Remove-ComplianceSearchAction -Identity "Case 1234_Preview" ``` -This example the compliance search action named "Case 1234\_Preview" +This example removes the compliance search action named `Case 1234_Preview`. ## PARAMETERS ### -Identity The Identity parameter specifies the compliance search action that you want to remove. You can use any value that uniquely identifies the compliance search action. For example: -- Name: The compliance search action name uses the syntax \\_\ . For example, Case 1234\_Preview. +- Name: The compliance search action name uses the syntax `"Compliance Search Name_Action"` . For example, `"Case 1234_Preview"`. - JobRunId (GUID) ```yaml diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md index 50c75d44d5..626fa3c802 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md @@ -49,7 +49,7 @@ This example removes the mobile device conditional access rule named Secure Emai ## PARAMETERS ### -Identity -The Identity parameter specifies the mobile device conditional access rule that you want to view. The name of the rule uses the syntax \{\}. For example, Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}. You can find the name value by running the command: Get-DeviceConditionalAccessRule | Format-List Name. +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 diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md index f9b52b5af8..257f3b6fea 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md @@ -49,7 +49,7 @@ This example removes the mobile device configuration rule named Legal Team{58b50 ## PARAMETERS ### -Identity -The Identity parameter specifies the mobile device configuration rule that you want to view. The name of the rule uses the syntax \{\}. For example, Legal Team{58b50d1c-2b18-461c-8893-3e20c648b136}. You can find the name values by running the command: Get-DeviceConfigurationRule | Format-List Name. +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 diff --git a/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md index 8fbb3e1bce..9d5a84ecc6 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md @@ -46,7 +46,6 @@ Get-DlpKeywordDictionary | Foreach-Object { Remove-DlpKeywordDictionary -Identit This example removes all the DLP keyword dictionaries with a Confirm on each removal. - ## PARAMETERS ### -Identity diff --git a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md index 8e7f4f620f..8bc37a89f1 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md @@ -36,7 +36,8 @@ You need to be assigned permissions in the Security & Compliance Center before y ### Example 1 ```powershell -$Rule = Get-DlpSensitiveInformationTypeRulePackage -Identity "Contoso Rule Pack"; $Rule | Remove-DlpSensitiveInformationTypeRulePackage +$Rule = Get-DlpSensitiveInformationTypeRulePackage -Identity "Contoso Rule Pack" +$Rule | Remove-DlpSensitiveInformationTypeRulePackage ``` This example removes the third-party sensitive information type rule package named Contoso Rule Pack. The first command stores the identity of the rule package in a variable. The second command pipes the variable to the Remove-DlpSensitiveInformationTypeRulePackage cmdlet. diff --git a/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md index 90c83accd0..fb9604e853 100644 --- a/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md @@ -47,11 +47,11 @@ This example removes the ECP virtual directory named ecp located on the default ### -Identity The Identity parameter specifies the ECP virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. Remote removal of an ECP virtual directory isn't supported. You need run this command from the local computer. diff --git a/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md index 3708b5d9df..f058034b55 100644 --- a/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md @@ -87,8 +87,8 @@ Accept wildcard characters: False ### -Identity The Identity parameter specifies the certificate that you want to remove. Valid values are: -- \\\\ -- \ +- `ServerNameOrFQDN\Thumbprint` +- `Thumbprint` You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. diff --git a/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md index 27d06cfb09..aa207e5cb8 100644 --- a/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-HoldCompliancePolicy.md @@ -16,7 +16,7 @@ This cmdlet is available only in Security & Compliance Center PowerShell. For mo Use the Remove-HoldCompliancePolicy cmdlet to remove preservation policies from the Security & Compliance Center. -Note: The Remove-HoldCompliancePolicy cmdlet has been replaced by the Remove-RetentionCompliancePolicy cmdlet. If you have scripts that use Remove-HoldCompliancePolicy, update them to use Remove-RetentionCompliancePolicy. +**Note**: The Remove-HoldCompliancePolicy cmdlet has been replaced by the Remove-RetentionCompliancePolicy cmdlet. If you have scripts that use Remove-HoldCompliancePolicy, update them to use Remove-RetentionCompliancePolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md index 8569134093..f8ca3f8bf7 100644 --- a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md @@ -16,7 +16,7 @@ This cmdlet is available only in Security & Compliance Center PowerShell. For mo Use the Remove-HoldComplianceRule cmdlet to remove preservation rules from the Security & Compliance Center. -Note: The Remove-HoldComplianceRule cmdlet has been replaced by the Remove-RetentionComplianceRule cmdlet. If you have scripts that use Remove-HoldComplianceRule, update them to use Remove-RetentionComplianceRule. +**Note**: The Remove-HoldComplianceRule cmdlet has been replaced by the Remove-RetentionComplianceRule cmdlet. If you have scripts that use Remove-HoldComplianceRule, update them to use Remove-RetentionComplianceRule. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Remove-InboxRule.md b/exchange/exchange-ps/exchange/Remove-InboxRule.md index c8e73c03fc..8cba270494 100644 --- a/exchange/exchange-ps/exchange/Remove-InboxRule.md +++ b/exchange/exchange-ps/exchange/Remove-InboxRule.md @@ -59,8 +59,8 @@ The Identity parameter specifies the Inbox rule that you want to remove. You can - Name - RuleIdentity property (for example, 16752869479666417665). -- Exchange Online: `\` (for example, `rzaher\16752869479666417665`. -- On-premises Exchange: `\` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). +- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). +- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). ```yaml Type: InboxRuleIdParameter diff --git a/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md b/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md index 7abfb3c1e8..3dfc7c2f6a 100644 --- a/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md @@ -31,7 +31,7 @@ Remove-IntraOrganizationConnector [-Identity] -Enabled $false. +The Remove-IntraOrganizationConnector cmdlet removes the connector objects. To stop feature or service connectivity without removing the connector object, run the command: `Set-IntraOrganizationConnector -Enabled $false`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Remove-Mailbox.md b/exchange/exchange-ps/exchange/Remove-Mailbox.md index 02b290d43d..96f631a4b2 100644 --- a/exchange/exchange-ps/exchange/Remove-Mailbox.md +++ b/exchange/exchange-ps/exchange/Remove-Mailbox.md @@ -99,7 +99,8 @@ This example removes the mailbox and the user account for the user named John Ro ### Example 3 ```powershell -$Temp = Get-Mailbox | Where {$_.DisplayName -eq 'John Rodman'}; Remove-Mailbox -Database Server01\Database01 -StoreMailboxIdentity $Temp.MailboxGuid +$Temp = Get-Mailbox | Where {$_.DisplayName -eq 'John Rodman'} +Remove-Mailbox -Database Server01\Database01 -StoreMailboxIdentity $Temp.MailboxGuid ``` This example removes John Rodman's mailbox from the mailbox database after the mailbox has been disconnected from the user account. The example uses the Get-Mailbox cmdlet to retrieve the mailbox GUID value of the disconnected mailbox, which is required by the StoreMailboxIdentity parameter. @@ -392,7 +393,7 @@ This parameter is available only in the cloud-based service. The PermanentlyDelete switch specifies whether to immediately and permanently delete (purge) the mailbox, which prevents you from recovering or restoring the mailbox. You don't need to specify a value with this switch. -Notes: +**Notes**: - This switch works only on mailboxes that have already been deleted, but are still recoverable (known as soft-deleted mailboxes). Use the Get-Mailbox cmdlet to identify the soft-deleted mailbox, and then pipe the results to the Remove-Mailbox cmdlet as shown in Example 3 in this topic. - This switch doesn't work on soft-deleted mailboxes that are on In-Place Hold or Litigation Hold (known as inactive mailboxes). diff --git a/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md index 61690990ff..239f7a8a0e 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md @@ -76,7 +76,7 @@ This example cancels the export request by using the RequestGuid parameter for a ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the export request. By default, export requests are named \\\MailboxExportX (where X = 0-9). Use the following syntax: \\\\. +The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). Use the following syntax: `Alias\Name`. You can't use this parameter with the RequestGuid parameter. diff --git a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md index 986ddd39b8..398a5b11e5 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md @@ -22,6 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Remove-MailboxFolderPermission [-Identity] -User + [-ResetDelegateUserCollection] [-Confirm] [-DomainController ] [-WhatIf] @@ -42,10 +43,17 @@ Remove-MailboxFolderPermission -Identity kim@contoso.com:\Training -User john@co This example removes John's permissions to the Training folder in Kim's mailbox. +### Example 2 +```powershell +Remove-MailboxFolderPermission -Identity kim@contoso.com:\Calendar -ResetDelegateUserCollection +``` + +This example will clear any corrupted delegate information from Kim's mailbox. + ## PARAMETERS ### -Identity -The Identity parameter specifies the target mailbox and folder. The syntax is \:\\\. For the value of \, you can use any value that uniquely identifies the mailbox. For example: +The Identity parameter specifies the target mailbox and folder. The syntax is `Mailbox:\Folder`. For the value of Mailbox, you can use any value that uniquely identifies the mailbox. For example: - Name - Alias @@ -58,7 +66,7 @@ The Identity parameter specifies the target mailbox and folder. The syntax is \< - SamAccountName - User ID or user principal name (UPN) -Example values for the Identity parameter are john@contoso.com:\\Calendar or John:\\Marketing\\Reports. +Example values for the Identity parameter are `john@contoso.com:\Calendar` or `John:\Marketing\Reports`. ```yaml Type: MailboxFolderIdParameter @@ -149,6 +157,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResetDelegateUserCollection +This parameter is available only in the cloud-based service. + +The ResetDelegateUserCollection switch can only be used together with -Identity parameter, and the value of Identity should be the user's primary calendar folder, for example, kim@consoto.com:\Calendar. If you run into a problem when trying to add, change, or remove delegate permissions, it is possible that the delegate information stored in the LocalFreeBusy item or the PR_FREEBUSY_ENTRYIDS has become corrupted. Including this switch will delete those files and will downgrade any existing Delegates to Editor status. You will need to grant Delegate permissions again using -SharingPermissionFlag Delegate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SendNotificationToUser This parameter is available only in the cloud-based service. diff --git a/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md index 6aa52f0ace..25641f9d5d 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md @@ -78,7 +78,7 @@ This example removes all completed import requests. ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the import request. By default, import requests are named \\\MailboxImportX (where X = 0-9). If you created the request using the Name parameter, use the following syntax: \\\\. +The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you created the request using the Name parameter, use the following syntax: `Alias\Name`. You can't use this parameter with the RequestGuid parameter. diff --git a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md b/exchange/exchange-ps/exchange/Remove-MailboxPermission.md index f96b08942f..de429bbf2a 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxPermission.md @@ -228,7 +228,7 @@ This parameter is available only in the cloud-based service. The ClearAutoMapping switch specifies that the mailbox is automatically mapped (auto-mapped) by Autodiscover only into the mailbox owner's Outlook profile. The mailbox isn't auto-mapped to other users who have FullAccess permission to the mailbox. -To re-add auto-mapping capability on the mailbox for other users, run the command: Add-MailboxPermission -Identity \ -AccessRights FullAccess -AutoMapping $true. +To re-add auto-mapping capability on the mailbox for other users, run the command: `Add-MailboxPermission -Identity -AccessRights FullAccess -AutoMapping $true`. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md index facbc2cb12..31fdeec2b4 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md @@ -29,7 +29,7 @@ Remove-MailboxRepairRequest [-Identity] ``` ## DESCRIPTION -You can run the Remove-MailboxRepairRequest cmdlet to remove all mailbox repair requests for a specific database, for a group of related mailbox repair requests, or for a specific mailbox repair request. Mailbox repair requests are identified by a complex GUID with the following format: \\\\\\\. The DatabaseGuid identifies the mailbox database where the mailbox being repaired is located. The RequestGuid identifies related requests that may contain more than one job if the request runs more than one task or targets more than one mailbox. The JobGuid identifies a unique job. See the examples to remove all requests on a mailbox database, remove a group of related requests that share the same RequestGuid, or remove a specific request by specifying the complete \\\\\\\ value. +You can run the Remove-MailboxRepairRequest cmdlet to remove all mailbox repair requests for a specific database, for a group of related mailbox repair requests, or for a specific mailbox repair request. Mailbox repair requests are identified by a complex GUID with the following format: `DatabaseGuid\RequestGuid\JobGuid`. The DatabaseGuid identifies the mailbox database where the mailbox being repaired is located. The RequestGuid identifies related requests that may contain more than one job if the request runs more than one task or targets more than one mailbox. The JobGuid identifies a unique job. See the examples to remove all requests on a mailbox database, remove a group of related requests that share the same RequestGuid, or remove a specific request by specifying the complete `DatabaseGuid\RequestGuid\JobGuid` value. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -44,22 +44,24 @@ This example removes all mailbox repair requests for the mailbox database EXCH-M ### Example 2 ```powershell -Get-MailboxDatabase -Identity "EXCH-MBX-02" | Get-MailboxRepairRequest | Format-List Identity; Remove-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\335c2b06-321d-4e73-b2f7-3dc2b02d0df5 +Get-MailboxDatabase -Identity "EXCH-MBX-02" | Get-MailboxRepairRequest | Format-List Identity +Remove-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\335c2b06-321d-4e73-b2f7-3dc2b02d0df5 ``` -This example removes all related mailbox repair requests that have the same \\\\. The example uses the Get-MailboxRepairRequest cmdlet to display the value of the Identity parameter for all mailbox repair request for EXCH-MBX-02 mailbox database. +This example removes all related mailbox repair requests that have the same DatabaseGuid\\RequestGuid. The example uses the Get-MailboxRepairRequest cmdlet to display the value of the Identity parameter for all mailbox repair request for EXCH-MBX-02 mailbox database. ### Example 3 ```powershell -Get-MailboxDatabase -Identity "EXCH-MBX-02" | Get-MailboxRepairRequest | Format-List Identity; Remove-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\189c7852-49bd-4737-a53e-6e6caa5a183c\1d8ca58a-186f-4dc6-b481-f835b548a929 +Get-MailboxDatabase -Identity "EXCH-MBX-02" | Get-MailboxRepairRequest | Format-List Identity +Remove-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\189c7852-49bd-4737-a53e-6e6caa5a183c\1d8ca58a-186f-4dc6-b481-f835b548a929 ``` -This example deletes a specific mailbox repair request by specifying the unique \\\\\\\ identity value. The example also uses the Get-MailboxRepairRequest cmdlet to display the identities of all mailbox repair request for the EXCH-MBX-02 mailbox database. +This example deletes a specific mailbox repair request by specifying the unique `DatabaseGuid\RequestGuid\JobGuid` identity value. The example also uses the Get-MailboxRepairRequest cmdlet to display the identities of all mailbox repair request for the EXCH-MBX-02 mailbox database. ## PARAMETERS ### -Identity -The Identity parameter specifies the mailbox repair request to remove. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is \\\\\\\. Use the Get-MailboxRepairRequest cmdlet to find the identity of a mailbox repair request. +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 diff --git a/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md index 9abe735376..bba449360a 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md @@ -72,7 +72,7 @@ This example cancels the restore request by using the RequestGuid parameter for ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: \\\\. +The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated a default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). diff --git a/exchange/exchange-ps/exchange/Remove-MailboxSearch.md b/exchange/exchange-ps/exchange/Remove-MailboxSearch.md index 8a7e188ea9..5102448bef 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxSearch.md @@ -16,6 +16,8 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MailboxSearch cmdlet to remove a mailbox search. +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). + For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +31,7 @@ Remove-MailboxSearch [-Identity] ``` ## DESCRIPTION -In on-premises Exchange and Exchange Online, mailbox searches are used for In-Place eDiscovery and In-Place Hold. You can't remove an In-Place Hold without first disabling the hold. +In on-premises Exchange, mailbox searches are used for In-Place eDiscovery and In-Place Hold. You can't remove an In-Place Hold without first disabling the hold. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md b/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md index 4973b554f4..c49a712f89 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md @@ -43,10 +43,10 @@ This example removes the specified user configuration item from the mailbox juli ## PARAMETERS ### -Identity -The Identity parameter specifies the user configuration item that you want to remove. This parameter uses the syntax \\\\: +The Identity parameter specifies the user configuration item that you want to remove. This parameter uses the syntax MailboxFolder\ItemName: -- Valid values for \ are folder names (for example, Inbox or Calendar), the value Configuration, or the value Root. Wildcards (\*) aren't supported. -- Valid values for \ start with IPM.Configuration (for example, IPM.Configuration.Aggregated.OwaUserConfiguration. Wildcards (\*) are supported. +- Valid values for MailboxFolder are folder names (for example, Inbox or Calendar), the value Configuration, or the value Root. Wildcards (\*) aren't supported. +- Valid values for ItemName start with IPM.Configuration (for example, IPM.Configuration.Aggregated.OwaUserConfiguration. Wildcards (\*) are supported. ```yaml Type: MailboxUserConfigurationIdParameter diff --git a/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md index 6738bca623..bf84e1d85b 100644 --- a/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md @@ -45,11 +45,11 @@ This example removes the MAPI virtual directory from the local server named Cont ### -Identity The Identity parameter specifies the MAPI virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter diff --git a/exchange/exchange-ps/exchange/Remove-MessageClassification.md b/exchange/exchange-ps/exchange/Remove-MessageClassification.md index c8dea3014a..0572219455 100644 --- a/exchange/exchange-ps/exchange/Remove-MessageClassification.md +++ b/exchange/exchange-ps/exchange/Remove-MessageClassification.md @@ -46,7 +46,7 @@ This example removes the message classification named "My Message Classification The Identity parameter specifies the message classification that you want to remove. You can use any value that uniquely identifies the message classification. For example: - Name -- Identity: Default\\ or \\\; for example, "Default\My Message Classification" or "es-ES\My Message Classification". +- Identity: `Default\` or `\` (for example, `"Default\My Message Classification"` or `"es-ES\My Message Classification"`). - ClassificationID (GUID) ```yaml diff --git a/exchange/exchange-ps/exchange/Remove-MigrationBatch.md b/exchange/exchange-ps/exchange/Remove-MigrationBatch.md index a661d4426a..810df27037 100644 --- a/exchange/exchange-ps/exchange/Remove-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Remove-MigrationBatch.md @@ -33,7 +33,7 @@ Remove-MigrationBatch [[-Identity] ] ## DESCRIPTION The Remove-MigrationBatch cmdlet removes a migration batch. All subscriptions are deleted and any object related to the migration batch is also deleted. -If you use the Force parameter with this cmdlet, the individual user requests and subscriptions that were part of the removed migration batch aren't removed. You have to remove the individual migration user requests with the Remove-MigrationUser \ -Force command. +If you use the Force parameter with this cmdlet, the individual user requests and subscriptions that were part of the removed migration batch aren't removed. You need to remove the individual migration user requests with the command: `Remove-MigrationUser -Force`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -113,7 +113,7 @@ This parameter is available only in on-premises Exchange. The Force switch specifies whether to remove a corrupted migration batch. Corrupted migration batches have a status of Corrupted. If you try to remove a corrupted migration batch without using this switch, you receive an error saying the migrated batch can't be found. -If you use this parameter to remove a corrupted migration batch, the individual user requests (also called job items) and subscriptions that were part of the removed migration batch aren't removed. You have to remove the individual migration user requests with the Remove-MigrationUser \ -Force command. +If you use this parameter to remove a corrupted migration batch, the individual user requests (also called job items) and subscriptions that were part of the removed migration batch aren't removed. You need to remove the individual migration user requests with the command: `Remove-MigrationUser -Force`. ```yaml Type: SwitchParameter diff --git a/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md index cdf2e70758..1f0f5c7223 100644 --- a/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md @@ -55,11 +55,11 @@ This example removes the default OAB virtual directory from Server1. ### -Identity The Identity parameter specifies the OAB virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter diff --git a/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md index d8cba0a4ee..6c109a7a76 100644 --- a/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md @@ -52,11 +52,11 @@ This example removes the specified Outlook on the web virtual directory from the ### -Identity The Identity parameter specifies the OWA virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter diff --git a/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md index b08ac38e8d..28e08c58b0 100644 --- a/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md +++ b/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md @@ -52,7 +52,7 @@ This example removes all the custom Russian Policy Tips. ### -Identity The Identity parameter specifies the custom Policy Tip you want to remove. You can use any value that uniquely identifies the custom Policy Tip. For example: -- \\\\: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - The value Url - GUID - Distinguished name (DN) diff --git a/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md index 9a889cb8cd..489a7a3462 100644 --- a/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md @@ -49,11 +49,11 @@ Be careful when using the Remove-PowerShellVirtualDirectory cmdlet without confi ### -Identity The Identity parameter specifies the PowerShell virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolder.md b/exchange/exchange-ps/exchange/Remove-PublicFolder.md index 1fc2f4d4a3..508fd39cf8 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolder.md +++ b/exchange/exchange-ps/exchange/Remove-PublicFolder.md @@ -54,7 +54,7 @@ This example deletes the public folder Directory Folder and all its child public ## PARAMETERS ### -Identity -The Identity parameter specifies the name and path of the public folder you want to remove. A valid value uses the syntax: \\\\\\\\...\\\\\\. For example, "\\Customer Discussion" or "\\Engineering\\Customer Discussion". +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 diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md index 0e7cf6f16d..1fe2953100 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md @@ -70,7 +70,7 @@ The sample script [Remove Duplicate public folder MRS Requests](https://gallery. ## PARAMETERS ### -Identity -The Identity parameter specifies the public folder mailbox migration request that you want to remove. This value uses the syntax \\PublicFolderMailboxMigration\ (for example, \\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e). +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. diff --git a/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md b/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md index e7a34416e9..9446e56ba4 100644 --- a/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md @@ -50,7 +50,7 @@ The Identity parameter specifies the Receive connector that you want to remove. - Name - Distinguished name (DN) - GUID -- \\\\ +- ServerName\\Name ```yaml Type: ReceiveConnectorIdParameter diff --git a/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md index 0eb6ce9838..08f12db972 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md @@ -43,7 +43,10 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Get-Mailbox | Where {$_.RoleAssignmentPolicy -Eq "End User"}; Get-Mailbox | Where {$_.RoleAssignmentPolicy -Eq "End User"} | Set-Mailbox -RoleAssignmentPolicy "Seattle End User"; Get-ManagementRoleAssignment -RoleAssignee "End User" | Remove-ManagementRoleAssignment; Remove-RoleAssignmentPolicy "End User" +Get-Mailbox | Where {$_.RoleAssignmentPolicy -Eq "End User"} +Get-Mailbox | Where {$_.RoleAssignmentPolicy -Eq "End User"} | Set-Mailbox -RoleAssignmentPolicy "Seattle End User" +Get-ManagementRoleAssignment -RoleAssignee "End User" | Remove-ManagementRoleAssignment +Remove-RoleAssignmentPolicy "End User" ``` This example removes the role assignment policy named End User. diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md index c6ac5385f6..2797c7974d 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md @@ -31,7 +31,7 @@ Remove-SafeAttachmentPolicy [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Office 365 ATP](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md index 757d090d4f..910272d44a 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md @@ -30,7 +30,7 @@ Remove-SafeAttachmentRule [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Office 365 ATP](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md index e2ba998cab..acfdf5f4c4 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md @@ -33,7 +33,7 @@ Remove-SafeLinksPolicy [-Identity] ## DESCRIPTION You can't remove the default Safe Links policy (the policy where the IsDefault property is True). -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md b/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md index 1f7efabb42..f0279ccb88 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md @@ -30,7 +30,7 @@ Remove-SafeLinksRule [-Identity] ``` ## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Remove-SweepRule.md b/exchange/exchange-ps/exchange/Remove-SweepRule.md index 1da5cbb259..6d91163176 100644 --- a/exchange/exchange-ps/exchange/Remove-SweepRule.md +++ b/exchange/exchange-ps/exchange/Remove-SweepRule.md @@ -54,8 +54,8 @@ This example removes all Sweep rules in the specified mailbox. The Identity parameter specifies the Sweep rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). -- Exchange Online: \\\\ (for example, rzaher\\x2hlsdpGmUifjFgxxGIOJw==. -- On-premises Exchange: \\\\ (for example, contoso.com/Users/Rick Zaher\\x2hlsdpGmUifjFgxxGIOJw==. +- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). +- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). ```yaml Type: SweepRuleIdParameter diff --git a/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md b/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md index eced280c71..eb61e23c89 100644 --- a/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md +++ b/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md @@ -50,7 +50,7 @@ The Identity parameter specifies the mail-enabled public folder object that you - Name - Distinguished name (DN) - GUID -- Path: (\\\\\\ +- Path (`\\`) ```yaml Type: MailPublicFolderIdParameter diff --git a/exchange/exchange-ps/exchange/Remove-SystemMessage.md b/exchange/exchange-ps/exchange/Remove-SystemMessage.md index 792d4fe5ea..c3ff6cbacd 100644 --- a/exchange/exchange-ps/exchange/Remove-SystemMessage.md +++ b/exchange/exchange-ps/exchange/Remove-SystemMessage.md @@ -60,14 +60,14 @@ TheIdentity parameter specifies the custom system message that you want to remov The identity value of a system message uses one of these formats: -- System messages for enhanced status codes: \\\\\\\. For example, En\\Internal\\5.1.2 or Ja\\External\\5.1.2. -- System messages for quotas: \\\\. For example, En\\ProhibitSendReceiveMailBox. +- System messages for enhanced status codes: `Language\\DSNCode`. For example, `En\Internal\5.1.2` or `Ja\External\5.1.2`. +- System messages for quotas: `Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailBox`. -\: For the list of supported language codes, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). +Language: For the list of supported language codes, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). -\: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system code values that are currently used by custom system messages, run the command Get-SystemMessage. +DSNCode: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system code values that are currently used by custom system messages, run the command Get-SystemMessage. -\: Valid value are: +QuotaMessageType: Valid value are: Mailbox size quotas: diff --git a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md index 640ba4d9d5..67e7294992 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md @@ -7,7 +7,7 @@ schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: -ROBOTS: NOINDEX, NOFOLLOW +ROBOTS: NOINDEX --- # Remove-TenantAllowBlockListItems diff --git a/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md index 2eeaead857..ce65bd1d76 100644 --- a/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-ThrottlingPolicy.md @@ -47,7 +47,11 @@ This example removes the user throttling policy ClientThrottlingPolicy2. ### Example 2 ```powershell -$policy = Get-ThrottlingPolicy ClientThrottlingPolicy2; $mailboxes = Get-Mailbox | where-object {$_.ThrottlingPolicy -eq $policy.Identity}; $defaultPolicy = Get-ThrottlingPolicy | where-object {$_.IsDefault -eq $true}; foreach ($mailbox in $mailboxes) {Set-Mailbox -Identity $mailbox.Identity -ThrottlingPolicy $defaultPolicy}; Remove-ThrottlingPolicy ClientThrottlingPolicy2 +$policy = Get-ThrottlingPolicy ClientThrottlingPolicy2 +$mailboxes = Get-Mailbox | where-object {$_.ThrottlingPolicy -eq $policy.Identity} +$defaultPolicy = Get-ThrottlingPolicy | where-object {$_.IsDefault -eq $true} +foreach ($mailbox in $mailboxes) {Set-Mailbox -Identity $mailbox.Identity -ThrottlingPolicy $defaultPolicy} +Remove-ThrottlingPolicy ClientThrottlingPolicy2 ``` You can't remove a policy that's associated with any users. This example reassigns the users subject to ClientThrottlingPolicy2 to the default policy. Then, it removes ClientThrottlingPolicy2. diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md index 54253f3638..5d65b888ae 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md @@ -80,7 +80,7 @@ You can use any value that uniquely identifies the recipient. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -98,11 +98,10 @@ Accept wildcard characters: False ### -LinkType The LinkType parameter specifies the Microsoft 365 Group property that you want to modify. Valid values are: +- Aggregators - Members - Owners - Subscribers -- Aggregators -- EventSubscribers ```yaml Type: LinkType diff --git a/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md index d49506e3d5..be2a8b645b 100644 --- a/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md @@ -48,11 +48,11 @@ This example removes the Exchange Web Services virtual directory named Sales fro ### -Identity The Identity parameter specifies the EWS virtual directory that you want to remove. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter diff --git a/exchange/exchange-ps/exchange/Restore-Mailbox.md b/exchange/exchange-ps/exchange/Restore-Mailbox.md index 16cf7f10f3..130b72427a 100644 --- a/exchange/exchange-ps/exchange/Restore-Mailbox.md +++ b/exchange/exchange-ps/exchange/Restore-Mailbox.md @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Restore-Mailbox cmdlet to extract mailbox content from a restored database. -Note: In Exchange Server 2010 Service Pack 1 (SP1) or later, use the New-MailboxRestoreRequest cmdlet instead of the Restore-Mailbox cmdlet to extract mailbox content from a restored database. +**Note**: In Exchange Server 2010 Service Pack 1 (SP1) or later, use the New-MailboxRestoreRequest cmdlet instead of the Restore-Mailbox cmdlet to extract mailbox content from a restored database. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md index 887b61544a..e2cd6d5525 100644 --- a/exchange/exchange-ps/exchange/Restore-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Restore-RecoverableItems.md @@ -74,7 +74,8 @@ After using the Get-RecoverableItems cmdlet to verify the existence of the item, ### Example 2 ```powershell -$mailboxes = Import-CSV "C:\My Documents\RestoreMessage.csv"; $mailboxes | foreach {Restore-RecoverableItems -Identity $_.SMTPAddress -SubjectContains Project X" -SourceFolder DeletedItems -FilterItemType IPM.Note} +$mailboxes = Import-CSV "C:\My Documents\RestoreMessage.csv" +$mailboxes | foreach {Restore-RecoverableItems -Identity $_.SMTPAddress -SubjectContains Project X" -SourceFolder DeletedItems -FilterItemType IPM.Note} ``` In Exchange Server, this example restores the deleted email message "Project X" for the mailboxes that are specified in the comma-separated value (CSV) file C:\\My Documents\\RestoreMessage.csv. The CSV file uses the header value SMTPAddress, and contains the email address of each mailbox on a separate line like this: @@ -128,7 +129,7 @@ The Identity parameter specifies the mailbox that contains the deleted items tha - SamAccountName - User ID or user principal name (UPN) -In Exchange Online, you can specify multiple mailboxes separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +In Exchange Online, you can specify multiple mailboxes separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: GeneralMailboxOrMailUserIdParameter @@ -307,16 +308,16 @@ The SourceFolder parameter specifies where to search for deleted items in the ma - DeletedItems: The Deleted Items folder. - RecoverableItems: The Recoverable Items\Deletions folder. This folder contains items that have been deleted from the Deleted Items folder (soft-deleted items). -- PurgedItems: (Cloud only) The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). +- PurgedItems: The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). If you don't use this parameter, the command will search all of these folders. ```yaml Type: RecoverableItemsFolderType -Parameter Sets: OnPremises +Parameter Sets: (All) Aliases: -Accepted values: DeletedItems | RecoverableItems -Applicable: Exchange Server 2016, Exchange Server 2019 +Accepted values: DeletedItems | RecoverableItems | PurgedItems +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named diff --git a/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md index aa12162e11..cb5c80ddae 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md @@ -54,7 +54,7 @@ This example resumes any failed export move requests. ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the export request. By default, export requests are named \\\MailboxExportX (where X = 0-9). Use the following syntax: \\\\. +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 diff --git a/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md index 06d53dcbdb..f50af8e560 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md @@ -56,7 +56,7 @@ This example resumes all failed import requests. ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the import request. By default, import requests are named \\\MailboxImportX (where X = 0-9). If you created the request using the Name parameter, use the following syntax: \\\\. +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 diff --git a/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md index eb027d1324..178599ee2e 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md @@ -50,7 +50,7 @@ This example resumes any restore request with the status of Failed. ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: \\\\. +The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name`. If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). diff --git a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md b/exchange/exchange-ps/exchange/Search-AdminAuditLog.md index ccf7e922c8..0defd7948b 100644 --- a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-AdminAuditLog.md @@ -39,7 +39,7 @@ Search-AdminAuditLog ## DESCRIPTION If you run the Search-AdminAuditLog cmdlet without any parameters, up to 1,000 log entries are returned by default. -Note: In Exchange Online PowerShell, if you don't use the StartDate or EndDate parameters, only results from the last 14 days are returned. +**Note**: In Exchange Online PowerShell, if you don't use the StartDate or EndDate parameters, only results from the last 14 days are returned. For more information about the structure and properties of the audit log, [Administrator audit log structure](https://docs.microsoft.com/Exchange/policy-and-compliance/admin-audit-logging/log-structure). @@ -70,7 +70,8 @@ The command completed successfully ### Example 3 ```powershell -$LogEntries = Search-AdminAuditLog -Cmdlets Write-AdminAuditLog; $LogEntries | ForEach { $_.CmdletParameters } +$LogEntries = Search-AdminAuditLog -Cmdlets Write-AdminAuditLog +$LogEntries | ForEach { $_.CmdletParameters } ``` This example displays all the comments written to the administrator audit log by the Write-AdminAuditLog cmdlet. @@ -196,7 +197,7 @@ The ObjectIds parameter filters the results by the object that was modified (the You'll likely need to use other filtering parameters on this cmdlet to narrow down the results and identify the types of objects that you're interested in. In the results of this cmdlet, this property is named **ObjectModified**. -To enter multiple values, use the following syntax: Value1,Value2,...ValueN. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "Value 1","Value 2",..."Value N". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -293,7 +294,7 @@ The UserIds parameter filters the results by the user who made the change (who r 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)). -To enter multiple values, use the following syntax: User1,User2,...UserN. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "User 1","User 2",..."User N". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"User1","User2",..."UserN"`. In the results of this cmdlet, this property is named **Caller** diff --git a/exchange/exchange-ps/exchange/Search-Mailbox.md b/exchange/exchange-ps/exchange/Search-Mailbox.md index ca63774725..63cc2a1272 100644 --- a/exchange/exchange-ps/exchange/Search-Mailbox.md +++ b/exchange/exchange-ps/exchange/Search-Mailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml online version: https://docs.microsoft.com/powershell/module/exchange/search-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Search-Mailbox schema: 2.0.0 author: chrisda diff --git a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md index 5645c0a483..7825e24d6b 100644 --- a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md @@ -248,7 +248,7 @@ Accept wildcard characters: False ### -Mailboxes The Mailboxes parameter specifies the mailboxes to retrieve mailbox audit log entries from. You can use this parameter to search audit logs for multiple mailboxes. -You enter multiple mailboxes separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You enter multiple mailboxes separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can't use this parameter with the ShowDetails switch. diff --git a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md index db72be3b2a..03105b2409 100644 --- a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md @@ -47,6 +47,10 @@ If you want to programmatically download data from the Microsoft 365 audit log, This cmdlet is available in Office 365 operated by 21Vianet, but it won't return any results. +The OutVariable parameter accepts objects of type ArrayList. Here's an example of how to use it: + +`$start = (Get-Date).AddDays(-1); $end = (Get-Date).AddDays(-0.5); $auditData = New-Object System.Collections.ArrayList; Search-UnifiedAuditLog -StartDate $start -EndDate $end -OutVariable +auditData | Out-Null` + You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +62,7 @@ Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/2/2018 This example searches the unified audit log for all events from May 1, 201812:00AM to May 2, 2018 12:00AM. -Note: If you don't include a timestamp in the value for the StartDate or EndDate parameters, the default timestamp 12:00 AM (midnight) is used. +**Note**: If you don't include a timestamp in the value for the StartDate or EndDate parameters, the default timestamp 12:00 AM (midnight) is used. ### Example 2 ```powershell @@ -67,23 +71,20 @@ Search-UnifiedAuditLog -StartDate "6/1/2018 8:00 AM" -EndDate "6/1/2018 6:00 PM" This example searches the unified audit log for all Exchange admin events from 8:00 AM to 6:00 PM on June 1, 2018. ->[!NOTE] -> If you use the same date for the StartDate and EndDate parameters, you have to include a timestamp; otherwise, no results will be returned because the date and time for the start and end dates will be the same. +**Note** If you use the same date for the StartDate and EndDate parameters, you need to include a timestamp; otherwise, no results will be returned because the date and time for the start and end dates will be the same. ### Example 3 ```powershell -Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -SessionId "UnifiedAuditLogSearch 05/08/17" -SessionCommand ReturnNextPreviewPage +Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -SessionId "UnifiedAuditLogSearch 05/08/17" -SessionCommand ReturnLargeSet ``` This example searches the unified audit log for all events from May 1, 2018 to May 8, 2018. If you don't include a time stamp in the StartDate or EndDate parameters, The data is returned in pages as the command is rerun sequentially while using the same SessionId value. -> - [!NOTE] -> If you use the SessionCommand value ReturnLargeSet, and then you use the value ReturnNextPreviewPage for the same session ID, the results are limited to 10,000 records (not 50,000). +**Note**: Always use the same SessionCommand value for a given SessionId value. Don't switch between ReturnLargeSet and ReturnNextPreviewPage for the same session ID. Otherwise, the output is limited to 10,000 results. ### Example 4 ```powershell -Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -RecordType SharePointFileOperation -Operations FileAccessed -SessionId "WordDocs_SharepointViews"-SessionCommand ReturnNextPreviewPage +Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -RecordType SharePointFileOperation -Operations FileAccessed -SessionId "WordDocs_SharepointViews"-SessionCommand ReturnLargeSet ``` This example searches the unified audit log for any files accessed in SharePoint Online from May 1, 2018 to May 8, 2018. The data is returned in pages as the command is rerun sequentially while using the same SessionId value. @@ -198,7 +199,7 @@ The ObjectIds parameter filters the log entries by object ID. The object ID is t The ObjectId value appears in the AuditData (also known as Details) property of the event. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] @@ -216,7 +217,7 @@ Accept wildcard characters: False ### -Operations The Operations parameter filters the log entries by operation. The available values for this parameter depend on the RecordType value. For a list of the available values for this parameter, see [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] @@ -266,10 +267,10 @@ Accept wildcard characters: False ### -SessionCommand The SessionCommand parameter specifies how much information is returned and how it's organized. Valid values are: +- ReturnLargeSet: This value causes the cmdlet to return unsorted data. By using paging, you can access a maximum of 50,000 results. This is the recommended value if an ordered result is not required and has been optimized for search latency. - ReturnNextPreviewPage: This value causes the cmdlet to return data sorted on date. The maximum number of records returned through use of either paging or the ResultSize parameter is 5,000 records. -- ReturnLargeSet: This value causes the cmdlet to return unsorted data. By using paging, you can access a maximum of 50,000 results. -**Note**: Always use the same SessionCommand value for a given SessionId value. Don't switch between ReturnLargeSet and ReturnNextPreviewPage for the same session ID. +**Note**: Always use the same SessionCommand value for a given SessionId value. Don't switch between ReturnLargeSet and ReturnNextPreviewPage for the same session ID. Otherwise, the output is limited to 10,000 results. ```yaml Type: UnifiedAuditSessionCommand @@ -323,7 +324,7 @@ Accept wildcard characters: False ### -UserIds The UserIds parameter filters the log entries by the ID of the user who performed the action. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] @@ -348,9 +349,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### -The OutVariable parameter accepts objects of type ArrayList. Here's an example of how to use it: - -$start = (Get-Date).AddDays(-1); $end = (Get-Date).AddDays(-0.5); $auditData = New-Object System.Collections.ArrayList; Search-UnifiedAuditLog -StartDate $start -EndDate $end -OutVariable +auditData | Out-Null ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ADServerSettings.md b/exchange/exchange-ps/exchange/Set-ADServerSettings.md index 81044de058..d3c1079b8a 100644 --- a/exchange/exchange-ps/exchange/Set-ADServerSettings.md +++ b/exchange/exchange-ps/exchange/Set-ADServerSettings.md @@ -155,7 +155,7 @@ Accept wildcard characters: False ``` ### -RecipientViewRoot -The RecipientViewRoot parameter specifies the organizational unit (OU) to include in the recipient scope for this session. When you specify a recipient scope with this parameter, only the recipients included in the scope are returned. To specify an OU, use the syntax \/\. +The RecipientViewRoot parameter specifies the organizational unit (OU) to include in the recipient scope for this session. When you specify a recipient scope with this parameter, only the recipients included in the scope are returned. To specify an OU, use the syntax `/`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md index 75c321a7f8..349162e2d1 100644 --- a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md +++ b/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-AccessToCustomerDataRequest cmdlet to approve, deny, or cancel Microsoft 365 customer lockbox requests that control access to your data by Microsoft support engineers. -Note: Customer lockbox is included in the Microsoft 365 E5 plan. If you don't have a Microsoft 365 E5 plan, you can buy a separate customer lockbox subscription with any Microsoft 365 Enterprise plan. +**Note**: Customer lockbox is included in the Microsoft 365 E5 plan. If you don't have a Microsoft 365 E5 plan, you can buy a separate customer lockbox subscription with any Microsoft 365 Enterprise plan. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md index 33ed10c620..a8d9021d34 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ActiveSyncMailboxPolicy.md @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-ActiveSyncMailboxPolicy cmdlet to apply a variety of Mobile Device mailbox policy settings to a server. You can set any of the parameters by using one command. -Note: In Exchange 2013 or later, use the Set-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Set-ActiveSyncMailboxPolicy, update them to use Set-MobileDeviceMailboxPolicy. +**Note**: In Exchange 2013 or later, use the Set-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Set-ActiveSyncMailboxPolicy, update them to use Set-MobileDeviceMailboxPolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md b/exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md index ce711ff6d7..e2a84c36f2 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md +++ b/exchange/exchange-ps/exchange/Set-ActiveSyncOrganizationSettings.md @@ -67,9 +67,9 @@ Accept wildcard characters: False ### -AdminMailRecipients The AdminMailRecipients parameter specifies the email addresses of the administrators for reporting purposes. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -101,6 +101,8 @@ Accept wildcard characters: False ``` ### -AllowRMSSupportForUnenlightenedApps +This parameter is available or functional only in the cloud-based service. + The AllowRMSSupportForUnenlightenedApps parameter specifies whether to allow Rights Management Services (RMS) protected messages for ActiveSync clients that don't support RMS. Valid values are: - $true diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md index bb646304f9..ab6a0a86ac 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-ActiveSyncVirtualDirectory.md @@ -84,11 +84,11 @@ This example configures the external URL on the default Exchange ActiveSync virt ### -Identity 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 \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter @@ -247,7 +247,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -269,9 +269,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/Set-ActivityAlert.md b/exchange/exchange-ps/exchange/Set-ActivityAlert.md index 4b54d17efc..2b48348507 100644 --- a/exchange/exchange-ps/exchange/Set-ActivityAlert.md +++ b/exchange/exchange-ps/exchange/Set-ActivityAlert.md @@ -50,12 +50,14 @@ You need to be assigned permissions in the Security & Compliance Center before y ### Example 1 ```powershell -$NU = Get-ActivityAlert "Contoso Elevation of Privilege"; $NU.NotifyUser.Add("chris@fabrikam.com"); Set-ActivityAlert "Contoso Elevation of Privilege" -NotifyUser $NU.NotifyUser +$NU = Get-ActivityAlert "Contoso Elevation of Privilege" +$NU.NotifyUser.Add("chris@fabrikam.com") +Set-ActivityAlert "Contoso Elevation of Privilege" -NotifyUser $NU.NotifyUser ``` This example adds the external user chris@fabrikam.com to the list of recipients that email notifications are sent to for the activity alert named Contoso Elevation of Privilege. -Note: To remove an existing email address from the list of recipients, change the value NotifyUser.Add to NotifyUser.Remove. +**Note**: To remove an existing email address from the list of recipients, change the value NotifyUser.Add to NotifyUser.Remove. ### Example 2 ```powershell @@ -250,7 +252,7 @@ Accept wildcard characters: False ### -NotifyUser The NotifyUser parameter specifies the email address of the recipients who will receive the notification emails. You can specify internal and external email addresses. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. To modify the existing list of recipients, see the Examples section. @@ -272,7 +274,7 @@ The Operation parameter specifies the activities that trigger activity alerts. A valid value for this parameter is an activity that's available in the Microsoft 365 audit log. For a description of these activities, see [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. For the syntax that you use to modify an existing list of Operations values, see the Examples section. @@ -389,7 +391,7 @@ The UserId parameter specifies who you want to monitor. - If you specify a user's email address, you'll receive an email notification when the user performs the specified activity. You can specify multiple email addresses separated by commas. - If this parameter is blank ($null), you'll receive an email notification when any user in your organization performs the specified activity. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can only use this parameter on activity alerts that have the Type property values Custom or ElevationOfPrivilege. diff --git a/exchange/exchange-ps/exchange/Set-AddressList.md b/exchange/exchange-ps/exchange/Set-AddressList.md index 6a1f1b9e75..7dd56dc15e 100644 --- a/exchange/exchange-ps/exchange/Set-AddressList.md +++ b/exchange/exchange-ps/exchange/Set-AddressList.md @@ -93,7 +93,7 @@ The Identity parameter specifies the address list that you want to modify. You c - Name - Distinguished name (DN) - GUID -- Path: (\\\) or [\\\\) +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) ```yaml Type: AddressListIdParameter @@ -113,9 +113,9 @@ The ConditionalCompany parameter specifies a precanned filter that's based on th When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -135,9 +135,9 @@ The ConditionalCustomAttribute1 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -157,9 +157,9 @@ The ConditionalCustomAttribute10 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -179,9 +179,9 @@ The ConditionalCustomAttribute11 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -201,9 +201,9 @@ The ConditionalCustomAttribute12 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -223,9 +223,9 @@ The ConditionalCustomAttribute13 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -245,9 +245,9 @@ The ConditionalCustomAttribute14 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -267,9 +267,9 @@ The ConditionalCustomAttribute15 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -289,9 +289,9 @@ The ConditionalCustomAttribute2 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -311,9 +311,9 @@ The ConditionalCustomAttribute3 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -333,9 +333,9 @@ The ConditionalCustomAttribute4 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -355,9 +355,9 @@ The ConditionalCustomAttribute5 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -377,9 +377,9 @@ The ConditionalCustomAttribute6 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -399,9 +399,9 @@ The ConditionalCustomAttribute7 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -421,9 +421,9 @@ The ConditionalCustomAttribute8 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -443,9 +443,9 @@ The ConditionalCustomAttribute9 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -465,9 +465,9 @@ The ConditionalDepartment parameter specifies a precanned filter that's based on When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -487,9 +487,9 @@ The ConditionalStateOrProvince parameter specifies a precanned filter that's bas When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md index 090c02fa2b..08ff1c90d8 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md @@ -27,13 +27,13 @@ Set-AntiPhishPolicy -Identity [-AdminDisplayName ] [-AuthenticationFailAction ] [-Confirm] - [-EnableAntispoofEnforcement ] [-Enabled ] [-EnableMailboxIntelligence ] [-EnableMailboxIntelligenceProtection ] [-EnableOrganizationDomainsProtection ] [-EnableSimilarDomainsSafetyTips ] [-EnableSimilarUsersSafetyTips ] + [-EnableSpoofIntelligence ] [-EnableTargetedDomainsProtection ] [-EnableTargetedUserProtection ] [-EnableUnauthenticatedSender ] @@ -73,7 +73,7 @@ This example modifies the default antiphish policy named Office365 AntiPhish Def Set-AntiPhishPolicy -Identity "Office365 AntiPhish Default" -EnableOrganizationDomainsProtection $true -EnableTargetedDomainsProtection $true -TargetedDomainsToProtect fabrikam.com -TargetedDomainProtectionAction Quarantine -EnableTargetedUserProtection $true -TargetedUsersToProtect "Mai Fujito;mfujito@fabrikam.com" -TargetedUserProtectionAction Quarantine -EnableMailboxIntelligenceProtection $true -MailboxIntelligenceProtectionAction Quarantine -EnableSimilarUsersSafetyTips $true -EnableSimilarDomainsSafetyTips $true -EnableUnusualCharactersSafetyTips $true ``` -In Advanced Threat Protection, this example modifies the default antiphish policy named Office365 AntiPhish Default with the following settings: +In Microsoft Defender for Office 365, this example modifies the default antiphish policy named Office365 AntiPhish Default with the following settings: - Enables organization domains protection for all accepted domains, and targeted domains protection for fabrikam.com. - Specifies Mai Fujito (mfujito@fabrikam.com) as a user to protect from impersonation. @@ -158,27 +158,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAntispoofEnforcement -This setting is part of spoof protection. - -The EnableAntispoofEnforcement parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: - -- $true: Antispoofing is enabled for the policy. This is the default and recommended value. You specify the spoofed senders to allow or block using the Set-PhishFilterPolicy cmdlet. -- $false: Antispoofing is disabled for the policy. We only recommend this value if you have a domain that's protected by another email filtering service. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Enabled The Enabled parameter specifies whether the antiphish policy is enabled or disabled. Valid values are: @@ -200,7 +179,7 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligence -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence (artificial intelligence that determines user email patterns with their frequent contacts). Valid values are:: @@ -221,7 +200,7 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligenceProtection -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableMailboxIntelligenceProtection specifies whether to enable or disable enhanced impersonation results based on each user's individual sender map. This intelligence allows Microsoft 365 to customize user impersonation detection and better handle false positives. Valid values are: @@ -242,7 +221,7 @@ Accept wildcard characters: False ``` ### -EnableOrganizationDomainsProtection -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Microsoft 365 organization. Valid values are: @@ -263,7 +242,7 @@ Accept wildcard characters: False ``` ### -EnableSimilarDomainsSafetyTips -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for domain impersonation detections. Valid values are: @@ -284,7 +263,7 @@ Accept wildcard characters: False ``` ### -EnableSimilarUsersSafetyTips -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for user impersonation detections. Valid values are: @@ -304,8 +283,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableSpoofIntelligence +This setting is part of spoof protection. + +The EnableSpoofIntelligence parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: + +- $true: Antispoofing is enabled for the policy. This is the default and recommended value. You specify the spoofed senders to allow or block using the Set-PhishFilterPolicy cmdlet. +- $false: Antispoofing is disabled for the policy. We only recommend this value if you have a domain that's protected by another email filtering service. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EnableTargetedDomainsProtection -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableTargetedDomainsProtection parameter specifies whether to enable domain impersonation protection for a list of specified domains. Valid values are: @@ -326,7 +326,7 @@ Accept wildcard characters: False ``` ### -EnableTargetedUserProtection -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for a list of specified users. Valid values are: @@ -351,7 +351,7 @@ This setting is part of spoof protection. The EnableUnauthenticatedSender parameter enables or disables unauthenticated sender identification in Outlook. Valid values are: -- $true: This is the default value. A question mark (?) is applied to the sender's photo if the message does not pass SPF or DKIM checks AND the message does not pass DMARC or composite authentication. The via tag (chris@contoso.com via michelle@fabrikam.com) is added if the domain in the From address (the message sender that's displayed in email clients) is different from the domain in the DKIM signature or the MAIL FROM address. +- $true: This is the default value. A question mark (?) is applied to the sender's photo if the message does not pass SPF or DKIM checks AND the message does not pass DMARC or composite authentication. The via tag (chris@contoso.com via fabrikam.com) is added if the domain in the From address (the message sender that's displayed in email clients) is different from the domain in the DKIM signature or the MAIL FROM address. - $false: A question mark is never applied to the sender's photo. The via tag is still added if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. To prevent these identifiers from being added to messages from specific senders, you have the following options: @@ -373,7 +373,7 @@ Accept wildcard characters: False ``` ### -EnableUnusualCharactersSafetyTips -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for unusual characters in domain and user impersonation detections. Valid values are: @@ -394,7 +394,7 @@ Accept wildcard characters: False ``` ### -ExcludedDomains -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. @@ -412,7 +412,7 @@ Accept wildcard characters: False ``` ### -ExcludedSenders -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. @@ -430,7 +430,7 @@ Accept wildcard characters: False ``` ### -ImpersonationProtectionState -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The ImpersonationProtectionState parameter specifies the configuration of impersonation protection. Valid values are: @@ -452,7 +452,7 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionAction -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionAction parameter specifies what to do with messages that fail mailbox intelligence protection. Valid values are: @@ -477,7 +477,7 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionActionRecipients -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionActionRecipients parameter specifies the recipients to add to detected messages when the MailboxIntelligenceProtectionAction parameter is set to the value Redirect or BccMessage. @@ -515,7 +515,7 @@ Accept wildcard characters: False ``` ### -PhishThresholdLevel -This setting is part of advanced settings and is only available in Advanced Threat Protection. +This setting is part of advanced settings and is only available in Microsoft Defender for Office 365. The PhishThresholdLevel parameter specifies the tolerance level that's used by machine learning in the handling of phishing messages. Valid values are: @@ -554,7 +554,7 @@ Accept wildcard characters: False ``` ### -TargetedDomainActionRecipients -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. @@ -574,7 +574,7 @@ Accept wildcard characters: False ``` ### -TargetedDomainProtectionAction -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: @@ -599,7 +599,7 @@ Accept wildcard characters: False ``` ### -TargetedDomainsToProtect -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedDomainsToProtect parameter specifies the domains that are included in domain impersonation protection when the EnableTargetedDomainsProtection parameter is set to $true. @@ -619,7 +619,7 @@ Accept wildcard characters: False ``` ### -TargetedUserActionRecipients -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. @@ -639,7 +639,7 @@ Accept wildcard characters: False ``` ### -TargetedUserProtectionAction -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: @@ -664,7 +664,7 @@ Accept wildcard characters: False ``` ### -TargetedUsersToProtect -This setting is part of impersonation protection and is only available in Advanced Threat Protection. +This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. The TargetedUsersToProtect parameter specifies the users that are included in user impersonation protection when the EnableTargetedUserProtection parameter is set to $true. diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md b/exchange/exchange-ps/exchange/Set-AntiPhishRule.md index 650a4eab11..debb9ac923 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishRule.md @@ -154,7 +154,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -179,7 +179,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception that looks for messa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -260,7 +260,7 @@ The SentTo parameter specifies a condition that looks for recipients in messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -285,7 +285,7 @@ The SentToMemberOf parameter specifies a condition that looks for messages sent - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. diff --git a/exchange/exchange-ps/exchange/Set-App.md b/exchange/exchange-ps/exchange/Set-App.md index 1b9b6648ef..a1bf8d61ee 100644 --- a/exchange/exchange-ps/exchange/Set-App.md +++ b/exchange/exchange-ps/exchange/Set-App.md @@ -47,7 +47,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$a= Get-DistributionGroupMember -Identity "Finance Team"; Set-App -OrganizationApp -Identity 3f10017a-9bbe-4a23-834b-6a8fe3af0e37 -ProvidedTo SpecificUsers -UserList $a.Identity -DefaultStateForUser Enabled +$a= Get-DistributionGroupMember -Identity "Finance Team" +Set-App -OrganizationApp -Identity 3f10017a-9bbe-4a23-834b-6a8fe3af0e37 -ProvidedTo SpecificUsers -UserList $a.Identity -DefaultStateForUser Enabled ``` This example changes the organization app named FinanceTestApp, which was installed to everyone in the organization, to be provided to members of the Finance Team group and to be enabled by default. @@ -211,7 +212,7 @@ Accept wildcard characters: False ``` ### -UserList -The UserList parameter specifies who can use an organizational app. This parameter is currently limited to 1000 users. This will not change in the future as we are planning on moving to [Centralized Deployment](https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). +The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. For example: @@ -226,7 +227,7 @@ Valid values are mailboxes or mail users in your organization. You can use any v - SamAccountName - User ID or user principal name (UPN) -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". Maximum size of the list is 1000 recipients. +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. Maximum size of the list is 1000 recipients. You use this parameter with the OrganizationApp switch. diff --git a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md index 701f50e800..45b1b8985c 100644 --- a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md +++ b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Set-AtpPolicyForO365 cmdlet to modify the Advanced Threat Protection (ATP) policy in Office 365. The ATP policy configures the following protections: +Use the Set-AtpPolicyForO365 cmdlet to modify the settings for the following features in Microsoft Defender for Office 365: -- Safe Links in supported Office 365 apps in Office 365 ATP. -- Safe Documents in Microsoft Defender Advanced Threat Protection (MDATP). -- ATP for SharePoint Online, OneDrive for Business and Microsoft Teams in Office 365 ATP. +- Safe Links protection for supported Office 365 apps. +- Safe Documents: Uses Microsoft Defender for Endpoint to scan documents and files that are opened in Protected View in Microsoft 365 apps for enterprise. +- Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). @@ -41,11 +41,11 @@ Set-AtpPolicyForO365 [[-Identity] ] ``` ## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages and other supported locations to see if they lead to malicious web sites. For more information, see [Safe Links in Office 365 ATP](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links). +Safe Links protection for Office 365 apps checks links in Office documents, not links in email messages. For more information, see [Safe Links settings for Office 365 apps](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#safe-links-settings-for-office-365-apps). -ATP for SharePoint Online, OneDrive for Business and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see [ATP for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). +Safe Documents scans documents and files that are opened in Protected View. For more information, see [Safe Documents in Microsoft 365 E5](https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-docs). -Safe Documents in MDATP scans documents and files that are opened in Protected View. For more information, see [Safe Documents in Microsoft 365 E5](https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-docs). +Safe Attachments for SharePoint, OneDrive, and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -56,12 +56,12 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-AtpPolicyForO365 -EnableSafeLinksForClients $true -EnableATPForSPOTeamsODB $true ``` -This example enables Safe Links for Office 365 ProPlus clients and ATP for SharePoint Online, OneDrive for Business and Microsoft Teams. +This example enables Safe Documents and Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. ## PARAMETERS ### -Identity -The Identity parameter specifies the ATP policy that you want to modify. There's only one policy named Default. +The Identity parameter specifies the policy that you want to modify. There's only one policy named Default. ```yaml Type: AtpPolicyForO365IdParameter @@ -77,10 +77,10 @@ Accept wildcard characters: False ``` ### -AllowClickThrough -The AllowClickThrough parameter specifies whether to allow users to click through to the original blocked URL in supported Office 365 desktop, mobile, and web apps. Valid values are: +The AllowClickThrough parameter specifies whether to allow users to click through to the original blocked URL in Safe Links protection for Office apps. Valid values are: -- $true: Users are allowed to click through to the original URL in supported Office 365 apps. -- $false: Users aren't allowed to click through to the original URL in supported Office 365 apps. This is the default value. +- $true: Users are allowed to click through to the original URL in supported Office apps. +- $false: Users aren't allowed to click through to the original URL in supported Office apps. This is the default value. ```yaml Type: Boolean @@ -96,11 +96,13 @@ Accept wildcard characters: False ``` ### -AllowSafeDocsOpen -The AllowSafeDocsOpen parameter specifies whether users can click through and bypass the Protected View container even when Safe Documents in Microsoft Defender Advanced Threat Protection (MDATP) identifies a file as malicious. Valid values are: +The AllowSafeDocsOpen parameter specifies whether users can click through and bypass the Protected View container even when Safe Documents identifies a file as malicious. Valid values are: - $true: Users are allowed to exit the Protected View container even if the document has been identified as malicious. - $false: Users aren't allowed to exit Protected View in case of a malicious detection. +This parameter is meaningful only when the EnableSafeDocs parameter value is $true. + ```yaml Type: Boolean Parameter Sets: (All) @@ -115,13 +117,13 @@ Accept wildcard characters: False ``` ### -BlockUrls -The BlockUrls parameter specifies the URLs that are always blocked by Safe Links scanning in email messages, and supported Office 365 desktop and mobile apps. +The BlockUrls parameter specifies the URLs that are always blocked by Safe Links in email messages and Safe Links for Office 365 apps. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -For details about the entry syntax, see [Entry syntax for the "Block the following URLs" list](https://docs.microsoft.com/en-us/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-block-the-following-urls-list). +For details about the entry syntax, see [Entry syntax for the "Block the following URLs" list](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-block-the-following-urls-list). ```yaml Type: MultiValuedProperty @@ -156,10 +158,10 @@ Accept wildcard characters: False ``` ### -EnableATPForSPOTeamsODB -The EnableATPForSPOTeamsODB parameter specifies whether ATP protection is enabled for files in SharePoint Online, OneDrive for Business and Microsoft Teams. Valid values are: +The EnableATPForSPOTeamsODB parameter enables or disables Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. Valid values are: -- $true: ATP protection is enabled for files in SharePoint Online, OneDrive for Business and Microsoft Teams. SharePoint Online admins can use the DisallowInfectedFileDownload parameter on the [Set-SPOTenant](https://docs.microsoft.com/powershell/module/sharepoint-online/Set-SPOTenant) cmdlet to control whether users are allowed to download files that are found to be malicious. -- $false: ATP protection is disabled for file in SharePoint Online, OneDrive for Business and Microsoft Teams. This is the default value. +- $true: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is enabled. SharePoint Online admins can use the DisallowInfectedFileDownload parameter on the [Set-SPOTenant](https://docs.microsoft.com/powershell/module/sharepoint-online/Set-SPOTenant) cmdlet to control whether users are allowed to download files that are found to be malicious. +- $false: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is disabled. This is the default value. ```yaml Type: Boolean @@ -175,9 +177,9 @@ Accept wildcard characters: False ``` ### -EnableSafeDocs -The EnableSafeDocs parameter specifies whether to enable the Safe Documents feature in the organization. Valid values are: +The EnableSafeDocs parameter enables or disables Safe Documents in Microsoft 365 E5 or Microsoft 365 E5 Security organizations. Valid values are: -- $true: Safe Documents is enabled and will upload user files to Microsoft Defender Advanced Threat Protection (MDATP) for scanning and verification. +- $true: Safe Documents is enabled and will upload user files to Microsoft Defender for Endpoint for scanning and verification. - $false: Safe Documents is disabled. This is the default value. ```yaml @@ -194,7 +196,7 @@ Accept wildcard characters: False ``` ### -EnableSafeLinksForO365Clients -The EnableSafeLinksForO365Clients parameter specifies whether Safe Links scanning is enabled for supported Office 365 desktop, mobile, and web apps. Valid values are: +The EnableSafeLinksForO365Clients parameter enables or disables Safe Links for Office 365 apps. Valid values are: - $true: Safe Links scanning is enabled in supported Office 365 apps. This is the default value. - $false: Safe Links scanning is disabled in supported Office 365 apps. @@ -215,7 +217,7 @@ Accept wildcard characters: False ``` ### -TrackClicks -The TrackClicks parameter specifies whether to track user clicks related to blocked URLs in supported Office 365 apps. Valid values are: +The TrackClicks parameter specifies whether to track user clicks related to blocked URLs in Safe Links for Office 365 apps. Valid values are: - $true: User clicks in supported Office 365 apps are tracked. - $false: User clicks in supported Office 365 apps aren't tracked. This is the default value. diff --git a/exchange/exchange-ps/exchange/Set-AuthRedirect.md b/exchange/exchange-ps/exchange/Set-AuthRedirect.md index a63eeac3b7..131416885a 100644 --- a/exchange/exchange-ps/exchange/Set-AuthRedirect.md +++ b/exchange/exchange-ps/exchange/Set-AuthRedirect.md @@ -51,7 +51,7 @@ This example sets the TargetURL value for all existing OAuth redirection objects ## PARAMETERS ### -Identity -The Identity parameter specifies the existing OAuth redirection object that you want to modify. The object name uses the syntax AuthRedirect-Bearer-\. The easiest way to find the name of the OAuth redirection object is to run Get-AuthRedirect. +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 diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md index 7fcb4b868c..d6c8cbcb02 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md @@ -491,6 +491,8 @@ The RetryDistribution switch redistributes the policy to all OneDrive for Busine Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. + ```yaml Type: SwitchParameter Parameter Sets: RetryDistributionParameterSet diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md index 495bd32a3b..26daec5ecb 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md @@ -166,7 +166,7 @@ Accept wildcard characters: False ### -ContentContainsSensitiveInformation The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. -This parameter uses the basic syntax @(@{Name="\";[minCount="\"],@{Name="\";[minCount="\"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). +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"})`. ```yaml Type: PswsHashtable[] @@ -278,7 +278,7 @@ Accept wildcard characters: False ### -ExceptIfContentContainsSensitiveInformation The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the auto-labeling policy rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. -This parameter uses the basic syntax @(@{Name="\";[minCount="\"],@{Name="\";[minCount="\"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). ```yaml Type: PswsHashtable[] @@ -373,7 +373,7 @@ Accept wildcard characters: False ### -ExceptIfFromMemberOf The ExceptIfFromMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent by group members. You identify the group members by their email addresses. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: SmtpAddress[] @@ -455,7 +455,7 @@ The ExceptIfSentTo parameter specifies an exception for the auto-labeling policy - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use this exception in auto-labeling policies that are scoped only to Exchange. @@ -646,7 +646,7 @@ The SentTo parameter specifies a condition for the auto-sensitivity policy rule - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use this condition in auto-sensitivity policies that are scoped only to Exchange. diff --git a/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md index 8792314551..350166bc45 100644 --- a/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md @@ -69,11 +69,11 @@ This example sets Integrated Windows authentication for the Autodiscover virtual ### -Identity The Identity parameter specifies the Autodiscover virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter @@ -187,7 +187,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -209,9 +209,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/Set-CASMailbox.md b/exchange/exchange-ps/exchange/Set-CASMailbox.md index cc017b744a..28f0486453 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Set-CASMailbox.md @@ -137,9 +137,9 @@ Accept wildcard characters: False ### -ActiveSyncAllowedDeviceIDs TheActiveSyncAllowedDeviceIDs parameter specifies one or more Exchange ActiveSync device IDs that are allowed to synchronize with the mailbox. A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have Exchange ActiveSync partnerships with the mailbox. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. To clear the list of device IDs, use the value $null for this parameter. @@ -159,9 +159,9 @@ Accept wildcard characters: False ### -ActiveSyncBlockedDeviceIDs The ActiveSyncBlockedDeviceIDs parameter specifies one or more Exchange ActiveSync device IDs that aren't allowed to synchronize with the mailbox. A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have Exchange ActiveSync partnerships with the mailbox. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. To clear the list of device IDs, use the value $null for this parameter. @@ -340,24 +340,24 @@ This parameter is available only in on-premises Exchange. The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is \:\,\:\,...\:\. The optional \ value specifies the type of email address. Some examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a \ value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: -- Use the \ value SMTP on the address. -- The first email address when you don't use any \ values, or when you use multiple \ values of smtp. +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. - Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\:\","\:\",..."\:\". +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\:\","\:\",...; Remove="\:\","\:\",...}. +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. ```yaml Type: ProxyAddressCollection @@ -415,9 +415,9 @@ Accept wildcard characters: False ### -EwsAllowList The EwsAllowList parameter specifies the Exchange Web Services applications (user agent strings) that are allowed to access the mailbox. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceAllowList. @@ -500,9 +500,9 @@ Accept wildcard characters: False ### -EwsBlockList The EwsBlockList parameter specifies the Exchange Web Services applications (user agent strings) that aren't allowed to access the mailbox using Exchange Web Services. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceBlockList. @@ -834,7 +834,7 @@ This parameter is available only in on-premises Exchange. The MAPIBlockOutlookVersions parameter blocks access to the mailbox for specific versions of Outlook. -For example, if you specify the value 15.0.4569.1503, only Outlook 2013 Service Pack 1 (SP1) or later clients are allowed to access the mailbox. Earlier versions of Outlook are blocked. +For example, if you specify the value 15.0.4569, only Outlook 2013 Service Pack 1 (SP1) or later clients are allowed to access the mailbox. Earlier versions of Outlook are blocked. The default value is blank. To reset this parameter, use the value $null. @@ -1191,7 +1191,7 @@ Accept wildcard characters: False ### -SamAccountName This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md index 65ad713556..7889e05b66 100644 --- a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md +++ b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md @@ -401,7 +401,7 @@ The BookInPolicy parameter specifies users or groups who are allowed to submit i - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -691,10 +691,12 @@ Accept wildcard characters: False ### -MinimumDurationInMinutes This parameter is available only in the cloud-based service. -The MinimumDurationInMinutes parameter specifies the minimum duration in minutes for meeting requests. A valid value is an integer from 0 through INT32 (2147483647). The default value is 0, which means there is no minimum duration. +The MinimumDurationInMinutes parameter specifies the minimum duration in minutes for meeting requests in workspace mailboxes. A valid value is an integer from 0 through INT32 (2147483647). The default value is 0, which means there is no minimum duration. For recurring meetings, the value of this parameter applies to the length of an individual meeting instance. +This parameter only works on workspace mailboxes. + ```yaml Type: Int32 Parameter Sets: (All) @@ -813,7 +815,7 @@ The RequestInPolicy parameter specifies users who are allowed to submit in-polic - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -838,7 +840,7 @@ The RequestOutOfPolicy parameter specifies users who are allowed to submit out-o - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -863,7 +865,7 @@ The ResourceDelegates parameter specifies users can approve or reject requests t - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md index 08ae24f90a..9891341503 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md @@ -88,7 +88,11 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. +The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. + +Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. + +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. ```yaml Type: SwitchParameter @@ -115,7 +119,7 @@ To specify a mailbox or distribution group, you can use the following values: - SMTP address - Azure AD ObjectId (You can use the [Get-AzureADUser](https://docs.microsoft.com/powershell/module/azuread/get-azureaduser) cmdlet to obtain this value.) -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -149,7 +153,7 @@ Accept wildcard characters: False ### -AddSharePointLocation The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to the policy until they have been indexed. @@ -249,7 +253,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -283,7 +287,7 @@ Accept wildcard characters: False ### -RemoveSharePointLocation The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md index a09f7608d4..96ff564eec 100644 --- a/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md @@ -47,7 +47,7 @@ This example imports the classification rule collection file C:\\My Documents\\E ### -FileData The FileData parameter specifies the classification rule collection file you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md index 748ac85352..310bbca39c 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md @@ -45,7 +45,7 @@ Set-ClientAccessRule [-Identity] ## DESCRIPTION Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. -Note: Not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: +**Note**: Not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: - ExchangeActiveSync: BasicAuthentication, OAuthAuthentication, and CertificateBasedAuthentication. - ExchangeAdminCenter: BasicAuthentication and AdfsAuthentication. @@ -116,9 +116,9 @@ Valid values for this parameter are: - NonBasicAuthentication - OAuthAuthentication -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -140,9 +140,9 @@ The AnyOfClientIPAddressesOrRanges parameter specifies a condition for the clien - An IP address range: For example, 192.168.0.1-192.168.0.254. - Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.3.1/24. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -177,9 +177,9 @@ Valid values for this parameter are: **Note**: In Exchange 2019, the only supported values are ExchangeAdminCenter and RemotePowerShell. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -260,9 +260,9 @@ Valid values for this parameter are: - NonBasicAuthentication - OAuthAuthentication -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -284,9 +284,9 @@ The ExceptAnyOfClientIPAddressesOrRanges parameter specifies an exception for th - An IP address range: For example, 192.168.0.1-192.168.0.254. - Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.3.1/24. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -321,9 +321,9 @@ Valid values for this parameter are: - REST - UniversalOutlook (Mail and Calendar app) -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -341,11 +341,11 @@ Accept wildcard characters: False ### -ExceptUsernameMatchesAnyOfPatterns This parameter is available only in the cloud-based service. -The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that's based on the user's account name in the format \\\\ (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. +The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -414,11 +414,11 @@ Accept wildcard characters: False ### -UsernameMatchesAnyOfPatterns This parameter is available only in the cloud-based service. -The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that's based on the user's account name in the format \\\\ (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. +The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessServer.md b/exchange/exchange-ps/exchange/Set-ClientAccessServer.md index ae18e16344..89e2a9a747 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessServer.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessServer.md @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ClientAccessServer cmdlet to modify settings that are associated with the Client Access server role. -Note: In Exchange 2013 or later, use the Set-ClientAccessService cmdlet instead. If you have scripts that use Set-ClientAccessServer, update them to use Set-ClientAccessService. +**Note**: In Exchange 2013 or later, use the Set-ClientAccessService cmdlet instead. If you have scripts that use Set-ClientAccessServer, update them to use Set-ClientAccessService. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -148,9 +148,9 @@ The AutoDiscoverSiteScope parameter specifies the Active Directory site that the To see the available Active Directory sites, use the Get-ADSite cmdlet. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessService.md b/exchange/exchange-ps/exchange/Set-ClientAccessService.md index 5938b7f0b9..aee9e65391 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessService.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessService.md @@ -134,9 +134,9 @@ The AutoDiscoverSiteScope parameter specifies the Active Directory site that the To see the available Active Directory sites, use the Get-ADSite cmdlet. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md index 31b7010370..6535cb0dad 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md @@ -190,7 +190,7 @@ Accept wildcard characters: False ### -AddSharePointLocation The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] @@ -208,7 +208,7 @@ Accept wildcard characters: False ### -AddSharePointLocationExclusion This parameter specifies the SharePoint Online sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] @@ -311,7 +311,7 @@ The ExchangeLocation parameter specifies the mailboxes to include. Valid values To specify a mailbox or distribution group, use the email address. You can specify multiple values separated by commas. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] @@ -595,7 +595,7 @@ Accept wildcard characters: False ### -RemoveSharePointLocation The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] @@ -613,7 +613,7 @@ Accept wildcard characters: False ### -RemoveSharePointLocationExclusion This parameter specifies the SharePoint Online sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] @@ -631,7 +631,7 @@ Accept wildcard characters: False ### -SharePointLocation The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] @@ -649,7 +649,7 @@ Accept wildcard characters: False ### -SharePointLocationExclusion This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md index ef495dda2e..43d512cd5d 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md @@ -47,7 +47,7 @@ This example changes the export key on the export compliance search action named ### -Identity The Identity parameter specifies the compliance search action that you want to modify. You can use any value that uniquely identifies the compliance search action. For example: -- Name: The compliance search action name uses the syntax \\_\ (for example, Case 1234\_Preview). +- Name: The compliance search action name uses the syntax `"Compliance Search Name_Action"` (for example, `"Case 1234_Preview`). - JobRunId (GUID) ```yaml diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md index d0163cc157..cb62a33238 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md @@ -39,14 +39,18 @@ You need to be assigned permissions in the Security & Compliance Center before y ### Example 1 ```powershell -$filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter"; $filterusers.users.add("pilarp@contoso.com"); Set-ComplianceSecurityFilter -FilterName OttawaUsersFilter -Users $filterusers.users +$filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" +$filterusers.users.add("pilarp@contoso.com") +Set-ComplianceSecurityFilter -FilterName OttawaUsersFilter -Users $filterusers.users ``` This example adds user pilarp@contoso.com to the compliance security filter named Ottawa Users Filter without affecting other users assigned to the filter. ### Example 2 ```powershell -$filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter"; $filterusers.users.remove("annb@contoso.com"); Set-ComplianceSecurityFilter -FilterName OttawaUsersFilter -Users $filterusers.users +$filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" +$filterusers.users.remove("annb@contoso.com") +Set-ComplianceSecurityFilter -FilterName OttawaUsersFilter -Users $filterusers.users ``` This example removes user annb@contoso.com to the compliance security filter named Ottawa Users Filter without affecting other users assigned to the filter. diff --git a/exchange/exchange-ps/exchange/Set-Contact.md b/exchange/exchange-ps/exchange/Set-Contact.md index f7a19cc924..cf8c6c63e3 100644 --- a/exchange/exchange-ps/exchange/Set-Contact.md +++ b/exchange/exchange-ps/exchange/Set-Contact.md @@ -631,7 +631,8 @@ The SimpleDisplayName parameter is used to display an alternative description of - a - z - A - Z - 0 - 9 -- "\", """, "'", "(", ")", "+", ",", "-", ".", "/", ":" and "?". +- space +- `" ' ( ) + , - . / : ?` This parameter is meaningful only if the contact is mail-enabled. @@ -731,17 +732,17 @@ Accept wildcard characters: False ### -UMDtmfMap The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: -- emailAddress:\ -- lastNameFirstName:\ -- firstNameLastName:\ +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\,lastNameFirstName:\,firstNameLastName:\. +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\, all existing lastNameFirstName and firstNameLastName values are removed. +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"; Remove="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"}. +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\","emailAddress:\} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-DataClassification.md b/exchange/exchange-ps/exchange/Set-DataClassification.md index b5b610535c..0844e08271 100644 --- a/exchange/exchange-ps/exchange/Set-DataClassification.md +++ b/exchange/exchange-ps/exchange/Set-DataClassification.md @@ -58,14 +58,23 @@ This example removes the existing Spanish translation from the data classificati ### Example 3 ```powershell -$Benefits_Template = Get-Content "C:\My Documents\Contoso Benefits Template.docx" -Encoding byte; $Benefits_Fingerprint = New-Fingerprint -FileData $Benefits_Template -Description "Contoso Benefits Template"; $Contoso_Confidential = Get-DataClassification "Contoso Confidential"; $Array = [System.Collections.ArrayList]($Contoso_Confidential.Fingerprints); $Array.Add($Benefits_FingerPrint); Set-DataClassification $Contoso_Confidential.Identity -FingerPrints $Array +$Benefits_Template = Get-Content "C:\My Documents\Contoso Benefits Template.docx" -Encoding byte +$Benefits_Fingerprint = New-Fingerprint -FileData $Benefits_Template -Description "Contoso Benefits Template" +$Contoso_Confidential = Get-DataClassification "Contoso Confidential" +$Array = [System.Collections.ArrayList]($Contoso_Confidential.Fingerprints) +$Array.Add($Benefits_FingerPrint) +Set-DataClassification $Contoso_Confidential.Identity -FingerPrints $Array ``` This example modifies the existing data classification rule named "Contoso Confidential" by adding a new document fingerprint for the file C:\\My Documents\\Contoso Benefits Template.docx without affecting any existing document fingerprints that are already defined. ### Example 4 ```powershell -$cc = Get-DataClassification "Contoso Confidential"; $a = [System.Collections.ArrayList]($cc.Fingerprints); $a; $a.RemoveAt(0); Set-DataClassification $cc.Identity -FingerPrints $a +$cc = Get-DataClassification "Contoso Confidential" +$a = [System.Collections.ArrayList]($cc.Fingerprints) +$a +$a.RemoveAt(0) +Set-DataClassification $cc.Identity -FingerPrints $a ``` This example modifies the data classification rule named "Contoso Confidential" by removing an existing document fingerprint without affecting other document fingerprints that are already defined. diff --git a/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md b/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md index 5d9e2f54de..13c57dd220 100644 --- a/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md @@ -61,7 +61,9 @@ Sets the maximum concurrent connections to 10. ### Example 2 ```powershell -$ConnectorConfig = Get-DeliveryAgentConnector "Contoso X.400 Connector"; $ConnectorConfig.AddressSpaces += "X400:c=US;p=Fabrikam;a=Contoso;o=Sales;1"; $ConnectorConfig.SourceTransportServers += Hub04; Set-DeliveryAgentConnector "Contoso X.400 Connector" -AddressSpaces $ConnectorConfig.AddressSpaces -SourceTransportServers $ConnectorConfig.SourceTransportServers +$ConnectorConfig = Get-DeliveryAgentConnector "Contoso X.400 Connector" +$ConnectorConfig.AddressSpaces += "X400:c=US;p=Fabrikam;a=Contoso;o=Sales;1" +$ConnectorConfig.SourceTransportServers += Hub04; Set-DeliveryAgentConnector "Contoso X.400 Connector" -AddressSpaces $ConnectorConfig.AddressSpaces -SourceTransportServers $ConnectorConfig.SourceTransportServers ``` This example uses the temporary variable $ConnectorConfig to add the address space c=US;p=Fabrikam;a=Contoso;o=Sales to the delivery agent connector Contoso X.400 Connector and also adds the server Hub04 to the list of servers that host the connector. @@ -85,7 +87,7 @@ Accept wildcard characters: False ``` ### -AddressSpaces -The AddressSpaces parameter specifies the domain names for which this delivery agent connector is responsible. The syntax for entering an address space is as follows: \:\;\. You must enclose each address space in quotation marks ("). +The AddressSpaces parameter specifies the domain names that the delivery agent connector is responsible for. The complete syntax for entering an address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. Enclose each address space in quotation marks ("). ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md index 0874479119..af39372e4f 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md @@ -98,7 +98,7 @@ This example modifies the specified mobile device conditional access rule to blo ## PARAMETERS ### -Identity -The Identity parameter specifies the mobile device conditional access rule that you want to modify. The name of the rule uses the syntax \{\}. For example, Secure Email{914f151c-394b-4da9-9422-f5a2f65dec30}. You can find the name value by running the command: Get-DeviceConfigurationRule | Format-List Name. +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 diff --git a/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md index 562c9f7add..34d7c5905c 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md @@ -97,7 +97,7 @@ This example modifies the specified mobile device configuration rule to block sc ## PARAMETERS ### -Identity -The Identity parameter specifies the mobile device configuration rule that you want to modify. The name of the rule uses the syntax \{\}. For example, Engineering Group{914f151c-394b-4da9-9422-f5a2f65dec30}.. +The Identity parameter specifies the mobile device configuration rule that you want to modify. The name of the rule uses the syntax `,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-DistributionGroup.md b/exchange/exchange-ps/exchange/Set-DistributionGroup.md index c28e0ade66..cd6de3d3ab 100644 --- a/exchange/exchange-ps/exchange/Set-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-DistributionGroup.md @@ -156,9 +156,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -189,9 +189,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -224,7 +224,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. @@ -248,9 +248,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -315,9 +315,9 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -To enter multiple senders and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. @@ -691,26 +691,26 @@ Accept wildcard characters: False ### -EmailAddresses The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is \:\,\:\,...\:\. The optional \ value specifies the type of email address. Some examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a \ value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: -- Use the \ value SMTP on the address. -- The first email address when you don't use any \ values, or when you use multiple \ values of smtp. +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. - Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\:\","\:\",..."\:\". +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\:\","\:\",...; Remove="\:\","\:\",...}. +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. ```yaml Type: ProxyAddressCollection @@ -756,7 +756,7 @@ You can specify the following types of servers as expansion servers: - An Exchange 2013 or later Mailbox server. - An Exchange 2010 Hub Transport server. -When you specify an expansion server, use the ExchangeLegacyDN. You can find this value by running the command: Get-ExchangeServer \ | Format-List ExchangeLegacyDN. An example value for this parameter is "/o=Contoso/ou=Exchange Administrative Group(FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01". +When you specify an expansion server, use the ExchangeLegacyDN. You can find this value by running the command: `Get-ExchangeServer | Format-List ExchangeLegacyDN`. An example value for this parameter is "/o=Contoso/ou=Exchange Administrative Group(FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01". ```yaml Type: String @@ -774,9 +774,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute1 This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -796,9 +796,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute2 This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -818,9 +818,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute3 This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -840,9 +840,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute4 This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -862,9 +862,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute5 This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -898,7 +898,7 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo -The GrantSendOnBehalfTo parameter specifies who can send on behalf of this group. Although messages send on behalf of the group clearly show the sender in the From field (\ on behalf of \), replies to these messages are delivered to the group, not the sender. +The 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: @@ -913,9 +913,9 @@ The sender you specify for this parameter must a mailbox, mail user or mail-enab - SamAccountName - User ID or user principal name (UPN) -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. By default, this parameter is blank, which means no one else has permission to send on behalf of this group. @@ -997,8 +997,8 @@ The MailTip parameter specifies the custom MailTip text for this recipient. The When you add a MailTip to a recipient, two things happen: -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \\This mailbox is not monitored\\. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. ```yaml Type: String @@ -1018,11 +1018,11 @@ The MailTipTranslations parameter specifies additional languages for the custom To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: -@{Add="\:\","\:\"...; Remove="\:\","\:\"...} +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. -\ is a valid ISO 639 two-letter culture code that's associated with the language. +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. ```yaml Type: MultiValuedProperty @@ -1059,9 +1059,9 @@ The owner you specify for this parameter must be a mailbox, mail user or mail-en - SamAccountName - User ID or user principal name (UPN) -To enter multiple owners and overwrite all existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple owners and overwrite all existing entries, use the following syntax: `Owner1,Owner2,...OwnerN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Owner1","Owner2",..."OwnerN"`. -To add or remove owners without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove owners without affecting other existing entries, use the following syntax: `@{Add="Owner1","Owner2",...; Remove="Owner3","Owner4"...}`. An owner that you specify with this parameter isn't automatically a member of the group. You need to manually add the owner as a member. @@ -1189,9 +1189,9 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. For mail-enabled security groups, you need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -1279,9 +1279,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1312,9 +1312,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1347,7 +1347,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. @@ -1468,7 +1468,7 @@ Accept wildcard characters: False ### -SamAccountName This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String @@ -1530,7 +1530,8 @@ The SimpleDisplayName parameter is used to display an alternative description of - a - z - A - Z - 0 - 9 -- "\", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". +- space +- `" ' ( ) + , - . / : ?` ```yaml Type: String @@ -1548,17 +1549,17 @@ Accept wildcard characters: False ### -UMDtmfMap The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: -- emailAddress:\ -- lastNameFirstName:\ -- firstNameLastName:\ +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\,lastNameFirstName:\,firstNameLastName:\. +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\, all existing lastNameFirstName and firstNameLastName values are removed. +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"; Remove="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"}. +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\","emailAddress:\} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md index d0665b7260..f1ddeb6ac5 100644 --- a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md @@ -104,7 +104,11 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch redistributes the policy to all OneDrive for Business and SharePoint Online locations. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. +The RetryDistribution switch redistributes the policy to all OneDrive for Business and SharePoint Online locations. You don't need to specify a value with this switch. + +Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. + +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. ```yaml Type: SwitchParameter @@ -170,7 +174,7 @@ Accept wildcard characters: False ### -AddOneDriveLocation The AddOneDriveLocation parameter specifies the OneDrive for Business sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -188,7 +192,7 @@ Accept wildcard characters: False ### -AddOneDriveLocationException This parameter specifies the OneDrive for Business sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -208,7 +212,7 @@ The AddSharePointLocation parameter specifies the SharePoint Online sites to add SharePoint Online sites can't be added to the policy until they have been indexed. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -226,7 +230,7 @@ Accept wildcard characters: False ### -AddSharePointLocationException This parameter specifies the SharePoint Online sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -244,7 +248,7 @@ Accept wildcard characters: False ### -AddTeamsLocation The AddTeamsLocation parameter specifies the Teams accounts to add to the list of included accounts when you aren't using the value All for the TeamsLocation parameter. You identify the account by its name or email address. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -262,7 +266,7 @@ Accept wildcard characters: False ### -AddTeamsLocationException The AddTeamsLocationException parameter specifies the Teams accounts to add to the list of excluded accounts when you use the value All for the TeamsLocation parameter. You identify the account by its name or email address. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -315,7 +319,7 @@ Accept wildcard characters: False ### -ExchangeSenderMemberOf The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the DLP policy. You identify the group by its email address. -To enter multiple values, use the following syntax: \,\,...\. +You can enter multiple values separated by commas. You can't use this parameter to specify Microsoft 365 Groups. @@ -335,7 +339,7 @@ Accept wildcard characters: False ### -ExchangeSenderMemberOfException The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the DLP policy. You identify the group by its email address. -To enter multiple values, use the following syntax: \,\,...\. +You can enter multiple values separated by commas. You can't use this parameter to specify Microsoft 365 Groups. @@ -464,7 +468,7 @@ Accept wildcard characters: False ### -RemoveOneDriveLocation The RemoveOneDriveLocation parameter specifies the OneDrive for Business sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -482,7 +486,7 @@ Accept wildcard characters: False ### -RemoveOneDriveLocationException This parameter specifies the OneDrive for Business sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -500,7 +504,7 @@ Accept wildcard characters: False ### -RemoveSharePointLocation The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -518,7 +522,7 @@ Accept wildcard characters: False ### -RemoveSharePointLocationException This parameter specifies the SharePoint Online sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -536,7 +540,7 @@ Accept wildcard characters: False ### -RemoveTeamsLocation The RemoveTeamsLocation parameter specifies the Teams accounts to remove from the list of included accounts when you use the value All for the TeamsLocation parameter. You identify the account by its name or email address. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -554,7 +558,7 @@ Accept wildcard characters: False ### -RemoveTeamsLocationException The RemoveTeamsLocation parameter specifies the Teams accounts to remove from the list of excluded accounts when you aren't using the value All for the TeamsLocation parameter. You identify the account by its name or email address. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index d76ef7ca21..ed7729d674 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -27,6 +27,7 @@ Set-DlpComplianceRule [-Identity] [-AddRecipients ] [-AnyOfRecipientAddressContainsWords ] [-AnyOfRecipientAddressMatchesPatterns ] + [-ApplyHtmlDisclaimer ] [-BlockAccess ] [-BlockAccessScope ] [-Comment ] @@ -72,6 +73,7 @@ Set-DlpComplianceRule [-Identity] [-ExceptIfSubjectMatchesPatterns ] [-ExceptIfSubjectOrBodyContainsWords ] [-ExceptIfSubjectOrBodyMatchesPatterns ] + [-ExceptIfWithImportance ] [-ExpiryDate ] [-From ] [-FromAddressContainsWords ] @@ -91,6 +93,7 @@ Set-DlpComplianceRule [-Identity] [-NotifyPolicyTipCustomText ] [-NotifyPolicyTipCustomTextTranslations ] [-NotifyUser ] + [-PrependSubject ] [-Priority ] [-ProcessingLimitExceeded ] [-RecipientDomainIs ] @@ -112,6 +115,7 @@ Set-DlpComplianceRule [-Identity] [-ReportSeverityLevel ] [-RuleErrorAction ] [-WhatIf] + [-WithImportance ] [] ``` @@ -251,6 +255,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ApplyHtmlDisclaimer +The ApplyHtmlDisclaimer parameter specifies an action for the rule that adds disclaimer text to messages.This parameter uses the syntax: `@{Text = "Disclaimer text"; Location = ; FallbackAction = }`. + +- Text: Specifies the disclaimer text to add. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. +- Location: Specifies where to insert the HTML disclaimer text in the body of messages. Append = Add to the end of the message body. Prepend = Insert at the beginning of the message body. +- FallbackAction: Specifies what to do if the HTML disclaimer can't be added to a message. Wrap = The original message is wrapped in a new message envelope, and the disclaimer is used as the message body for the new message. Ignore = The rule is ignored and the message is delivered without the disclaimer. Reject = The message is rejected. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BlockAccess The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: @@ -326,9 +352,9 @@ Accept wildcard characters: False ``` ### -ContentCharacterSetContainsWords -The ContentCharacterSetContainsWords parameter specifies a condition for the rule that looks for character set names in messages. +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. -To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. +Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874`. ```yaml Type: MultiValuedProperty @@ -594,7 +620,9 @@ Accept wildcard characters: False ### -ExceptIfContentCharacterSetContainsWords The ExceptIfContentCharacterSetContainsWords parameter specifies an exception for the rule that looks for character set names in messages. -To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. +To specify multiple words, this parameter uses the syntax: `Word1,word2,...wordN`. Don't use leading or trailing spaces. + +Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, hz-gb-2312, iso-2022-jp, iso-2022-kr, iso-8859-1, iso-8859-13, iso-8859-15, iso-8859-2, iso-8859-3, iso-8859-4, iso-8859-5, iso-8859-6, iso-8859-7, iso-8859-8, iso-8859-9, koi8-r, koi8-u, ks_c_5601-1987, ns_4551-1, sen_850200_b, shift_jis, utf-7, utf-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-874`. ```yaml Type: MultiValuedProperty @@ -1131,6 +1159,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExceptIfWithImportance +The ExceptIfWithImportance parameter specifies an exception for the rule that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: WithImportance +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExpiryDate This parameter is reserved for internal Microsoft use. @@ -1531,6 +1581,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PrependSubject +The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). + +Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Priority The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. @@ -1881,6 +1951,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WithImportance +The WithImportance parameter specifies a condition for the rule that looks for messages with the specified importance level. Valid values are: + +- Low +- Normal +- High + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: WithImportance +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). diff --git a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md index 2e8ff7d934..35cae54835 100644 --- a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md @@ -36,7 +36,8 @@ You need to be assigned permissions in the Security & Compliance Center before y ### Example 1 ```powershell -$edmSchemaXml = Get-Content "C:\My Documents\edm.xml" -Encoding Byte -ReadCount 0; Set-DlpEdmSchema -FileData $edmSchemaXml -Confirm:$true +$edmSchemaXml = Get-Content "C:\My Documents\edm.xml" -Encoding Byte -ReadCount 0 +Set-DlpEdmSchema -FileData $edmSchemaXml -Confirm:$true ``` This example modifies a DLP EDM schema. The first command reads the schema in the XML file to a variable, and the second command uses that information to modify the DLP EDM schema. @@ -46,7 +47,7 @@ This example modifies a DLP EDM schema. The first command reads the schema in th ### -FileData The FileData parameter specifies the DLP EDM schema that you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md index b741a07bba..4a0cd621e5 100644 --- a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md @@ -37,28 +37,47 @@ You need to be assigned permissions in the Security & Compliance Center before y ### Example 1 ```powershell -$Keywords = "Aarskog's syndrome, Abandonment, Abasia, Abderhalden-Kaufmann-Lignac, Abdominalgia, Abduction contracture, Abetalipo proteinemia, Abiotrophy, Ablatio, ablation, Ablepharia, Abocclusion, Abolition, Aborter, Abortion, Abortus, Aboulomania, Abrami's disease, Abramo"; $EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($keywords); Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords +$Keywords = "Aarskog's syndrome, Abandonment, Abasia, Abderhalden-Kaufmann-Lignac, Abdominalgia, Abduction contracture, Abetalipo proteinemia, Abiotrophy, Ablatio, ablation, Ablepharia, Abocclusion, Abolition, Aborter, Abortion, Abortus, Aboulomania, Abrami's disease, Abramo" +$EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($keywords) +Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords ``` This example replaces the existing terms in the DLP keyword dictionary named Diseases with the specified values. ### Example 2 ```powershell -$Dictionary = Get-DlpKeywordDictionary -Name "Diseases"; $Terms = $Dictionary.KeywordDictionary.split(',').trim(); $Terms += "Achylia","Acidemia","Acidocytopenia","Acidocytosis","Acidopenia","Acidosis","Aciduria","Acladiosis","Aclasis"; $Keywords = $Terms -Join ", "; $EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($Keywords); Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords +$Dictionary = Get-DlpKeywordDictionary -Name "Diseases" +$Terms = $Dictionary.KeywordDictionary.split(',').trim() +$Terms += "Achylia","Acidemia","Acidocytopenia","Acidocytosis","Acidopenia","Acidosis","Aciduria","Acladiosis","Aclasis" +$Keywords = $Terms -Join ", " +$EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($Keywords) +Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords ``` This example adds the specified terms to the DLP keyword dictionary named Diseases without affecting other existing terms. ### Example 3 ```powershell -$Dictionary = Get-DlpKeywordDictionary -Name "Diseases"; $Terms = $Dictionary.KeywordDictionary.split(',').trim(); $TermsToRemove = @('abandonment', 'ablatio'); $UpdatedTerms = $Terms | Where-Object {$_ -NotIn $TermsToRemove}; $Keywords = $UpdatedTerms -Join ", "; $EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($Keywords); Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords +$Dictionary = Get-DlpKeywordDictionary -Name "Diseases" +$Terms = $Dictionary.KeywordDictionary.split(',').trim() +$TermsToRemove = @('abandonment', 'ablatio') +$UpdatedTerms = $Terms | Where-Object {$_ -NotIn $TermsToRemove} +$Keywords = $UpdatedTerms -Join ", " +$EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($Keywords) +Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords ``` This example removes the specified terms from the DLP keyword dictionary named Diseases without affecting other existing terms. ### Example 4 ```powershell -$Dictionary = Get-DlpKeywordDictionary -Name "Inappropriate Language"; $Terms = $Dictionary.KeywordDictionary.split(',').trim(); Set-Content $Terms -Path "C:\My Documents\InappropriateTerms.txt"; $UpdatedTerms = Get-Content -Path "C:\My Documents\InappropriateTerms.txt"; $Keywords = $UpdatedTerms -Join ", "; $EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($Keywords); Set-DlpKeywordDictionary -Identity "Inappropriate Language" -FileData $EncodedKeywords +$Dictionary = Get-DlpKeywordDictionary -Name "Inappropriate Language" +$Terms = $Dictionary.KeywordDictionary.split(',').trim() +Set-Content $Terms -Path "C:\My Documents\InappropriateTerms.txt" +$UpdatedTerms = Get-Content -Path "C:\My Documents\InappropriateTerms.txt" +$Keywords = $UpdatedTerms -Join ", " +$EncodedKeywords = [system.Text.Encoding]::UTF8.GetBytes($Keywords) +Set-DlpKeywordDictionary -Identity "Inappropriate Language" -FileData $EncodedKeywords ``` The first three commands export the terms from the existing keyword dictionary named Inappropriate Language to the file C:\\My Documents\\InappropriateTerms.txt, where each term is on a separate line. diff --git a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md index 8208cb9452..3789cce768 100644 --- a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md @@ -56,14 +56,23 @@ This example removes the existing Spanish translation from the sensitive informa ### Example 3 ```powershell -$Benefits_Template = Get-Content "C:\My Documents\Contoso Benefits Template.docx" -Encoding byte -ReadCount 0; $Benefits_Fingerprint = New-DlpFingerprint -FileData $Benefits_Template -Description "Contoso Benefits Template"; $Contoso_Confidential = Get-DlpSensitiveInformationType "Contoso Confidential"; $Array = [System.Collections.ArrayList]($Contoso_Confidential.Fingerprints); $Array.Add($Benefits_FingerPrint[0]); Set-DlpSensitiveInformationType $Contoso_Confidential.Identity -FingerPrints $Array +$Benefits_Template = Get-Content "C:\My Documents\Contoso Benefits Template.docx" -Encoding byte -ReadCount 0 +$Benefits_Fingerprint = New-DlpFingerprint -FileData $Benefits_Template -Description "Contoso Benefits Template" +$Contoso_Confidential = Get-DlpSensitiveInformationType "Contoso Confidential" +$Array = [System.Collections.ArrayList]($Contoso_Confidential.Fingerprints) +$Array.Add($Benefits_FingerPrint[0]) +Set-DlpSensitiveInformationType $Contoso_Confidential.Identity -FingerPrints $Array ``` This example modifies the existing sensitive information type rule named "Contoso Confidential" by adding a new document fingerprint for the file C:\\My Documents\\Contoso Benefits Template.docx without affecting any existing document fingerprints that are already defined. ### Example 4 ```powershell -$cc = Get-DlpSensitiveInformationType "Contoso Confidential"; $a = [System.Collections.ArrayList]($cc.Fingerprints); $a; $a.RemoveAt(0); Set-DlpSensitiveInformationType $cc.Identity -FingerPrints $a +$cc = Get-DlpSensitiveInformationType "Contoso Confidential" +$a = [System.Collections.ArrayList]($cc.Fingerprints) +$a +$a.RemoveAt(0) +Set-DlpSensitiveInformationType $cc.Identity -FingerPrints $a ``` This example modifies the sensitive information type rule named "Contoso Confidential" by removing an existing document fingerprint without affecting other document fingerprints that are already defined. diff --git a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md index 33bce041c2..5c975cfad6 100644 --- a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationTypeRulePackage.md @@ -46,7 +46,7 @@ This example imports the sensitive information type rule package C:\\My Document ### -FileData The FileData parameter specifies the sensitive information type rule package that you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, \(\[Byte\[\]\]\(Get-Content -Encoding Byte -Path "C:\\My Documents\\\" -ReadCount 0\)\). +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md index 8cffd49b6c..e15fd5d498 100644 --- a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md @@ -184,9 +184,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -217,9 +217,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -252,7 +252,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. @@ -276,9 +276,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -343,9 +343,9 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -To enter multiple senders and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. @@ -367,9 +367,9 @@ The ConditionalCompany parameter specifies a precanned filter that's based on th When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -389,9 +389,9 @@ The ConditionalCustomAttribute1 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -411,9 +411,9 @@ The ConditionalCustomAttribute10 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -433,9 +433,9 @@ The ConditionalCustomAttribute11 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -455,9 +455,9 @@ The ConditionalCustomAttribute12 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -477,9 +477,9 @@ The ConditionalCustomAttribute13 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -499,9 +499,9 @@ The ConditionalCustomAttribute14 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -521,9 +521,9 @@ The ConditionalCustomAttribute15 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -543,9 +543,9 @@ The ConditionalCustomAttribute2 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -565,9 +565,9 @@ The ConditionalCustomAttribute3 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -587,9 +587,9 @@ The ConditionalCustomAttribute4 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -609,9 +609,9 @@ The ConditionalCustomAttribute5 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -631,9 +631,9 @@ The ConditionalCustomAttribute6 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -653,9 +653,9 @@ The ConditionalCustomAttribute7 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -675,9 +675,9 @@ The ConditionalCustomAttribute8 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -697,9 +697,9 @@ The ConditionalCustomAttribute9 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -719,9 +719,9 @@ The ConditionalDepartment parameter specifies a precanned filter that's based on When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -741,9 +741,9 @@ The ConditionalStateOrProvince parameter specifies a precanned filter that's bas When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -1091,26 +1091,26 @@ Accept wildcard characters: False ### -EmailAddresses The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is \:\,\:\,...\:\. The optional \ value specifies the type of email address. Some examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a \ value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: -- Use the \ value SMTP on the address. -- The first email address when you don't use any \ values, or when you use multiple \ values of smtp. +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. - Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\:\","\:\",..."\:\". +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\:\","\:\",...; Remove="\:\","\:\",...}. +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. ```yaml Type: ProxyAddressCollection @@ -1157,7 +1157,7 @@ You can specify the following types of servers as expansion servers: - An Exchange 2013 Mailbox server. - An Exchange 2010 Hub Transport server. -When you specify an expansion server, use the ExchangeLegacyDN. You can find this value by running the command: Get-ExchangeServer \ | Format-List ExchangeLegacyDN. An example value for this parameter is "/o=Contoso/ou=Exchange Administrative Group(FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01". +When you specify an expansion server, use the ExchangeLegacyDN. You can find this value by running the command: `Get-ExchangeServer | Format-List ExchangeLegacyDN`. An example value for this parameter is "/o=Contoso/ou=Exchange Administrative Group(FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01". ```yaml Type: String @@ -1175,9 +1175,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute1 This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -1197,9 +1197,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute2 This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -1219,9 +1219,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute3 This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -1241,9 +1241,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute4 This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -1263,9 +1263,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute5 This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -1299,7 +1299,7 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo -The GrantSendOnBehalfTo parameter specifies who can send on behalf of this dynamic distribution group. Although messages send on behalf of the group clearly show the sender in the From field (\ on behalf of \), replies to these messages are delivered to the group, not the sender. +The 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: @@ -1314,9 +1314,9 @@ The sender you specify for this parameter must a mailbox, mail user or mail-enab - SamAccountName - User ID or user principal name (UPN) -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. By default, this parameter is blank, which means no one else has permission to send on behalf of this group. @@ -1405,8 +1405,8 @@ The MailTip parameter specifies the custom MailTip text for this recipient. The When you add a MailTip to a recipient, two things happen: -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \\This mailbox is not monitored\\. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. ```yaml Type: String @@ -1426,11 +1426,11 @@ The MailTipTranslations parameter specifies additional languages for the custom To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: -@{Add="\:\","\:\"...; Remove="\:\","\:\"...} +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. -\ is a valid ISO 639 two-letter culture code that's associated with the language. +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. ```yaml Type: MultiValuedProperty @@ -1550,9 +1550,9 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -1720,9 +1720,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1753,9 +1753,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1788,7 +1788,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. @@ -1917,7 +1917,8 @@ The SimpleDisplayName parameter is used to display an alternative description of - a - z - A - Z - 0 - 9 -- "\", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". +- space +- `" ' ( ) + , - . / : ?` ```yaml Type: String @@ -1935,17 +1936,17 @@ Accept wildcard characters: False ### -UMDtmfMap The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: -- emailAddress:\ -- lastNameFirstName:\ -- firstNameLastName:\ +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\,lastNameFirstName:\,firstNameLastName:\. +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\, all existing lastNameFirstName and firstNameLastName values are removed. +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"; Remove="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"}. +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\","emailAddress:\} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md index 8181a09503..805e598953 100644 --- a/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md @@ -74,7 +74,7 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the alias of the distribution group. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. ```yaml Type: String @@ -135,7 +135,7 @@ The ManagedBy parameter specifies one or more group owners. A group must have at - SamAccountName - User ID or user principal name (UPN) -You can specify multiple owners by using the following syntax: @("\","\"...). The values that you specify will overwrite the current list of owners. +You can specify multiple owners by using the following syntax: `@("Owner1","Owner2",..."OwnerN")`. The values that you specify will overwrite the current list of owners. The users specified with the ManagedBy parameter aren't automatically members of the distribution group. If you want any of the owners to be added as members of the distribution group, you need to add them by using the Update-EOPDistributionGroupMember cmdlet. diff --git a/exchange/exchange-ps/exchange/Set-EOPGroup.md b/exchange/exchange-ps/exchange/Set-EOPGroup.md index 200472bc9b..09b32801d1 100644 --- a/exchange/exchange-ps/exchange/Set-EOPGroup.md +++ b/exchange/exchange-ps/exchange/Set-EOPGroup.md @@ -95,7 +95,7 @@ The ManagedBy parameter specifies a user who owns the group. You can use any val - Email address - GUID -You can specify multiple owners by using the following syntax: @("\","\"...). The values that you specify will overwrite the current list of owners. +You can specify multiple owners by using the following syntax: `@("Owner1","Owner2",..."OwnerN")`. The values that you specify will overwrite the current list of owners. The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. diff --git a/exchange/exchange-ps/exchange/Set-EOPMailUser.md b/exchange/exchange-ps/exchange/Set-EOPMailUser.md index cc56dab7d3..3578b067d2 100644 --- a/exchange/exchange-ps/exchange/Set-EOPMailUser.md +++ b/exchange/exchange-ps/exchange/Set-EOPMailUser.md @@ -77,7 +77,7 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the alias of the mail user. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. ```yaml Type: String @@ -109,7 +109,7 @@ Accept wildcard characters: False ``` ### -EmailAddresses -The EmailAddresses parameter specifies the primary email address and other proxy addresses for the mail user. This parameter uses the syntax SMTP:\,\. +The EmailAddresses parameter specifies the primary email address and other proxy addresses for the mail user. This parameter uses the syntax `SMTP:,`. The values that you specify for this parameter overwrite any existing values. diff --git a/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md index 69606b94b9..001c00c4c1 100644 --- a/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md @@ -69,11 +69,11 @@ This example turns off the Internet access to the EAC on server named Server01. ### -Identity 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 \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. To manage the first ECP virtual directory created in an Exchange organization, you need to use this cmdlet on the computer that includes the first ECP virtual directory. If you create additional ECP virtual directories, you can manage those remotely. @@ -225,7 +225,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -247,9 +247,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md index 306b2dbc56..b71a59f9fa 100644 --- a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md @@ -88,10 +88,10 @@ In on-premises Exchange, this example clears the disabled email address template ### Example 3 ```powershell -Set-EmailAddressPolicy -Identity 'Office 365 Groups' -EnabledEmailAddressTemplates "SMTP:@contoso.com","@contoso.onmicrosoft.com","smtp:@contoso.microsoftonline.com" +Set-EmailAddressPolicy -Identity "Office 365 Groups" -EnabledEmailAddressTemplates "SMTP:@contoso.com","smtp:@contoso.onmicrosoft.com","smtp:@contoso.microsoftonline.com" ``` -In Exchange Online, this example modifies the existing email adress policy named Office 365 Groups by setting the enabled email address templates to "SMTP:@contoso.com", and "@contoso.onmicrosoft.com", and "smtp:@contoso.microsoftonline.com". This will also set the enabled primary SMTP address template to "@contoso.com". +In Exchange Online, this example modifies the existing email adress policy named "Office 365 Groups" and sets the enabled email address templates to use "@contoso.com" as the primary SMTP address and "@contoso.onmicrosoft.com" and "@contoso.microsoftonline.com" as proxy addresses. ## PARAMETERS @@ -122,9 +122,9 @@ The ConditionalCompany parameter specifies a precanned filter that's based on th When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -146,9 +146,9 @@ The ConditionalCustomAttribute1 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -170,9 +170,9 @@ The ConditionalCustomAttribute10 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -194,9 +194,9 @@ The ConditionalCustomAttribute11 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -218,9 +218,9 @@ The ConditionalCustomAttribute12 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -242,9 +242,9 @@ The ConditionalCustomAttribute13 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -266,9 +266,9 @@ The ConditionalCustomAttribute14 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -290,9 +290,9 @@ The ConditionalCustomAttribute15 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -314,9 +314,9 @@ The ConditionalCustomAttribute2 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -338,9 +338,9 @@ The ConditionalCustomAttribute3 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -362,9 +362,9 @@ The ConditionalCustomAttribute4 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -386,9 +386,9 @@ The ConditionalCustomAttribute5 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -410,9 +410,9 @@ The ConditionalCustomAttribute6 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -434,9 +434,9 @@ The ConditionalCustomAttribute7 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -458,9 +458,9 @@ The ConditionalCustomAttribute8 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -482,9 +482,9 @@ The ConditionalCustomAttribute9 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -506,9 +506,9 @@ The ConditionalDepartment parameter specifies a precanned filter that's based on When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -530,9 +530,9 @@ The ConditionalStateOrProvince parameter specifies a precanned filter that's bas When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -571,12 +571,12 @@ This parameter is available only in on-premises Exchange. The DisabledEmailAddressTemplates parameter specifies the proxy email addresses templates that are included in an email address policy, but aren't used to configure the email addresses of recipients. -Valid syntax for this parameter is \:\: +Valid syntax for this parameter is `Type:AddressFormat`: -- \: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. -- \: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: \@contoso.com requires the value %m@contoso.com, and \.\@contoso.com requires the value %g.%s@contoso.com. +- Type: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. +- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. -You can specify multiple disabled email address templates separated by commas: "[\]:\","[\]:\",..."[\]:\". +You can specify multiple disabled email address templates separated by commas: `"[Type1:]EmailAddress1","[Type2:]EmailAddress2",..."[TypeN:]EmailAddressN"`. Typically, this property is only populated by values after a migration from a previous version of Exchange. To clear these values, use the value $null for this parameter. @@ -614,14 +614,14 @@ Accept wildcard characters: False ### -EnabledEmailAddressTemplates The EnabledEmailAddressTemplates parameter specifies the rules in the email address policy that are used to generate email addresses for recipients. -Valid syntax for this parameter is \:\: +Valid syntax for this parameter is `Type:AddressFormat`: -- \: A valid email address type as described in "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. -- \: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: \@contoso.com requires the value %m@contoso.com, and \.\@contoso.com requires the value %g.%s@contoso.com. +- Type: A valid email address type as described in "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. +- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. -This parameter requires at least one template with the \ value SMTP (to define the primary SMTP email address). After that, if you don't include a \ prefix for a template, the value smtp (an SMTP proxy address) is assumed. +This parameter requires at least one template with the Type value SMTP (to define the primary SMTP email address). After that, if you don't include a Type prefix for a template, the value smtp (an SMTP proxy address) is assumed. -You can specify multiple email address templates separated by commas: "SMTP:\","[\]:\","[\]:\",..."[\]:\". +You can specify multiple email address templates separated by commas: `"SMTP:PrimarySMTPEmailAddress","[Type1:]EmailAddress1","[Type2:]EmailAddress2",..."[TypeN:]EmailAddressN"`. You can't use this parameter with the EnabledPrimarySMTPAddressTemplate parameter. @@ -643,7 +643,7 @@ Accept wildcard characters: False ### -EnabledPrimarySMTPAddressTemplate The EnabledPrimarySMTPAddressTemplate parameter specifies the specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. -Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: \@contoso.com requires the value %m@contoso.com, and \.\@contoso.com requires the value %g.%s@contoso.com. +Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. You can't use this parameter with the EnabledEmailAddressTemplates parameter. @@ -726,7 +726,7 @@ The Priority parameter specifies the order that the email address policies are e If you set this parameter to a value that's the same as another email address policy, the priority of the policy that you added first is incremented by 1. -Note: The first email address policy that identifies a recipient configures the recipient's email addresses. All other policies are ignored, even if the first policy is unapplied and can't configure the recipient's email addresses. +**Note**: The first email address policy that identifies a recipient configures the recipient's email addresses. All other policies are ignored, even if the first policy is unapplied and can't configure the recipient's email addresses. ```yaml Type: EmailAddressPolicyPriority diff --git a/exchange/exchange-ps/exchange/Set-EventLogLevel.md b/exchange/exchange-ps/exchange/Set-EventLogLevel.md index 6bbb547cbc..0ef7d9c80e 100644 --- a/exchange/exchange-ps/exchange/Set-EventLogLevel.md +++ b/exchange/exchange-ps/exchange/Set-EventLogLevel.md @@ -39,7 +39,7 @@ 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://docs.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://docs.microsoft.com/powershell/module/exchange/get-eventloglevel). ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Set-ExchangeSettings.md b/exchange/exchange-ps/exchange/Set-ExchangeSettings.md index 8289ca1254..d72aea17f7 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeSettings.md +++ b/exchange/exchange-ps/exchange/Set-ExchangeSettings.md @@ -259,7 +259,7 @@ Accept wildcard characters: False ``` ### -ConfigPairs -The ConfigName parameter specifies the available Exchange setting that you want to add, remove, or update in the Exchange settings object. Valid values for this parameter are determined by the configuration schema that was specified by the Name parameter on the New-ExchangeSettings cmdlet. The syntax for a value is \=\. You can separate multiple values separated by commas. +The ConfigName parameter specifies the available Exchange setting that you want to add, remove, or update in the Exchange settings object. Valid values for this parameter are determined by the configuration schema that was specified by the Name parameter on the New-ExchangeSettings cmdlet. The syntax for a value is `=`. You can separate multiple values separated by commas. You can't use the ConfigPairs parameter with the ConfigName or ConfigValue parameters. diff --git a/exchange/exchange-ps/exchange/Set-ForeignConnector.md b/exchange/exchange-ps/exchange/Set-ForeignConnector.md index c5f60025fd..ba6414cf97 100644 --- a/exchange/exchange-ps/exchange/Set-ForeignConnector.md +++ b/exchange/exchange-ps/exchange/Set-ForeignConnector.md @@ -76,7 +76,7 @@ Accept wildcard characters: False ``` ### -AddressSpaces -The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is as follows: \:\;\ +The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. - AddressSpaceType: The address space type may be SMTP, X400, or any other text string. If you omit the address space type, an SMTP address space type is assumed. - AddressSpace: For SMTP address space types, the address space that you enter must be RFC 1035-compliant. For example, \*, \*.com, and \*.contoso.com are permitted, but \*contoso.com isn't permitted. For X.400 address space types, the address space that you enter must be RFC 1685-compliant, such as o=MySite;p=MyOrg;a=adatum;c=us. For all other values of address type, you can enter any text for the address space. @@ -89,9 +89,9 @@ If you specify the address space type or the address space cost, you must enclos - "SMTP:contoso.com" - contoso.com -You may specify multiple address spaces by separating the address spaces with commas, for example: contoso.com,fabrikam.com. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("), for example: "contoso.com;2","fabrikam.com;3". +You may specify multiple address spaces by separating the address spaces with commas, for example: `contoso.com,fabrikam.com`. If you specify the address space type or the address space cost, you must enclose the address space in quotation marks ("), for example: `"contoso.com;2","fabrikam.com;3"`. -To add or remove one or more address space values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more address space values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -329,9 +329,9 @@ Accept wildcard characters: False ### -SourceTransportServers The SourceTransportServers parameter specifies the names of the Mailbox servers that use this Foreign connector. Having a single Foreign connector homed on multiple Mailbox servers running the Transport service provides fault tolerance and high availability if one of the servers fails. The default value of this parameter is the name of the Mailbox server on which this Foreign connector was first installed. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-GlobalAddressList.md b/exchange/exchange-ps/exchange/Set-GlobalAddressList.md index ae3b43ec92..f3b140c04a 100644 --- a/exchange/exchange-ps/exchange/Set-GlobalAddressList.md +++ b/exchange/exchange-ps/exchange/Set-GlobalAddressList.md @@ -102,9 +102,9 @@ The ConditionalCompany parameter specifies a precanned filter that's based on th When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -124,9 +124,9 @@ The ConditionalCustomAttribute1 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -146,9 +146,9 @@ The ConditionalCustomAttribute10 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -168,9 +168,9 @@ The ConditionalCustomAttribute11 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -190,9 +190,9 @@ The ConditionalCustomAttribute12 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -212,9 +212,9 @@ The ConditionalCustomAttribute13 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -234,9 +234,9 @@ The ConditionalCustomAttribute14 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -256,9 +256,9 @@ The ConditionalCustomAttribute15 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -278,9 +278,9 @@ The ConditionalCustomAttribute2 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -300,9 +300,9 @@ The ConditionalCustomAttribute3 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -322,9 +322,9 @@ The ConditionalCustomAttribute4 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -344,9 +344,9 @@ The ConditionalCustomAttribute5 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -366,9 +366,9 @@ The ConditionalCustomAttribute6 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -388,9 +388,9 @@ The ConditionalCustomAttribute7 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -410,9 +410,9 @@ The ConditionalCustomAttribute8 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -432,9 +432,9 @@ The ConditionalCustomAttribute9 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -454,9 +454,9 @@ The ConditionalDepartment parameter specifies a precanned filter that's based on When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -476,9 +476,9 @@ The ConditionalStateOrProvince parameter specifies a precanned filter that's bas When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-Group.md b/exchange/exchange-ps/exchange/Set-Group.md index c6c983c374..3f4ad401cb 100644 --- a/exchange/exchange-ps/exchange/Set-Group.md +++ b/exchange/exchange-ps/exchange/Set-Group.md @@ -227,9 +227,9 @@ The owner you specify for this parameter must be a mailbox, mail user or mail-en - SamAccountName - User ID or user principal name (UPN) -To enter multiple owners and overwrite all existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple owners and overwrite all existing entries, use the following syntax: `Owner1,Owner2,...OwnerN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Owner1","Owner2",..."OwnerN"`. -To add or remove owners without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove owners without affecting other existing entries, use the following syntax: `@{Add="Owner1","Owner2",...; Remove="Owner3","Owner4"...}`. An owner that you specify with this parameter isn't automatically a member of the group. You need to manually add the owner as a member. @@ -316,7 +316,8 @@ The SimpleDisplayName parameter is used to display an alternative description of - a - z - A - Z - 0 - 9 -- "\", """, "'", "(", ")", "+", ",", "-", ".", "/", ":" and "?". +- space +- `" ' ( ) + , - . / : ?` This parameter is meaningful only if the group is mail-enabled. diff --git a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md index 0c22d632c2..ace70feb62 100644 --- a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md @@ -16,7 +16,7 @@ This cmdlet is available only in Security & Compliance Center PowerShell. For mo Use the Set-HoldCompliancePolicy cmdlet to modify existing preservation policies in the Security & Compliance Center. -Note: The Set-HoldCompliancePolicy cmdlet has been replaced by the Set-RetentionCompliancePolicy cmdlet. If you have scripts that use Set-HoldCompliancePolicy, update them to use Set-RetentionCompliancePolicy. +**Note**: The Set-HoldCompliancePolicy cmdlet has been replaced by the Set-RetentionCompliancePolicy cmdlet. If you have scripts that use Set-HoldCompliancePolicy, update them to use Set-RetentionCompliancePolicy. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -88,7 +88,11 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. +The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. + +Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. + +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. ```yaml Type: SwitchParameter @@ -116,7 +120,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -150,7 +154,7 @@ Accept wildcard characters: False ### -AddSharePointLocation The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to the policy until they have been indexed. @@ -250,7 +254,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -284,7 +288,7 @@ Accept wildcard characters: False ### -RemoveSharePointLocation The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md index b422bc4b75..2a11150606 100644 --- a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md @@ -16,7 +16,7 @@ This cmdlet is available only in Security & Compliance Center PowerShell. For mo Use the Set-HoldComplianceRule cmdlet to modify existing preservation rules in the Security & Compliance Center. -Note: The Set-HoldComplianceRule cmdlet has been replaced by the Set-RetentionComplianceRule cmdlet. If you have scripts that use Set-HoldComplianceRule, update them to use Set-RetentionComplianceRule. +**Note**: The Set-HoldComplianceRule cmdlet has been replaced by the Set-RetentionComplianceRule cmdlet. If you have scripts that use Set-HoldComplianceRule, update them to use Set-RetentionComplianceRule. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md index 6b58814a85..eb429a447f 100644 --- a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md @@ -52,7 +52,7 @@ This example modifies the connection filter policy named Default with the follow ### Example 2 ```powershell -Set-HostedConnectionFilterPolicy "Default" -IPAllowList @{Add="192.168.2.10","192.169.3.0/24","192.168.4.1-192.168.4.5";Remove="192.168.1.10"} +Set-HostedConnectionFilterPolicy "Default" -IPAllowList @{Add="192.168.2.10","192.169.3.0/24","192.168.4.1-192.168.4.5"; Remove="192.168.1.10"} ``` This example modifies the connection filter policy named Default with the following settings: @@ -164,7 +164,7 @@ You enter the IP addresses using the following syntax: - IP range: You can use an IP address range, for example, 192.168.0.1-192.168.0.254. - CIDR IP: You can use Classless InterDomain Routing (CIDR), for example, 192.168.0.1/25. Valid network mask values are /24 through /32. -You can specify multiple IP addresses of the same type separated by commas. For example, \, \ or \, \. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: @{Add="\","\",\...}. +You can specify multiple IP addresses of the same type separated by commas. For example, `SingleIP1, SingleIP2,...SingleIPN` or `CIDRIP1,CIDRIP2,...CIDRIPN`. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: `@{Add="SingleIP1","IPRange1","CIDRIP1",...}`. ```yaml Type: MultiValuedProperty @@ -188,7 +188,7 @@ You enter the IP addresses using the following syntax: - IP range: You can use an IP address range, for example, 192.168.0.1-192.168.0.254. - CIDR IP: You can use Classless InterDomain Routing (CIDR), for example, 192.168.0.1/25. Valid network mask values are /24 through /32. -You can specify multiple IP addresses of the same type separated by commas. For example, \, \ or \, \. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: @{Add="\","\",\...}. +You can specify multiple IP addresses of the same type separated by commas. For example, `SingleIP1, SingleIP2,...SingleIPN` or `CIDRIP1,CIDRIP2,...CIDRIPN`. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: `@{Add="SingleIP1","IPRange1","CIDRIP1",...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md index ec68fb2ecc..486e24e548 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterPolicy.md @@ -75,7 +75,6 @@ Set-HostedContentFilterPolicy [-Identity] [-TestModeAction ] [-TestModeBccToRecipients ] [-WhatIf] - [-ZapEnabled ] [] ``` @@ -168,9 +167,9 @@ The AllowedSenderDomains parameter specifies trusted domains that aren't process **Caution**: Think very carefully before you add domains here. For more information, see [Create safe sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -190,9 +189,9 @@ The AllowedSenders parameter specifies a list of trusted senders that skip spam **Caution**: Think very carefully before you add senders here. For more information, see [Create safe sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -212,9 +211,9 @@ The BlockedSenderDomains parameter specifies domains that are always marked as s **Note**: Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -234,9 +233,9 @@ The BlockedSenders parameter specifies senders that are always marked as spam so **Note**: Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -651,9 +650,9 @@ af, ar, az, be, bg, bn, br, bs, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, A reference for two-letter language codes is available at [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/code_list.php). Note that not all possible language codes are available as input for this parameter. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. +To enter multiple values and overwrite any existing entries, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. To empty the list, use the value $null. @@ -1023,7 +1022,7 @@ The QuarantineRetentionPeriod parameter specifies the number of days that spam m - PhishSpamAction - SpamAction -A valid value is an integer between 1 and 30. The default value is 30. +A valid value is an integer between 1 and 30. After the time period expires, the message is deleted. @@ -1070,9 +1069,9 @@ AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. To empty the list, use the value $null. @@ -1193,22 +1192,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ZapEnabled -This parameter has been deprecated and is no longer used. Use the PhishZapEnabled and SpamZapEnabled parameters instead. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md index 9a6f852eea..9bf8835e56 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md @@ -134,7 +134,7 @@ The ExceptIfSentTo parameter specifies an exception for the rule that looks for - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -159,7 +159,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception for the rule that lo - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. @@ -199,7 +199,7 @@ Accept wildcard characters: False ### -Name The Name parameter specifies a unique name for the spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). -Don't use the following characters in the name value: \\, %, &, \*, +, /, =, ?, {, }, \|, \<, \>, (, ), ;, :, [, ], comma (,), or double quotation mark ("). +Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. ```yaml Type: String @@ -264,7 +264,7 @@ The SentTo parameter specifies a condition for the rule that looks for recipient - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -289,7 +289,7 @@ The SentToMemberOf parameter specifies a condition for the rule that looks for m - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. diff --git a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md index 981f82fe1f..3199724d99 100644 --- a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterRule.md @@ -118,7 +118,7 @@ The ExceptIfFrom parameter specifies an exception that looks for messages from s - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -143,7 +143,7 @@ The ExceptIfFromMemberOf parameter specifies an exception that looks for message - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -184,7 +184,7 @@ The From parameter specifies a condition that looks for messages from specific s - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -209,7 +209,7 @@ The FromMemberOf parameter specifies a condition that looks for messages sent by - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -251,7 +251,7 @@ Accept wildcard characters: False ### -Name The Name parameter specifies a unique name for the outbound spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). -The value itself can't contain the following characters: \\, %, &, \*, +, /, =, ?, {, }, \|, \<, \>, (, ), ;, :, [, ], comma (,), or double quotation mark ("). +Don't use the following characters: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-HybridConfiguration.md b/exchange/exchange-ps/exchange/Set-HybridConfiguration.md index 9be50173de..0117626a40 100644 --- a/exchange/exchange-ps/exchange/Set-HybridConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-HybridConfiguration.md @@ -290,7 +290,7 @@ Accept wildcard characters: False ``` ### -TlsCertificateName -The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is "\X.500Issuer\X.500Subject". The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command $TLSCert = Get-ExchangeCertificate -Thumbprint \, run the command $TLSCertName = "\$($TLSCert.Issuer)\$($TLSCert.Subject)", and then use the value $TLSCertName for this parameter. +The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md index af97ba1ea1..8e1f5de821 100644 --- a/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md +++ b/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md @@ -164,9 +164,9 @@ Accept wildcard characters: False ### -IPAddressesMatch The IPAddressesMatch parameter specifies the IP address status codes that are returned by the allow list provider. Use this parameter if the allow list provider returns IP address or A record responses. Valid input for this parameter one or more IP addresses in the format 127.0.0.1. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md index ff69fa0c6d..ae08074fee 100644 --- a/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md +++ b/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md @@ -165,9 +165,9 @@ Accept wildcard characters: False ### -IPAddressesMatch The IPAddressesMatch parameter specifies the IP address status codes that are returned by the block list provider. Use this parameter if the block list provider returns IP address or A record responses. Valid input for this parameter one or more IP addresses in the format 127.0.0.1. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md b/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md index de992c3b4a..8b217dbd7e 100644 --- a/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md +++ b/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md @@ -60,9 +60,9 @@ This example makes the following changes to the list of bypassed recipients: ### -BypassedRecipients The BypassedRecipients parameter specifies the email addresses of internal recipients that are exempted from filtering by IP Block list providers. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-ImapSettings.md b/exchange/exchange-ps/exchange/Set-ImapSettings.md index 7b00aacc69..b706cb2fba 100644 --- a/exchange/exchange-ps/exchange/Set-ImapSettings.md +++ b/exchange/exchange-ps/exchange/Set-ImapSettings.md @@ -279,13 +279,13 @@ Accept wildcard characters: False ### -ExternalConnectionSettings The ExternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by external IMAP4 clients (IMAP4 connections from outside your corporate network). -This parameter uses the syntax \:\:[\]. The encryption method value is optional (blank indicates unencrypted connections). +This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). The default value is blank ($null), which means no external IMAP4 connection settings are configured. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The combination of encryption methods and ports that are specified for this parameter need to match the corresponding encryption methods and ports that are specified by the SSLBindings and UnencryptedOrTLSBindings parameters. @@ -305,13 +305,13 @@ Accept wildcard characters: False ### -InternalConnectionSettings The InternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by internal IMAP4 clients (IMAP4 connections from inside your corporate network). This setting is also used when a IMAP4 connection is forwarded to another Exchange server that's running the Microsoft Exchange IMAP4 service. -This parameter uses the syntax \:\:[\]. The encryption method value is optional (blank indicates unencrypted connections). +This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). -The default value is \:993:SSL,\:143:TLS. +The default value is `:993:SSL,:143:TLS`. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The combination of encryption methods and ports that are specified for this parameter need to match the corresponding encryption methods and ports that are specified by the SSLBindings and UnencryptedOrTLSBindings parameters. @@ -621,13 +621,13 @@ Accept wildcard characters: False ``` ### -SSLBindings -The SSLBindings parameter specifies the IP address and TCP port that's used for IMAP4 connection that's always encrypted by SSL/TLS. This parameter uses the syntax \:\. +The SSLBindings parameter specifies the IP address and TCP port that's used for IMAP4 connection that's always encrypted by SSL/TLS. This parameter uses the syntax `IPv4OrIPv6Address:Port`. -The default value is [::]:993,0.0.0.0:993. +The default value is `[::]:993,0.0.0.0:993`. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -662,13 +662,13 @@ Accept wildcard characters: False ``` ### -UnencryptedOrTLSBindings -The UnencryptedOrTLSBindings parameter specifies the IP address and TCP port that's used for unencrypted IMAP4 connections, or IMAP4 connections that are encrypted by using opportunistic TLS (STARTTLS) after the initial unencrypted protocol handshake. This parameter uses the syntax \:\. +The UnencryptedOrTLSBindings parameter specifies the IP address and TCP port that's used for unencrypted IMAP4 connections, or IMAP4 connections that are encrypted by using opportunistic TLS (STARTTLS) after the initial unencrypted protocol handshake. This parameter uses the syntax `IPv4OrIPv6Address:Port`. -The default value is [::]:143,0.0.0.0:143. +The default value is `[::]:143,0.0.0.0:143`. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-InboundConnector.md b/exchange/exchange-ps/exchange/Set-InboundConnector.md index 4bd3f89683..1c77475c75 100644 --- a/exchange/exchange-ps/exchange/Set-InboundConnector.md +++ b/exchange/exchange-ps/exchange/Set-InboundConnector.md @@ -102,7 +102,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. diff --git a/exchange/exchange-ps/exchange/Set-InboxRule.md b/exchange/exchange-ps/exchange/Set-InboxRule.md index 8e579ee41e..e328d1fb58 100644 --- a/exchange/exchange-ps/exchange/Set-InboxRule.md +++ b/exchange/exchange-ps/exchange/Set-InboxRule.md @@ -118,8 +118,8 @@ The Identity parameter specifies the Inbox rule that you want to modify. You can - Name - RuleIdentity property (for example, 16752869479666417665). -- Exchange Online: `\` (for example, `rzaher\16752869479666417665`. -- On-premises Exchange: `\` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). +- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). +- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). ```yaml Type: InboxRuleIdParameter @@ -196,9 +196,9 @@ The ApplySystemCategory parameter specifies an action for the Inbox rule that ap - Travel - Video -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -216,9 +216,9 @@ Accept wildcard characters: False ### -BodyContainsWords The BodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding exception parameter to this condition is ExceptIfBodyContainsWords. @@ -368,9 +368,9 @@ Accept wildcard characters: False ### -ExceptIfBodyContainsWords The ExceptIfBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding condition parameter to this exception is BodyContainsWords. @@ -427,7 +427,7 @@ The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. The corresponding condition parameter to this exception is From. @@ -447,9 +447,9 @@ Accept wildcard characters: False ### -ExceptIfFromAddressContainsWords The ExceptIfFromAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in the sender's email address. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding condition parameter to this exception is FromAddressContainsWords. @@ -528,9 +528,9 @@ Accept wildcard characters: False ### -ExceptIfHeaderContainsWords The HeaderContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the header fields of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding condition parameter to this exception is HeaderContainsWords. @@ -704,9 +704,9 @@ Accept wildcard characters: False ### -ExceptIfRecipientAddressContainsWords The ExceptIfRecipientAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in recipient email addresses. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding condition parameter to this exception is RecipientAddressContainsWords. @@ -754,7 +754,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. The corresponding condition parameter to this exception is SentTo. @@ -774,9 +774,9 @@ Accept wildcard characters: False ### -ExceptIfSubjectContainsWords The ExceptIfSubjectContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding condition parameter to this exception is SubjectContainsWords. @@ -796,9 +796,9 @@ Accept wildcard characters: False ### -ExceptIfSubjectOrBodyContainsWords The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding condition parameter to this exception is ExceptIfSubjectOrBodyContainsWords. @@ -976,7 +976,7 @@ The ForwardAsAttachmentTo parameter specifies an action for the Inbox rule that - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1001,7 +1001,7 @@ The ForwardTo parameter specifies an action for the Inbox rule that forwards the - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1026,7 +1026,7 @@ The From parameter specifies a condition for the Inbox rule that looks for the s - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. The corresponding exception parameter to this condition is ExceptIfFrom. @@ -1046,9 +1046,9 @@ Accept wildcard characters: False ### -FromAddressContainsWords The FromAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in the sender's email address. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding exception parameter to this condition is ExceptIfFromAddressContainsWords. @@ -1127,9 +1127,9 @@ Accept wildcard characters: False ### -HeaderContainsWords The HeaderContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the header fields of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding exception parameter to this condition is ExceptIfHeaderContainsWords. @@ -1451,9 +1451,9 @@ Accept wildcard characters: False ### -RecipientAddressContainsWords The RecipientAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in recipient email addresses. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding exception parameter to this condition is ExceptIfRecipientAddressContainsWords. @@ -1480,7 +1480,7 @@ The RedirectTo parameter specifies an action for the Inbox rule that redirects t - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1498,9 +1498,9 @@ Accept wildcard characters: False ### -SendTextMessageNotificationTo The SendTextMessageNotificationTo parameter specifies an action for the Inbox rule that send a text message notification to the specified telephone number. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -1546,7 +1546,7 @@ The SentTo parameter specifies a condition for the Inbox rule that looks for mes - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. The corresponding exception parameter to this condition is ExceptIfSentTo. @@ -1585,9 +1585,9 @@ Accept wildcard characters: False ### -SubjectContainsWords The SubjectContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding exception parameter to this condition is ExceptIfSubjectContainsWords. @@ -1607,9 +1607,9 @@ Accept wildcard characters: False ### -SubjectOrBodyContainsWords The SubjectOrBodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The corresponding exception parameter to this condition is ExceptIfSubjectOrBodyContainsWords. diff --git a/exchange/exchange-ps/exchange/Set-Label.md b/exchange/exchange-ps/exchange/Set-Label.md index 708a8249e3..bb17d83142 100644 --- a/exchange/exchange-ps/exchange/Set-Label.md +++ b/exchange/exchange-ps/exchange/Set-Label.md @@ -43,9 +43,11 @@ Set-Label [-Identity] [-ApplyWaterMarkingFontSize ] [-ApplyWaterMarkingLayout ] [-ApplyWaterMarkingText ] + [-ColumnAssetCondition ] [-Comment ] [-Conditions ] [-Confirm] + [-ContentType ] [-DisplayName ] [-EncryptionContentExpiredOnDateInDaysOrNever ] [-EncryptionDoNotForward ] @@ -66,6 +68,15 @@ Set-Label [-Identity] [-Priority ] [-Setting ] [-Settings ] + [-SiteAndGroupProtectionAllowAccessToGuestUsers ] + [-SiteAndGroupProtectionAllowEmailFromGuestUsers ] + [-SiteAndGroupProtectionAllowFullAccess ] + [-SiteAndGroupProtectionAllowLimitedAccess ] + [-SiteAndGroupProtectionBlockAccess ] + [-SiteAndGroupProtectionEnabled ] + [-SiteAndGroupProtectionPrivacy ] + [-SiteExternalSharingControlType ] + [-SqlAssetCondition ] [-Tooltip ] [-WhatIf] [] @@ -113,7 +124,7 @@ Accept wildcard characters: False ``` ### -AdvancedSettings -The AdvancedSettings parameter enables client-specific features and capabilities on the sensitivity label. The settings that you configure with this parameter only affect apps that are designed for the setting. For more information, see [How to configure advanced settings for the client by using Security & Compliance Center PowerShell](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations#how-to-configure-advanced-settings-for-the-client-by-using-office-365-security--compliance-center-powershell). +The AdvancedSettings parameter enables client-specific features and capabilities for a sensitivity label. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see [Custom configurations for the Azure Information Protection unified labeling client](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). ```yaml Type: PswsHashtable @@ -502,6 +513,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ColumnAssetCondition +{{ Fill ColumnAssetCondition Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Comment The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". @@ -553,6 +580,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContentType +{{ Fill ContentType Description }} + +```yaml +Type: MipLabelContentType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Disabled The Disabled parameter specifies whether to enable or disable the sensitivity label. Valid values are: @@ -1076,6 +1119,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SiteExternalSharingControlType +{{ Fill SiteExternalSharingControlType Description }} + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlAssetCondition +{{ Fill SqlAssetCondition Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tooltip The ToolTip parameter specifies the default tooltip and sensitivity label description that's seen by users. It the value contains spaces, enclose the value in quotation marks ("). diff --git a/exchange/exchange-ps/exchange/Set-LabelPolicy.md b/exchange/exchange-ps/exchange/Set-LabelPolicy.md index d86c5af136..a62b080b92 100644 --- a/exchange/exchange-ps/exchange/Set-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-LabelPolicy.md @@ -92,6 +92,8 @@ The RetryDistribution switch specifies whether to redistribute the policy to all Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. + ```yaml Type: SwitchParameter Parameter Sets: RetryDistribution @@ -115,7 +117,7 @@ To specify the mailbox, you can use any value that uniquely identifies it. For e - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -140,7 +142,7 @@ To specify the mailbox, you can use any value that uniquely identifies it. For e - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -162,7 +164,7 @@ The AddLabels parameter specifies the sensitivity labels that you want to add to - Distinguished name (DN) - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -180,7 +182,7 @@ Accept wildcard characters: False ### -AddModernGroupLocation The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups. To identify the Microsoft 365 Group, you must use the primary SMTP address. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -212,7 +214,7 @@ Accept wildcard characters: False ``` ### -AdvancedSettings -The AdvancedSettings parameter enables client-specific features and capabilities on the sensitivity label policy. The settings that you configure with this parameter only affect apps that are designed for the setting. For more information, see [How to configure advanced settings for the client by using Security & Compliance Center PowerShell](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations#how-to-configure-advanced-settings-for-the-client-by-using-office-365-security--compliance-center-powershell). +The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see [Custom configurations for the Azure Information Protection unified labeling client](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). ```yaml Type: PswsHashtable @@ -339,7 +341,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -367,7 +369,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -389,7 +391,7 @@ The RemoveLabels parameter specifies the sensitivity labels that you want to rem - Distinguished name (DN) - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -407,7 +409,7 @@ Accept wildcard characters: False ### -RemoveModernGroupLocation The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups. To identify the Microsoft 365 Group, you must use the primary SMTP address. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-LinkedUser.md b/exchange/exchange-ps/exchange/Set-LinkedUser.md index c73ace5ce1..be11449d2f 100644 --- a/exchange/exchange-ps/exchange/Set-LinkedUser.md +++ b/exchange/exchange-ps/exchange/Set-LinkedUser.md @@ -66,7 +66,7 @@ Accept wildcard characters: False ``` ### -CertificateSubject -The CertificateSubject parameter specifies the value of the subject field of the user's digital certificate. The syntax of the CertificateSubject value is X509:\Issuer\Subject. The values of Issuer and Subject are required and must be in X.500 format. To remove the value of CertificateSubject, specify the value $null. +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 diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md new file mode 100644 index 0000000000..d1a563e69a --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md @@ -0,0 +1,237 @@ +--- +external help file: Microsoft.Exchange.WebClient-Help.xml +online version: https://docs.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicy +applicable: Exchange Online +title: Set-M365DataAtRestEncryptionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-M365DataAtRestEncryptionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-M365DataAtRestEncryptionPolicy cmdlet to modify Microsoft 365 data-at-rest encryption policies in Exchange Online. + +**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### TenantAdminPurgeKeyRequest +``` +Set-M365DataAtRestEncryptionPolicy [-Identity] [-Confirm] + [-Description ] + [-DomainController ] + [-Enabled ] + [-Force] + [-Name ] + [-WhatIf] + [] +``` + +### RefreshKey +``` +Set-M365DataAtRestEncryptionPolicy [-Identity] [-Confirm] + [-Description ] + [-DomainController ] + [-Enabled ] + [-Name ] + [-Refresh] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-M365DataAtRestEncryptionPolicy -Identity "Tenant Default Policy" -Enabled $false +``` + +This example disabled the Microsoft 365 data-at-rest encryption policy named Tenant Default Policy. + +### Example 2 +```powershell +Set-M365DataAtRestEncryptionPolicy -Identity "Tenant Default Policy" -Refresh +``` + +This example updates the Microsoft 365 data-at-rest encryption policy named Tenant Default Policy after one of the associated keys has been rotated in the Azure Key Vault. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the data-at-rest encryption policy that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The Description parameter specifies an optional description for the policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the policy is enabled or disabled. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: DCAdminPurgeKeyRequest, TenantAdminPurgeKeyRequest +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the Microsoft 365 data-at-rest encryption policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Refresh +Use the Refresh switch to update the Microsoft 365 data-at-rest encryption policy in Exchange Online after you rotate any of the associated keys in the Azure Key Vault. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: RefreshKey +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### + +## OUTPUTS + +### + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md new file mode 100644 index 0000000000..0f7966bcbc --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md @@ -0,0 +1,76 @@ +--- +external help file: Microsoft.Exchange.WebClient-Help.xml +online version: https://docs.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicyassignment +applicable: Exchange Online +title: Set-M365DataAtRestEncryptionPolicyAssignment +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-M365DataAtRestEncryptionPolicyAssignment + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-M365DataAtRestEncryptionPolicyAssignment cmdlet to assign a Microsoft 365 data-at-rest encryption policy at the tenant level. + +**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-M365DataAtRestEncryptionPolicyAssignment -DataEncryptionPolicy [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-M365DataAtRestEncryptionPolicyAssignment -DataEncryptionPolicy "Contoso Corporate" +``` + +This example assigns the Microsoft 365 data-at-rest encryption policy named Contoso Corporate. + +## PARAMETERS + +### -DataEncryptionPolicy +The DataEncryptionPolicy parameter specifies the Microsoft 365 data-at-rest encryption policy. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### + +## OUTPUTS + +### + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailContact.md b/exchange/exchange-ps/exchange/Set-MailContact.md index 23616ec10d..f3689f106f 100644 --- a/exchange/exchange-ps/exchange/Set-MailContact.md +++ b/exchange/exchange-ps/exchange/Set-MailContact.md @@ -138,9 +138,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -171,9 +171,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -206,7 +206,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. @@ -230,9 +230,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -297,9 +297,9 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -To enter multiple senders and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. @@ -631,26 +631,26 @@ Accept wildcard characters: False ### -EmailAddresses The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is \:\,\:\,...\:\. The optional \ value specifies the type of email address. Some examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a \ value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: -- Use the \ value SMTP on the address. -- The first email address when you don't use any \ values, or when you use multiple \ values of smtp. +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. - Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\:\","\:\",..."\:\". +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\:\","\:\",...; Remove="\:\","\:\",...}. +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. ```yaml Type: ProxyAddressCollection @@ -689,9 +689,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute1 This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -711,9 +711,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute2 This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -733,9 +733,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute3 This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -755,9 +755,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute4 This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -777,9 +777,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute5 This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -833,7 +833,7 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo -The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mail contact. Although messages sent on behalf of the mail contact clearly show the sender in the From field (\ on behalf of \), replies to these messages are delivered to the mail contact, not the sender. +The 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: @@ -848,9 +848,9 @@ The sender you specify for this parameter must a mailbox, mail user or mail-enab - SamAccountName - User ID or user principal name (UPN) -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. By default, this parameter is blank, which means no one else has permission to send on behalf of this mail contact. @@ -940,8 +940,8 @@ The MailTip parameter specifies the custom MailTip text for this recipient. The When you add a MailTip to a recipient, two things happen: -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \\This mailbox is not monitored\\. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. ```yaml Type: String @@ -961,11 +961,11 @@ The MailTipTranslations parameter specifies additional languages for the custom To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: -@{Add="\:\","\:\"...; Remove="\:\","\:\"...} +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. -\ is a valid ISO 639 two-letter culture code that's associated with the language. +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. ```yaml Type: MultiValuedProperty @@ -1129,9 +1129,9 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -1221,9 +1221,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1254,9 +1254,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1289,7 +1289,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. @@ -1429,7 +1429,8 @@ The SimpleDisplayName parameter is used to display an alternative description of - a - z - A - Z - 0 - 9 -- "\", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". +- space +- `" ' ( ) + , - . / : ?` ```yaml Type: String @@ -1447,17 +1448,17 @@ Accept wildcard characters: False ### -UMDtmfMap The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: -- emailAddress:\ -- lastNameFirstName:\ -- firstNameLastName:\ +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\,lastNameFirstName:\,firstNameLastName:\. +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\, all existing lastNameFirstName and firstNameLastName values are removed. +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"; Remove="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"}. +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\","emailAddress:\} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md b/exchange/exchange-ps/exchange/Set-MailPublicFolder.md index 99a525403a..171631d5c8 100644 --- a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md +++ b/exchange/exchange-ps/exchange/Set-MailPublicFolder.md @@ -149,9 +149,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -182,9 +182,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -217,7 +217,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. @@ -241,9 +241,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -308,9 +308,9 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -To enter multiple senders and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. @@ -358,7 +358,7 @@ Valid values for this parameter are recipients in your organization. You can use - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -687,26 +687,26 @@ Accept wildcard characters: False ### -EmailAddresses The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is \:\,\:\,...\:\. The optional \ value specifies the type of email address. Some examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a \ value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: -- Use the \ value SMTP on the address. -- The first email address when you don't use any \ values, or when you use multiple \ values of smtp. +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. - Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\:\","\:\",..."\:\". +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\:\","\:\",...; Remove="\:\","\:\",...}. +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. ```yaml Type: ProxyAddressCollection @@ -759,9 +759,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute1 This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -781,9 +781,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute2 This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -803,9 +803,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute3 This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -825,9 +825,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute4 This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -847,9 +847,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute5 This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -913,7 +913,7 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo -The GrantSendOnBehalfTo parameter specifies who can send on behalf of this public folder. Although messages sent on behalf of the mail user clearly show the sender in the From field (\ on behalf of \), replies to these messages are delivered to the public folder, not the sender. +The 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: @@ -928,9 +928,9 @@ The sender you specify for this parameter must a mailbox, mail user or mail-enab - SamAccountName - User ID or user principal name (UPN) -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. By default, this parameter is blank, which means no one else has permission to send on behalf of this public folder. @@ -1011,8 +1011,8 @@ The MailTip parameter specifies the custom MailTip text for this recipient. The When you add a MailTip to a recipient, two things happen: -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \\This mailbox is not monitored\\. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. ```yaml Type: String @@ -1032,11 +1032,11 @@ The MailTipTranslations parameter specifies additional languages for the custom To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: -@{Add="\:\","\:\"...; Remove="\:\","\:\"...} +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. -\ is a valid ISO 639 two-letter culture code that's associated with the language. +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. ```yaml Type: MultiValuedProperty @@ -1119,9 +1119,9 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -1260,9 +1260,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1293,9 +1293,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1328,7 +1328,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. @@ -1419,7 +1419,8 @@ The SimpleDisplayName parameter is used to display an alternative description of - a - z - A - Z - 0 - 9 -- "\", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". +- space +- `" ' ( ) + , - . / : ?` ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-MailUser.md b/exchange/exchange-ps/exchange/Set-MailUser.md index a8859bc25f..482ec29cd4 100644 --- a/exchange/exchange-ps/exchange/Set-MailUser.md +++ b/exchange/exchange-ps/exchange/Set-MailUser.md @@ -157,9 +157,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -190,9 +190,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -225,7 +225,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. @@ -249,9 +249,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -352,9 +352,9 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -To enter multiple senders and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. @@ -710,26 +710,26 @@ Accept wildcard characters: False ### -EmailAddresses The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is \:\,\:\,...\:\. The optional \ value specifies the type of email address. Some examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a \ value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: -- Use the \ value SMTP on the address. -- The first email address when you don't use any \ values, or when you use multiple \ values of smtp. +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. - Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\:\","\:\",..."\:\". +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\:\","\:\",...; Remove="\:\","\:\",...}. +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. ```yaml Type: ProxyAddressCollection @@ -784,9 +784,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute1 This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -806,9 +806,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute2 This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -828,9 +828,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute3 This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -850,9 +850,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute4 This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -872,9 +872,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute5 This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -946,7 +946,7 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo -The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mail user. Although messages sent on behalf of the mail user clearly show the sender in the From field (\ on behalf of \), replies to these messages are delivered to the mail user, not the sender. +The 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: @@ -961,9 +961,9 @@ The sender you specify for this parameter must a mailbox, mail user or mail-enab - SamAccountName - User ID or user principal name (UPN) -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. By default, this parameter is blank, which means no one else has permission to send on behalf of this mail user. @@ -1107,8 +1107,8 @@ The MailTip parameter specifies the custom MailTip text for this recipient. The When you add a MailTip to a recipient, two things happen: -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \\This mailbox is not monitored\\. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. ```yaml Type: String @@ -1128,11 +1128,11 @@ The MailTipTranslations parameter specifies additional languages for the custom To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: -@{Add="\:\","\:\"...; Remove="\:\","\:\"...} +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. -\ is a valid ISO 639 two-letter culture code that's associated with the language. +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. ```yaml Type: MultiValuedProperty @@ -1286,9 +1286,9 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -1486,9 +1486,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1519,9 +1519,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1554,7 +1554,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. @@ -1678,7 +1678,7 @@ Accept wildcard characters: False ### -SamAccountName This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String @@ -1753,7 +1753,8 @@ The SimpleDisplayName parameter is used to display an alternative description of - a - z - A - Z - 0 - 9 -- "\", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". +- space +- `" ' ( ) + , - . / : ?` ```yaml Type: String @@ -1789,17 +1790,17 @@ Accept wildcard characters: False ### -UMDtmfMap The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: -- emailAddress:\ -- lastNameFirstName:\ -- firstNameLastName:\ +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\,lastNameFirstName:\,firstNameLastName:\. +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\, all existing lastNameFirstName and firstNameLastName values are removed. +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"; Remove="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"}. +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\","emailAddress:\} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. ```yaml Type: MultiValuedProperty @@ -1890,7 +1891,7 @@ Accept wildcard characters: False ### -UserPrincipalName This parameter is available only in on-premises Exchange. -The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format \@\. Typically, the \ value is the domain where the user account resides. +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 diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index 0c582b3bf5..ed520c2544 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -1100,14 +1100,16 @@ This example sets the MailTip translation in French and Chinese. ### Example 5 ```powershell -$password = Read-Host "Enter password" -AsSecureString; Set-Mailbox florencef -Password $password -ResetPasswordOnNextLogon $true +$password = Read-Host "Enter password" -AsSecureString +Set-Mailbox florencef -Password $password -ResetPasswordOnNextLogon $true ``` In on-premises Exchange, this example resets the password for Florence Flipo's mailbox. The next time she signs in to her mailbox, she'll have to change her password. ### Example 6 ```powershell -Set-Mailbox -Arbitration -Identity "SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}" -MessageTracking $false; Set-Mailbox -Arbitration -Identity "SystemMailbox{1f05a927-b864-48a7-984d-95b1adfbfe2d}" -MessageTracking $true +Set-Mailbox -Arbitration -Identity "SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}" -MessageTracking $false +Set-Mailbox -Arbitration -Identity "SystemMailbox{1f05a927-b864-48a7-984d-95b1adfbfe2d}" -MessageTracking $true ``` This example removes the message tracking organization capability from the arbitration mailbox named SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c} and assigns it to an arbitration mailbox named SystemMailbox{1f05a927-b864-48a7-984d-95b1adfbfe2d}. @@ -1167,9 +1169,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -1200,9 +1202,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -1235,7 +1237,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. @@ -1302,9 +1304,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -1461,7 +1463,7 @@ Accept wildcard characters: False ### -ArchiveName The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook and Outlook Web App. -If you don't use this parameter, the default value is In-Place Archive - \. +If you don't use this parameter, the default value is `In-Place Archive - `. ```yaml Type: MultiValuedProperty @@ -1592,9 +1594,9 @@ The AuditAdmin parameter specifies the mailbox operations to log for administrat - UpdateCalendarDelegation (Available only in Exchange 2019 and the cloud-based service; enabled by default.) - UpdateInboxRules (Available only in Exchange 2019 and the cloud-based service; enabled by default.) -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The AuditEnabled parameter must be set to $true to enable mailbox audit logging. @@ -1632,9 +1634,9 @@ The AuditDelegate parameter specifies the mailbox operations to log for delegate - UpdateFolderPermissions (Available only in Exchange 2019 and the cloud-based service; enabled by default.) - UpdateInboxRules (Available only in Exchange 2019 and the cloud-based service; enabled by default.) -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The AuditEnabled parameter must be set to $true to enable mailbox audit logging. @@ -1736,9 +1738,9 @@ The AuditOwner parameter specifies the mailbox operations to log for mailbox own - UpdateCalendarDelegation (Available only in the cloud-based service; enabled by default.) - UpdateInboxRules (Available only in the cloud-based service; enabled by default.) -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The AuditEnabled parameter must be set to $true to enable mailbox audit logging. @@ -1789,9 +1791,9 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -To enter multiple senders and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. @@ -2377,7 +2379,7 @@ This parameter is available only in on-premises Exchange. The DumpsterMessagesPerFolderCountReceiveQuota parameter specifies the maximum number of messages that can be contained in each folder in the Recoverable Items folder (called the dumpster in previous versions of Exchange). When a folder exceeds this limit, it can't store new messages. For example, if the Deletions folder in the Recoverable Items folder has exceeded the message count limit and the mailbox owner attempts to permanently delete items from their mailbox, the deletion will fail. -To see the current value of this property, run the command Get-MailboxStatistics \ | Format-List DumpsterMessagesPerFolderCountReceiveQuota +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List DumpsterMessagesPerFolderCountReceiveQuota`. ```yaml Type: Int32 @@ -2397,7 +2399,7 @@ This parameter is available only in on-premises Exchange. The DumpsterMessagesPerFolderCountWarningQuota parameters specifies the number of messages that each folder in the Recoverable Items folder (called the dumpster in previous versions of Exchange) can hold before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day. -To see the current value of this property, run the command Get-MailboxStatistics \ | Format-List DumpsterMessagesPerFolderCountWarningQuota +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List DumpsterMessagesPerFolderCountWarningQuota`. ```yaml Type: Int32 @@ -2436,26 +2438,26 @@ Accept wildcard characters: False ### -EmailAddresses The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is \:\,\:\,...\:\. The optional \ value specifies the type of email address. Some examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a \ value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: -- Use the \ value SMTP on the address. -- The first email address when you don't use any \ values, or when you use multiple \ values of smtp. +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. - Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\:\","\:\",..."\:\". +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\:\","\:\",...; Remove="\:\","\:\",...}. +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. ```yaml Type: ProxyAddressCollection @@ -2597,9 +2599,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute1 This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -2619,9 +2621,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute2 This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -2641,9 +2643,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute3 This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -2663,9 +2665,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute4 This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -2685,9 +2687,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute5 This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -2728,7 +2730,7 @@ This parameter is available only in on-premises Exchange. The FolderHierarchyChildrenCountReceiveQuota parameter specifies the maximum number of subfolders that can be created in a mailbox folder. The mailbox owner won't be able to create a new subfolder when this limit is reached. -To see the current value of this property, run the command Get-MailboxStatistics \ | Format-List FolderHierarchyChildrenCountReceiveQuota +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FolderHierarchyChildrenCountReceiveQuota`. ```yaml Type: Int32 @@ -2748,7 +2750,7 @@ This parameter is available only in on-premises Exchange. The FolderHierarchyChildrenCountWarningQuota parameter specifies the number of subfolders that can be created in a mailbox folder before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day. -To see the current value of this property, run the command Get-MailboxStatistics \ | Format-List FolderHierarchyChildrenCountWarningQuota +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FolderHierarchyChildrenCountWarningQuota`. ```yaml Type: Int32 @@ -2768,7 +2770,7 @@ This parameter is available only in on-premises Exchange. The FolderHierarchyDepthReceiveQuota parameter specifies the maximum number of levels in the folder hierarchy of a mailbox folder. The mailbox owner won't be able to create another level in the folder hierarchy of the mailbox folder when this limit is reached. -To see the current value of this property, run the command Get-MailboxStatistics \ | Format-List FolderHierarchyDepthReceiveQuota +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FolderHierarchyDepthReceiveQuota`. ```yaml Type: Int32 @@ -2788,7 +2790,7 @@ This parameter is available only in on-premises Exchange. The FolderHierarchyDepthWarningQuota parameter specifies the number of levels in the folder hierarchy of a mailbox folder that can be created before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day. -To see the current value of this property, run the command Get-MailboxStatistics \ | Format-List FolderHierarchyDepthWarningQuota +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FolderHierarchyDepthWarningQuota`. ```yaml Type: Int32 @@ -2808,7 +2810,7 @@ This parameter is available only in on-premises Exchange. The FoldersCountReceiveQuota parameter is used to specify a maximum number of folders within a mailbox, typically a public folder mailbox. If this value is configured and the limit is reached, no new folders will be able to be created. -To see the current value of this property, run the command Get-MailboxStatistics \ | Format-List FoldersCountReceiveQuota +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FoldersCountReceiveQuota`. ```yaml Type: Int32 @@ -2828,7 +2830,7 @@ This parameter is available only in on-premises Exchange. The FoldersCountWarningQuota parameter is used to display a warning message that the folder hierarchy is full when the value specified for this parameter is reached. This parameter is typically used for public folder mailboxes. -To see the current value of this property, run the command Get-MailboxStatistics \ | Format-List FoldersCountReceiveQuota +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List FoldersCountReceiveQuota`. ```yaml Type: Int32 @@ -2937,7 +2939,7 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo -The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mailbox. Although messages send on behalf of the mailbox clearly show the sender in the From field (\ on behalf of \), replies to these messages are delivered to the mailbox, not the sender. +The 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: @@ -2952,9 +2954,9 @@ The sender you specify for this parameter must a mailbox, mail user or mail-enab - SamAccountName - User ID or user principal name (UPN) -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. By default, this parameter is blank, which means no one else has permission to send on behalf of this mailbox. @@ -3222,9 +3224,9 @@ The Languages parameter specifies the language preferences for this mailbox, in Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -3382,7 +3384,7 @@ The MailboxMessagesPerFolderCountReceiveQuota parameter specifies the maximum nu The MailboxMessagesPerFolderCountReceiveQuota value must be greater than or equal to the MailboxMessagesPerFolderCountWarningQuota value. -To see the current value of this property, run the command Get-MailboxStatistics \ | Format-List MailboxMessagesPerFolderCountReceiveQuota +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List MailboxMessagesPerFolderCountReceiveQuota`. ```yaml Type: Int32 @@ -3404,7 +3406,7 @@ The MailboxMessagesPerFolderCountWarningQuota parameter specifies the number of The MailboxMessagesPerFolderCountReceiveQuota value must be greater than or equal to the MailboxMessagesPerFolderCountWarningQuota value. -To see the current value of this property, run the command Get-MailboxStatistics \ | Format-List MailboxMessagesPerFolderCountWarningQuota +To see the current value of this property, run the command `Get-MailboxStatistics | Format-List MailboxMessagesPerFolderCountWarningQuota`. ```yaml Type: Int32 @@ -3422,7 +3424,11 @@ Accept wildcard characters: False ### -MailboxRegion This parameter is available only in the cloud-based service. -This parameter is reserved for internal Microsoft use. +The MailboxRegion parameter specifies the geo location for the mailbox in multi-geo environments. + +To see the list of configured geo locations in Microsoft 365 Multi-Geo, run the following command: `Get-OrganizationConfig | Select -ExpandProperty AllowedMailboxRegions | Format-Table`. To view your central geo location, run the following command: `Get-OrganizationConfig | Select DefaultMailboxRegion`. + + For more information, see [Administering Exchange Online mailboxes in a multi-geo environment](https://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). ```yaml Type: String @@ -3442,8 +3448,8 @@ The MailTip parameter specifies the custom MailTip text for this recipient. The When you add a MailTip to a recipient, two things happen: -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \\This mailbox is not monitored\\. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. ```yaml Type: String @@ -3463,11 +3469,11 @@ The MailTipTranslations parameter specifies additional languages for the custom To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: -@{Add="\:\","\:\"...; Remove="\:\","\:\"...} +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. -\ is a valid ISO 639 two-letter culture code that's associated with the language. +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. ```yaml Type: MultiValuedProperty @@ -3779,9 +3785,9 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -4272,9 +4278,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -4305,9 +4311,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -4340,7 +4346,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. @@ -4384,7 +4390,7 @@ This parameter is available only in the cloud-based service. The RemoveDelayHoldApplied switch specifies whether to remove delay holds on email-related data (generated by Outlook or Outlook on the web) from the mailbox. You don't need to specify a value with this switch. -The removal of a hold from a mailbox is temporarily delayed to prevent the accidental purge of content that's no longer affected by the hold. This temporary delay in the removal of the hold is known as a delay hold. To see the hold history on a mailbox, replace \ with the name, email address, or alias of the mailbox, and run this command: Export-MailboxDiagnosticLogs -Identity \ -ComponentName HoldTracking. +The removal of a hold from a mailbox is temporarily delayed to prevent the accidental purge of content that's no longer affected by the hold. This temporary delay in the removal of the hold is known as a delay hold. To see the hold history on a mailbox, replace `` with the name, email address, or alias of the mailbox, and run this command: `Export-MailboxDiagnosticLogs -Identity -ComponentName HoldTracking`. You can use this switch with the GroupMailbox or InactiveMailbox switch to remove delay holds from group mailboxes or inactive mailboxes. For more information, see [Managing mailboxes on delay hold](https://docs.microsoft.com/microsoft-365/compliance/identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). @@ -4407,7 +4413,7 @@ This parameter is available only in the cloud-based service. The RemoveDelayReleaseHoldApplied switch specifies whether to remove delay holds on cloud data generated by non-Exchange apps (such as Teams, Forms, and Yammer) from the mailbox. Data generated by a non-Exchange cloud-based app is typically stored in a hidden folder in the mailbox. You don't need to specify a value with this switch. -The removal of a hold from a mailbox is temporarily delayed to prevent the accidental purge of content that's no longer affected by the hold. This temporary delay in the removal of the hold is known as a delay hold. To see the hold history on a mailbox, replace \ with the name, email address, or alias of the mailbox, and run this command: Export-MailboxDiagnosticLogs -Identity \ -ComponentName SubstrateHoldTracking. +The removal of a hold from a mailbox is temporarily delayed to prevent the accidental purge of content that's no longer affected by the hold. This temporary delay in the removal of the hold is known as a delay hold. To see the hold history on a mailbox, replace `` with the name, email address, or alias of the mailbox, and run this command: `Export-MailboxDiagnosticLogs -Identity -ComponentName SubstrateHoldTracking`. You can use this switch with the GroupMailbox or InactiveMailbox switch to remove delay holds from group mailboxes or inactive mailboxes. @@ -4591,9 +4597,9 @@ You use the Set-ResourceConfig and Get-ResourceConfig cmdlets to create and view After you create custom resource properties, you use this parameter to assign one or more of those properties to a resource mailbox. Properties that begin with the prefix Room/ are available only on room mailboxes, and properties that begin with the prefix Equipment/ are available only on equipment mailboxes. When you specify a property value for this parameter, don't include the prefix. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -4824,7 +4830,7 @@ Accept wildcard characters: False ### -SamAccountName This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String @@ -5091,7 +5097,8 @@ The SimpleDisplayName parameter is used to display an alternative description of - a - z - A - Z - 0 - 9 -- "\", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". +- space +- `" ' ( ) + , - . / : ?` ```yaml Type: String @@ -5242,10 +5249,11 @@ Accept wildcard characters: False ### -Type The Type parameter specifies the mailbox type for the mailbox. Valid values are: +- Equipment - Regular - Room -- Equipment - Shared +- Workspace (cloud-only) ```yaml Type: ConvertibleMailboxSubType @@ -5283,17 +5291,17 @@ Accept wildcard characters: False ### -UMDtmfMap The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: -- emailAddress:\ -- lastNameFirstName:\ -- firstNameLastName:\ +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\,lastNameFirstName:\,firstNameLastName:\. +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\, all existing lastNameFirstName and firstNameLastName values are removed. +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"; Remove="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"}. +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\","emailAddress:\} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. ```yaml Type: MultiValuedProperty @@ -5398,7 +5406,7 @@ Accept wildcard characters: False ### -UserPrincipalName This parameter is available only in on-premises Exchange. -The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format \@\. Typically, the \ value is the domain where the user account resides. +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 diff --git a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md index 9e72863f86..ff096d2727 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md @@ -237,7 +237,7 @@ The DeclineMeetingMessage parameter specifies the text in the message when meeti - The AutoDeclineFutureRequestsWhenOOF parameter is set to $true. - The DeclineEventsForScheduledOOF parameter is set to $true, and the DeclineAllEventsForScheduledOOF parameter is set to $true, or individual events are specified by using the EventsToDeleteIDs parameter. -If the value contains spaces, enclose the value in quotation marks ("). HTML tags aren't automatically added to the text, but you can use values that contain HTML tags. For example, "\\I'm on vacation.\I can't attend the meeting.\\". +If the value contains spaces, enclose the value in quotation marks ("). HTML tags aren't automatically added to the text, but you can use values that contain HTML tags. For example, `"I'm on vacation. I can't attend the meeting."`. To clear the value of this parameter, use the value $null. @@ -337,7 +337,7 @@ Accept wildcard characters: False ### -ExternalMessage The ExternalMessage parameter specifies the Automatic Replies message that's sent to external senders or senders outside the organization. If the value contains spaces, enclose the value in quotation marks ("). -HTML tags are automatically added to the text. For example, if you enter the text, "I'm on vacation", the value automatically becomes: \\I'm on vacation\\. Additional HTML tags are supported if you enclose the value in quotation marks. For example, "\\I'm on vacation.\I'll respond when I return.\\". +HTML tags are automatically added to the text. For example, if you enter the text, "I'm on vacation", the value automatically becomes: `I'm on vacation`. Additional HTML tags are supported if you enclose the value in quotation marks. For example, `"I'm on vacation. I'll respond when I return."`. The value of this parameter is meaningful only when both of the following conditions are true: @@ -383,7 +383,7 @@ Accept wildcard characters: False ### -InternalMessage The InternalMessage parameter specifies the Automatic Replies message that's sent to internal senders or senders within the organization. If the value contains spaces, enclose the value in quotation marks ("). -HTML tags are automatically added to the text. For example, if you enter the text: "I'm on vacation", the value automatically becomes: \\I'm on vacation\\. Additional HTML tags are supported if you enclose the value in quotation marks. For example, "\\I'm on vacation.\Please contact my manager.\\". +HTML tags are automatically added to the text. For example, if you enter the text: "I'm on vacation", the value automatically becomes: `I'm on vacation`. Additional HTML tags are supported if you enclose the value in quotation marks. For example, `"I'm on vacation. Please contact my manager."`. The value of this parameter is meaningful only when the AutoReplyState parameter is set to Enabled or Scheduled. diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md index 0fc39054bd..820f753b52 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md @@ -814,13 +814,13 @@ This parameter is available only in the cloud-based service. The WeatherLocations parameter specifies one or more locations to display the weather for in the calendar in Outlook on the web. -This parameter uses the syntax: LocationId:\;Name:\;Latitude:\;Longitude:\. For example, LocationId:105808079;Name:Redmond, WA;Latitude:47.679;Longitude:-122.132. +This parameter uses the syntax: `LocationId:;Name:;Latitude:;Longitude:`. For example, `LocationId:105808079;Name:Redmond, WA;Latitude:47.679;Longitude:-122.132`. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -For this parameter, "\" is "LocationId:\;Name:\;Latitude:\;Longitude:\", and "\" is "LocationId:\;Name:\;Latitude:\;Longitude:\" +For this parameter, each Value is `LocationId:;Name:;Latitude:;Longitude:`. You can configure a maximum of 5 weather locations. diff --git a/exchange/exchange-ps/exchange/Set-MailboxDatabase.md b/exchange/exchange-ps/exchange/Set-MailboxDatabase.md index 5c26633c5d..4fb2cb844f 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxDatabase.md +++ b/exchange/exchange-ps/exchange/Set-MailboxDatabase.md @@ -587,7 +587,7 @@ This parameter is available or functional only in Exchange Server 2010. The MaintenanceSchedule parameter specifies when maintenance will be performed on the mailbox database. Maintenance includes online defragmentation, removing items that have passed their retention period, removing unused indexes and other cleanup tasks. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can use the following values for days: @@ -782,7 +782,7 @@ This parameter is available or functional only in Exchange Server 2010. The QuotaNotificationSchedule parameter specifies when quota messages are sent to mailboxes that have reached one of the quota values. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can use the following values for days: diff --git a/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md index e093463946..3565044e88 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md @@ -70,7 +70,7 @@ This example changes the second export request Ayla\\MailboxExport1 to accept up ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the export request. By default, export requests are named \\\MailboxExportX (where X = 0-9). If you specify a name for the export request, use the following syntax: \\\\. +The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). If you specify a name for the export request, use the following syntax: `Alias\Name`. ```yaml Type: MailboxExportRequestIdParameter diff --git a/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md index 00b8305068..8b23551630 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md @@ -79,7 +79,7 @@ This example finds all import requests that have a status of Suspended, and then ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the import request. By default, import requests are named \\\MailboxImportX (where X = 0-9). If you specified a name for the import request with the New-MailboxImportRequest cmdlet, use the following syntax: \\\\. +The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you specified a name for the import request with the New-MailboxImportRequest cmdlet, use the following syntax: `Alias\Name`. ```yaml Type: MailboxImportRequestIdParameter diff --git a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md index 957cbaf113..e985608667 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md @@ -105,9 +105,9 @@ Accept wildcard characters: False ### -BlockedSendersAndDomains The BlockedSendersAndDomains parameter specifies the Blocked Senders list, which is a list of sender email addresses and domains whose messages are automatically sent to the Junk Email folder. This parameter corresponds to the Outlook on the web setting: Move email from these senders or domains to my Junk Email folder. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -186,8 +186,8 @@ The Enabled parameter enables or disables the junk email rule on the mailbox (a You can view the status of the junk email rule by running either of the following commands to find the Enabled property value: -- Get-MailboxJunkEmailConfiguration -Identity \ -- On-premises Exchange only: Get-InboxRule "Junk E-mail Rule" -Mailbox \ -IncludeHidden +- `Get-MailboxJunkEmailConfiguration -Identity ` +- On-premises Exchange only: `Get-InboxRule "Junk E-mail Rule" -Mailbox -IncludeHidden` The state of the junk email rule on the mailbox doesn't affect the client-side junk email settings that are available in the Outlook Junk Email Filter. Even when the junk email rule is disabled in the mailbox, Outlook can still move messages to the Junk Email folder. For example, if Outlook determines the message is spam, or the sender is defined in the Blocked Senders list, Outlook can move the message to the Junk Email folder. For more information, see [Overview of the Junk Email Filter](https://support.microsoft.com/office/5ae3ea8e-cf41-4fa0-b02a-3b96e21de089). @@ -263,13 +263,13 @@ Accept wildcard characters: False ### -TrustedSendersAndDomains The TrustedSendersAndDomains parameter specifies the Safe Senders list and Safe Recipients list, which are lists of email addresses and domains. Messages from these senders that reach the mailbox are never delivered to the Junk Email folder, regardless of the content. This parameter corresponds to the Outlook on the web setting: Don't move email from these senders or domains to my Junk Email folder. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. To empty the list of email addresses and domains, use the value $null. -Notes: +**Notes**: - All email addresses in the global address list (GAL) are automatically considered as trusted senders, so you don't need to add them to the list. - You can't directly modify the Safe Recipients list by using this cmdlet. You use this parameter to modify the Safe Senders list, and the email addresses and domains are synchronized to the Safe Recipients list. diff --git a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md index faefe1dc55..f1c8bfad2b 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md @@ -751,7 +751,7 @@ By default, no default From address is specified on the mailbox. When no default - The primary email address on the mailbox is used for all new messages. - The To address of the incoming message is used as the From address for all replies or forwarded messages. -You can find the available values for SendAddressDefault on a mailbox by running the command Get-SendAddress -Mailbox \. +You can find the available values for SendAddressDefault on a mailbox by running the command `Get-SendAddress -Mailbox `. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md index 3016a699c5..7d5927cd41 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md @@ -61,7 +61,6 @@ Set-MailboxRegionalConfiguration -Identity "Alice Jakobsen" -Language da-dk -Dat This example sets Alice Jakobsen's mailbox language to Danish Denmark, sets the date in the day/month/year format and localizes the default folder names in Danish. - ### Example 4 ```powershell Get-Mailbox -RecipientTypeDetails UserMailbox -ResultSize Unlimited | Set-MailboxRegionalConfiguration -Language es-es -DateFormat "dd/MM/yyyy" -TimeFormat H:mm -LocalizeDefaultFolderName diff --git a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md index 24f9eacc7c..9d5b6fbabd 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md @@ -73,7 +73,7 @@ This example changes the first restore request for Kweku's mailbox to skip 100 c ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: \\\\ +The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: `Alias\Name` If you didn't specify a name for the restore request when it was created, Exchange automatically generated the default name MailboxRestore. Exchange generates up to 10 names, starting with MailboxRestore and then MailboxRestoreX (where X = 1-9). diff --git a/exchange/exchange-ps/exchange/Set-MailboxSearch.md b/exchange/exchange-ps/exchange/Set-MailboxSearch.md index f13a290107..9f58877fb1 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Set-MailboxSearch.md @@ -16,6 +16,8 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxSearch cmdlet to modify an existing mailbox search. +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). + For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -54,9 +56,9 @@ Set-Mailboxsearch [-Identity] ``` ## DESCRIPTION -In on-premises Exchange and Exchange Online, mailbox searches are used for In-Place eDiscovery and In-Place Hold. For In-Place eDiscovery, unless specified, mailboxes on all Mailbox servers in an organization are searched. To create an In-Place Hold, you need to specify the mailboxes to place on hold using the SourceMailboxes parameter. The search can be stopped, started, modified, and removed. +In on-premises Exchange, mailbox searches are used for In-Place eDiscovery and In-Place Hold. For In-Place eDiscovery, unless specified, mailboxes on all Mailbox servers in an organization are searched. To create an In-Place Hold, you need to specify the mailboxes to place on hold using the SourceMailboxes parameter. The search can be stopped, started, modified, and removed. -By default, mailbox searches are performed across all Exchange 2016 and Exchange 2013 Mailbox servers in an Exchange organization, unless you constrain the search to fewer mailboxes by using the SourceMailboxes parameter. To search mailboxes on Exchange 2010 Mailbox servers, run the command on an Exchange 2010 server. +By default, mailbox searches are performed across all Exchange 2013 or later Mailbox servers in an organization, unless you constrain the search to fewer mailboxes by using the SourceMailboxes parameter. To search mailboxes on Exchange 2010 Mailbox servers, run the command on an Exchange 2010 server. If the In-Place eDiscovery search you want to modify is running, stop it before using the Set-MailboxSearch cmdlet. When restarting a search, any previous search results are removed from the target mailbox. @@ -80,9 +82,7 @@ Set-MailboxSearch -Identity "Legal-ProjectX" -AllPublicFolderSources $true In on-premises Exchange, this example adds all public folders to the existing mailbox search named Legal-ProjectX. -Note: - -If we wanted to place the results of this search on In-Place Hold, the AllSourceMailboxes parameter must be set to $false. We could still include specific mailboxes in the search by using the SourceMailboxes parameter. +**Note**: If we wanted to place the results of this search on In-Place Hold, the AllSourceMailboxes parameter must be set to $false. We could still include specific mailboxes in the search by using the SourceMailboxes parameter. ## PARAMETERS @@ -530,7 +530,7 @@ The SourceMailboxes parameter specifies the mailboxes to be searched. You can us - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. To use this parameter, the AllSourceMailboxes parameter needs to be $false (the default value). @@ -600,7 +600,7 @@ The StatusMailRecipients parameter specifies one or more recipients to receive a - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] diff --git a/exchange/exchange-ps/exchange/Set-MailboxServer.md b/exchange/exchange-ps/exchange/Set-MailboxServer.md index fe52f21442..c70e50da72 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxServer.md +++ b/exchange/exchange-ps/exchange/Set-MailboxServer.md @@ -411,7 +411,7 @@ This parameter is available or functional only in Exchange Server 2010. The CalendarRepairSchedule parameter specifies the intervals each week during which the Calendar Repair Assistant applies checks for calendar failures. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. You can specify multiple schedules separated by commas: "\","\",..."\". +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. You can use the following values for days: @@ -1008,9 +1008,9 @@ The Locale parameter specifies the locale of the Mailbox server. A locale is a c For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -1030,7 +1030,7 @@ This parameter is used for coexistence with Exchange 2010. Specifically, this pa The LogDirectorySizeLimitForManagedFolders parameter specifies the maximum size of all managed folder logs from a single mailbox database in the managed folder log directory on the Mailbox server. When a set of log files reaches its maximum size, the server deletes the oldest log files first. -Every mailbox database on the server uses a different log file name prefix (for example, Managed\_Folder\_Assistant[Mailbox database name]). Therefore, the maximum size of the managed folder log directory is the number of mailbox databases multiplied by the value of the LogDirectorySizeLimitForManagedFolders parameter. Other files aren't counted in the total size calculation. Renaming old log files or copying other files into the managed folder log directory could cause the directory to exceed its specified maximum size. +Every mailbox database on the server uses a different log file name prefix (for example, `Managed_Folder_Assistant`). Therefore, the maximum size of the managed folder log directory is the number of mailbox databases multiplied by the value of the LogDirectorySizeLimitForManagedFolders parameter. Other files aren't counted in the total size calculation. Renaming old log files or copying other files into the managed folder log directory could cause the directory to exceed its specified maximum size. When you enter a value, qualify the value with one of the following units: @@ -1188,7 +1188,7 @@ Accept wildcard characters: False The ManagedFolderAssistantSchedule parameter specifies the intervals each week during which the Managed Folder Assistant applies messaging records management (MRM) settings to managed folders in mailboxes on the Mailbox server. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. You can specify multiple schedules separated by commas: "\","\",..."\". +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. You can use the following values for days: @@ -1826,7 +1826,7 @@ Accept wildcard characters: False ### -SharingPolicySchedule The SharingPolicySchedule parameter specifies the intervals each week during which the sharing policy runs on the Mailbox server. The Sharing Policy Assistant checks permissions on shared calendar items and contact folders in users' mailboxes against the assigned sharing policy. The assistant lowers or removes permissions according to the policy. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. You can specify multiple schedules separated by commas: "\","\",..."\". +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. You can use the following values for days: diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md index 378785c90d..1dd9128f16 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md @@ -68,7 +68,9 @@ This example modifies the malware filter policy named Contoso Malware Filter Pol ### Example 2 ```powershell -$FileTypesAdd = Get-MalwareFilterPolicy -Identity Default | select -Expand FileTypes; $FileTypesAdd += "com","bat"; Set-MalwareFilterPolicy -Identity Default -EnableFileFilter $true -FileTypes $FileTypesAdd +$FileTypesAdd = Get-MalwareFilterPolicy -Identity Default | select -Expand FileTypes +$FileTypesAdd += "com","bat" +Set-MalwareFilterPolicy -Identity Default -EnableFileFilter $true -FileTypes $FileTypesAdd ``` This example enables common attachment blocking in the malware filter policy named Default and adds the file types "com" and "bat" without affecting the other file type entries. @@ -78,7 +80,8 @@ This example enables common attachment blocking in the malware filter policy nam $ft = Get-MalwareFilterPolicy -Identity Default $a = [System.Collections.ArrayList]($ft.FileTypes) $a -$a.RemoveAt(6); Set-MalwareFilterPolicy -Identity Default -FileTypes $a +$a.RemoveAt(6) +Set-MalwareFilterPolicy -Identity Default -FileTypes $a ``` This example modifies the malware filter policy named Default by removing an existing file type from common attachment blocking without affecting other file types that are already defined. @@ -526,7 +529,7 @@ You enable or disable common attachment blocking by using the EnableFileFilter p Common attachment blocking uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, .ps1 files are Windows PowerShell scripts, but their true type is text. -To replace the existing list of file types with the values you specify, use the syntax \,\,...\. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. +To replace the existing list of file types with the values you specify, use the syntax `FileType1,FileType2,...FileTypeN`. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. To add or remove file types without affecting the other file type entries, see the Examples section. diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md index 5f776179d8..e96570f9dc 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md @@ -147,7 +147,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -172,7 +172,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception that looks for messa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. @@ -279,7 +279,7 @@ The SentTo parameter specifies a condition that looks for recipients in messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -304,7 +304,7 @@ The SentToMemberOf parameter specifies a condition that looks for messages sent - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. diff --git a/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md index 4713728c82..be603155c7 100644 --- a/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md @@ -55,11 +55,11 @@ This example makes the following configuration changes to the MAPI virtual direc ### -Identity The Identity parameter specifies the MAPI virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter @@ -75,7 +75,7 @@ Accept wildcard characters: False ``` ### -ApplyDefaults -The ApplyDefaults switch specifies whether to apply the correct defaults to the related internal IIS application settings. Typically, this switch is used only by Exchange setup during the installation of Exchange Cumulative Updates or Service Packs and you shouldn't need to use it. +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. @@ -157,7 +157,7 @@ This parameter is available only in Exchange 2013. The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -181,9 +181,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode @@ -201,7 +199,7 @@ Accept wildcard characters: False ### -ExternalUrl The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. -This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. Valid input for this parameter uses the syntax https://\/mapi. +This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. Valid input for this parameter uses the syntax `https:///mapi`(for example, `https://external.contoso.com/mapi`). When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. @@ -248,7 +246,7 @@ Accept wildcard characters: False ### -InternalUrl The InternalURL parameter specifies the URL that's used to connect to the virtual directory from inside the firewall. -This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. Valid input for this parameter uses the syntax https://\/mapi. +This setting enforces the Secure Sockets Layer (SSL) protocol and uses the default SSL port. Valid input for this parameter uses the syntax `https:///mapi` (for example, `https://internal.contoso.com/mapi`). When you use the InternalUrl or ExternalUrl parameters, you need to specify one or more authentication values by using the IISAuthenticationMethods parameter. diff --git a/exchange/exchange-ps/exchange/Set-MessageClassification.md b/exchange/exchange-ps/exchange/Set-MessageClassification.md index a3ffae7e69..dc24ce3713 100644 --- a/exchange/exchange-ps/exchange/Set-MessageClassification.md +++ b/exchange/exchange-ps/exchange/Set-MessageClassification.md @@ -57,7 +57,7 @@ This example makes the following configuration changes to the message classifica The Identity parameter specifies the message classification that you want to modify. You can use any value that uniquely identifies the message classification. For example: - Name -- Identity: Default\\ or \\\; for example, "Default\My Message Classification" or "es-ES\My Message Classification". +- Identity: `Default\` or `\`; for example, `"Default\My Message Classification"` or `"es-ES\My Message Classification"`. - ClassificationID (GUID) ```yaml @@ -76,7 +76,7 @@ Accept wildcard characters: False ### -ClassificationID The ClassificationID parameter specifies the classification ID (GUID) of an existing message classification that you want to import and use in your Exchange organization. Use this parameter if you're configuring message classifications that span two Exchange forests in the same organization. -To find the ClassificationID value of the message classification, replace \ with the name of the message classification and run the following command: Get-MessageCalssification -Identity "\. +To find the ClassificationID value of the message classification, replace `` with the name of the message classification and run the following command: `Get-MessageClassification -Identity ""`. ```yaml Type: Guid diff --git a/exchange/exchange-ps/exchange/Set-MigrationBatch.md b/exchange/exchange-ps/exchange/Set-MigrationBatch.md index a74cd2e1d8..239bec4610 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Set-MigrationBatch.md @@ -322,9 +322,7 @@ The NotificationEmails parameter specifies one or more email addresses that migr If you don't use this parameter, the status report isn't sent. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". - -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md b/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md index 8d703e9bab..3e2a4c14b5 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md +++ b/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md @@ -377,7 +377,7 @@ This parameter is available only in the cloud-based service. The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. -Use the following format for the value of this parameter: ([System.IO.File]::ReadAllBytes(\)). For example: -CSVData ([System.IO.File]::ReadAllBytes("C:\\Users\\Administrator\\Desktop\\service-account.json")) +Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes(path of the JSON file>))`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json")`) ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/Set-MoveRequest.md b/exchange/exchange-ps/exchange/Set-MoveRequest.md index 57ae2c9d2d..db73b5ed16 100644 --- a/exchange/exchange-ps/exchange/Set-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Set-MoveRequest.md @@ -130,7 +130,6 @@ The ArchiveTargetDatabase parameter specifies the target mailbox database for th You can use this parameter to change the target database only if the move request has a MoveStatus value of Queued. - ```yaml Type: DatabaseIdParameter Parameter Sets: (All) diff --git a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md index 725d4762e8..ba4df36852 100644 --- a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md @@ -14,8 +14,6 @@ ms.author: chrisda ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). -**Note**: This cmdlet is available in version 2.0.4-Preview3 of the EXO V2 Module. - Use the Set-MyAnalyticsFeatureConfig cmdlet to configure the availability and features of MyAnalytics for the specified user. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Set-Notification.md b/exchange/exchange-ps/exchange/Set-Notification.md index ccd1cabe91..22dc3bce52 100644 --- a/exchange/exchange-ps/exchange/Set-Notification.md +++ b/exchange/exchange-ps/exchange/Set-Notification.md @@ -16,6 +16,12 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-Notification cmdlet to modify notification events that are shown in the notification viewer in the Exchange admin center (EAC). These notification events are related to: +- Mailbox moves and migrations. +- Expiring and expired certificates. +- Exporting mailbox content to .pst files. +- Importing mailbox content from .pst files. +- Restoring deleted mailboxes. + For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX diff --git a/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md index 864bf47258..a5a2eafe34 100644 --- a/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md @@ -55,11 +55,11 @@ This example changes the external URL of the OAB virtual directory OAB (Default ### -Identity The Identity parameter specifies the OAB virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter @@ -156,7 +156,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -178,9 +178,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md index 4baaa1f1f8..6e48c06cb4 100644 --- a/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md @@ -99,7 +99,7 @@ The AddressLists parameter specifies the address lists or global address lists t - Distinguished name (DN) - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can find the identify values of address lists and global address lists by using the Get-AddressList and Get-GlobalAddressList cmdlets. @@ -135,7 +135,7 @@ Accept wildcard characters: False ``` ### -ConfiguredAttributes -The ConfiguredAttributes parameter specifies the recipient MAPI properties that are available in the OAB. This parameter uses the syntax: "\,\","\,\"... where \ is the name of the MAPI property (for example, MobileTelephoneNumber), and \ is the value ANR (ambiguous name resolution), Value, or Indicator. +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. @@ -405,11 +405,11 @@ Accept wildcard characters: False ### -Schedule This parameter is available only in on-premises Exchange. -Note: In Exchange 2013 or later, this parameter is no longer responsible for the OAB generation schedule. For more information, see [Change the offline address book generation schedule in Exchange](https://docs.microsoft.com/Exchange/plan-and-deploy/post-installation-tasks/change-oab-generation-schedule). +**Note**: In Exchange 2013 or later, this parameter is no longer responsible for the OAB generation schedule. For more information, see [Change the offline address book generation schedule in Exchange](https://docs.microsoft.com/Exchange/plan-and-deploy/post-installation-tasks/change-oab-generation-schedule). The Schedule parameter specifies the interval for generating the OAB in Exchange 2010 or earlier. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can use the following values for days: @@ -429,7 +429,7 @@ Here are some examples: - "6.22:00-6.22:15" (Run from Saturday at 10:00 PM until Saturday at 10:15 PM.) - "Sun.1:15 AM-Monday.23:00" -Note: In Exchange Online, the read only value of this property is displayed in Coordinated Universal Time (UTC). +**Note**: In Exchange Online, the read only value of this property is displayed in Coordinated Universal Time (UTC). ```yaml Type: Schedule @@ -524,11 +524,11 @@ The VirtualDirectories parameter specifies the OAB virtual directories that acce You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. The default value of this parameter is the Client Access services (frontend) and backend OAB virtual directories on the Mailbox server that holds the OAB generation mailbox (the GeneratingMailbox parameter or SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}) when you created the OAB (for example, Mailbox01\\OAB (Default Web Site),Mailbox01\\OAB (Exchange Back End). diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 1002541008..ba592edf9f 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -20,9 +20,9 @@ For information about the parameter sets in the Syntax section below, see [Excha ## SYNTAX -### Default +### ShortenEventScopeParameter ``` -Set-OrganizationConfig +Set-OrganizationConfig -ShortenEventScopeDefault [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] @@ -33,11 +33,19 @@ Set-OrganizationConfig [-AutodiscoverPartialDirSync ] [-AutoEnableArchiveMailbox ] [-AutoExpandingArchive] + [-BookingsAddressEntryRestricted ] + [-BookingsAuthEnabled ] + [-BookingsCreationOfCustomQuestionsRestricted ] [-BookingsEnabled ] + [-BookingsExposureOfStaffDetailsRestricted ] + [-BookingsMembershipApprovalRequired ] + [-BookingsNotesEntryRestricted ] [-BookingsPaymentsEnabled ] + [-BookingsPhoneNumberEntryRestricted ] [-BookingsSocialSharingRestricted ] [-ByteEncoderTypeFor7BitCharsets ] [-CalendarVersionStoreEnabled ] + [-ComplianceMLBgdCrawlEnabled ] [-Confirm] [-ConnectorsActionableMessagesEnabled ] [-ConnectorsEnabled ] @@ -45,8 +53,11 @@ Set-OrganizationConfig [-ConnectorsEnabledForSharepoint ] [-ConnectorsEnabledForTeams ] [-ConnectorsEnabledForYammer ] + [-CustomerLockboxEnabled ] [-DefaultAuthenticationPolicy ] [-DefaultGroupAccessType ] + [-DefaultMinutesToReduceLongEventsBy ] + [-DefaultMinutesToReduceShortEventsBy ] [-DefaultPublicFolderAgeLimit ] [-DefaultPublicFolderDeletedItemRetention ] [-DefaultPublicFolderIssueWarningQuota ] @@ -58,6 +69,7 @@ Set-OrganizationConfig [-DistributionGroupNameBlockedWordsList ] [-DistributionGroupNamingPolicy ] [-ElcProcessingDisabled ] + [-EnableForwardingAddressSyncForMailboxes ] [-EndUserDLUpgradeFlowsDisabled ] [-EwsAllowEntourage ] [-EwsAllowList ] @@ -68,6 +80,9 @@ Set-OrganizationConfig [-EwsEnabled ] [-ExchangeNotificationEnabled ] [-ExchangeNotificationRecipients ] + [-FindTimeAttendeeAuthenticationEnabled ] + [-FindTimeAutoScheduleDisabled ] + [-FindTimeOnlineMeetingOptionDisabled ] [-FocusedInboxOn ] [-HierarchicalAddressBookRoot ] [-IPListBlocked ] @@ -79,6 +94,9 @@ Set-OrganizationConfig [-MailTipsGroupMetricsEnabled ] [-MailTipsLargeAudienceThreshold ] [-MailTipsMailboxSourcedTipsEnabled ] + [-MaskClientIpInReceivedHeadersEnabled ] + [-MatchSenderOrganizerProperties ] + [-MessageRemindersEnabled ] [-MobileAppEducationEnabled ] [-OAuth2ClientProfileEnabled ] [-OnlineMeetingsByDefaultEnabled ] @@ -96,6 +114,7 @@ Set-OrganizationConfig [-RefreshSessionEnabled ] [-RemotePublicFolderMailboxes ] [-RequiredCharsetCoverage ] + [-SendFromAliasEnabled ] [-SiteMailboxCreationURL ] [-SmtpActionableMessagesEnabled ] [-UnblockUnsafeSenderPromptEnabled ] @@ -103,12 +122,16 @@ Set-OrganizationConfig [-WebPushNotificationsDisabled ] [-WebSuggestedRepliesDisabled ] [-WhatIf] + [-WorkspaceTenantEnabled ] [] ``` -### AdfsAuthenticationRawConfiguration +### AdfsAuthenticationParameter ``` -Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] +Set-OrganizationConfig [-AdfsAudienceUris ] + [-AdfsEncryptCertificateThumbprint ] + [-AdfsIssuer ] + [-AdfsSignCertificateThumbprints ] [-ACLableSyncedObjectEnabled ] [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] @@ -121,6 +144,7 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [-ConnectorsEnabled ] [-CustomerFeedbackEnabled ] [-DataClassifications ] + [-DefaultAuthenticationPolicy ] [-DefaultPublicFolderAgeLimit ] [-DefaultPublicFolderDeletedItemRetention ] [-DefaultPublicFolderIssueWarningQuota ] @@ -131,7 +155,10 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [-DistributionGroupNameBlockedWordsList ] [-DistributionGroupNamingPolicy ] [-DomainController ] + [-EmptyAddressBookForNonExchangeUsers] [-EnableAuthAdminReadSession] + [-EnableDownloadDomains ] + [-EnableOrgWidePermissionOnScopedRoles] [-EwsAllowEntourage ] [-EwsAllowList ] [-EwsAllowMacOutlook ] @@ -139,7 +166,6 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [-EwsApplicationAccessPolicy ] [-EwsBlockList ] [-EwsEnabled ] - [-Force] [-HierarchicalAddressBookRoot ] [-Industry ] [-IsAgendaMailEnabled ] @@ -148,6 +174,7 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [-IsFfoMigrationInProgress ] [-LeanPopoutEnabled ] [-LinkPreviewEnabled ] + [-MailboxDataEncryptionEnabled] [-MailTipsAllTipsEnabled ] [-MailTipsExternalRecipientsTipsEnabled ] [-MailTipsGroupMetricsEnabled ] @@ -162,15 +189,14 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [-MicrosoftExchangeRecipientReplyRecipient ] [-OAuth2ClientProfileEnabled ] [-OrganizationSummary ] - [-PermanentlyDeleteDisabled ] [-PreferredInternetCodePageForShiftJis ] [-PublicComputersDetectionEnabled ] - [-PublicFolderContentReplicationDisabled ] [-PublicFolderMailboxesLockedForNewConnections ] [-PublicFolderMailboxesMigrationComplete ] [-PublicFolderMigrationComplete ] [-PublicFoldersEnabled ] [-PublicFoldersLockedForMigration ] + [-PublicFolderShowClientControl ] [-ReadTrackingEnabled ] [-RefreshSessionEnabled ] [-RemotePublicFolderMailboxes ] @@ -185,12 +211,9 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [] ``` -### AdfsAuthenticationParameter +### AdfsAuthenticationRawConfiguration ``` -Set-OrganizationConfig [-AdfsAudienceUris ] - [-AdfsEncryptCertificateThumbprint ] - [-AdfsIssuer ] - [-AdfsSignCertificateThumbprints ] +Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [-ACLableSyncedObjectEnabled ] [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] @@ -203,6 +226,7 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-ConnectorsEnabled ] [-CustomerFeedbackEnabled ] [-DataClassifications ] + [-DefaultAuthenticationPolicy ] [-DefaultPublicFolderAgeLimit ] [-DefaultPublicFolderDeletedItemRetention ] [-DefaultPublicFolderIssueWarningQuota ] @@ -213,7 +237,10 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-DistributionGroupNameBlockedWordsList ] [-DistributionGroupNamingPolicy ] [-DomainController ] + [-EmptyAddressBookForNonExchangeUsers] [-EnableAuthAdminReadSession] + [-EnableDownloadDomains ] + [-EnableOrgWidePermissionOnScopedRoles] [-EwsAllowEntourage ] [-EwsAllowList ] [-EwsAllowMacOutlook ] @@ -221,9 +248,6 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-EwsApplicationAccessPolicy ] [-EwsBlockList ] [-EwsEnabled ] - [-ExchangeNotificationEnabled ] - [-ExchangeNotificationRecipients ] - [-Force] [-HierarchicalAddressBookRoot ] [-Industry ] [-IsAgendaMailEnabled ] @@ -232,6 +256,7 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-IsFfoMigrationInProgress ] [-LeanPopoutEnabled ] [-LinkPreviewEnabled ] + [-MailboxDataEncryptionEnabled] [-MailTipsAllTipsEnabled ] [-MailTipsExternalRecipientsTipsEnabled ] [-MailTipsGroupMetricsEnabled ] @@ -246,7 +271,6 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-MicrosoftExchangeRecipientReplyRecipient ] [-OAuth2ClientProfileEnabled ] [-OrganizationSummary ] - [-PermanentlyDeleteDisabled ] [-PreferredInternetCodePageForShiftJis ] [-PublicComputersDetectionEnabled ] [-PublicFolderContentReplicationDisabled ] @@ -254,6 +278,7 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-PublicFolderMailboxesMigrationComplete ] [-PublicFolderMigrationComplete ] [-PublicFoldersEnabled ] + [-PublicFolderShowClientControl ] [-PublicFoldersLockedForMigration ] [-ReadTrackingEnabled ] [-RefreshSessionEnabled ] @@ -269,6 +294,52 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [] ``` +### Identity +``` +Set-OrganizationConfig + [-ActivityBasedAuthenticationTimeoutEnabled ] + [-ActivityBasedAuthenticationTimeoutInterval ] + [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] + [-ByteEncoderTypeFor7BitCharsets ] + [-Confirm] + [-CustomerFeedbackEnabled ] + [-DistributionGroupDefaultOU ] + [-DistributionGroupNameBlockedWordsList ] + [-DistributionGroupNamingPolicy ] + [-DomainController ] + [-EwsAllowEntourage ] + [-EwsAllowList ] + [-EwsAllowMacOutlook ] + [-EwsAllowOutlook ] + [-EwsApplicationAccessPolicy ] + [-EwsBlockList ] + [-EwsEnabled ] + [-Force] + [-HierarchicalAddressBookRoot ] + [-Industry ] + [-MailTipsAllTipsEnabled ] + [-MailTipsExternalRecipientsTipsEnabled ] + [-MailTipsGroupMetricsEnabled ] + [-MailTipsLargeAudienceThreshold ] + [-MailTipsMailboxSourcedTipsEnabled ] + [-ManagedFolderHomepage ] + [-MicrosoftExchangeRecipientEmailAddresses ] + [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled ] + [-MicrosoftExchangeRecipientPrimarySmtpAddress ] + [-MicrosoftExchangeRecipientReplyRecipient ] + [-OrganizationSummary ] + [-PermanentlyDeleteDisabled ] + [-PreferredInternetCodePageForShiftJis ] + [-PublicFolderContentReplicationDisabled ] + [-PublicFolderMigrationComplete ] + [-PublicFoldersLockedForMigration ] + [-ReadTrackingEnabled ] + [-RequiredCharsetCoverage ] + [-SCLJunkThreshold ] + [-WhatIf] + [] +``` + ## DESCRIPTION You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -285,7 +356,7 @@ Distribution groups will be created in the Users\\Groups container. The words curse, bad, and offensive will be blocked from being used in distribution group names. -All distribution groups will be prefixed with "DL\_" and suffixed with an underscore (\_) and the user's department and country code. +All distribution groups will be prefixed with `DL_` and suffixed with an underscore (\_\) and the user's department and country code. ### Example 2 ```powershell @@ -324,6 +395,30 @@ In Exchange Online, this example results in meeting updates being auto-processed ## PARAMETERS +### -ShortenEventScopeDefault +This parameter is available only in the cloud-based service + +{{ Fill ShortenEventScopeDefault Description }} + +Valid values are: + +- None (default value) +- EndEarly +- StartLate + +```yaml +Type: ShortenEventScopeMode +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ACLableSyncedObjectEnabled This parameter is available only in on-premises Exchange. @@ -331,7 +426,7 @@ The ACLableSyncedObjectEnabled parameter specifies whether remote mailboxes in h ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -399,9 +494,9 @@ This parameter is available only in on-premises Exchange. The AdfsAudienceUris parameter specifies one or more external URLs that are used for Active Directory Federation Services (AD FS) claims-based authentication. For example, the external Outlook on the web and external Exchange admin center (EAC) URLs. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. For more information about configuring AD FS claims based authentication in Exchange, see [Use AD FS claims-based authentication with Outlook on the web](https://docs.microsoft.com/Exchange/clients/outlook-on-the-web/ad-fs-claims-based-auth). @@ -481,9 +576,9 @@ The AdfsSignCertificateThumbprints parameter specifies one or more X.509 token-s To get the thumbprint values of the primary and secondary token-signing certificates, open Windows PowerShell on the AD FS server and run the command Get-ADFSCertificate -CertificateType "Token-signing". For more information, see [Get-ADFSCertificate](https://docs.microsoft.com/powershell/module/adfs/get-adfscertificate). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -507,7 +602,7 @@ The AllowPlusAddressInRecipients parameter enables or disables dynamic, disposab ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -523,7 +618,7 @@ The AppsForOfficeEnabled parameter specifies whether to enable apps for Outlook ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -542,7 +637,7 @@ The AsyncSendEnabled parameter specifies whether to enable or disable async send ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -563,7 +658,7 @@ The AuditDisabled parameter specifies whether to disable or enable mailbox audit ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -583,7 +678,7 @@ After you enable AutodiscoverPartialDirSync, it will take approximately 3 hours ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -601,7 +696,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -621,7 +716,61 @@ After you enable auto-expanding archiving, additional storage space is automatic ```yaml Type: SwitchParameter -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsAddressEntryRestricted +This parameter is available only in the cloud-based service. + +{{ Fill BookingsAddressEntryRestricted Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsAuthEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsAuthEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsCreationOfCustomQuestionsRestricted +This parameter is available only in the cloud-based service. + +{{ Fill BookingsCreationOfCustomQuestionsRestricted Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -644,7 +793,61 @@ Microsoft Bookings is an online and mobile app for small businesses who provide ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsExposureOfStaffDetailsRestricted +This parameter is available only in the cloud-based service. + +{{ Fill BookingsExposureOfStaffDetailsRestricted Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsMembershipApprovalRequired +This parameter is available only in the cloud-based service. + +{{ Fill BookingsMembershipApprovalRequired Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNotesEntryRestricted +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNotesEntryRestricted Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -665,7 +868,25 @@ The BookingsPaymentsEnabled parameter specifies whether to enable online payment ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsPhoneNumberEntryRestricted +This parameter is available only in the cloud-based service. + +{{ Fill BookingsPhoneNumberEntryRestricted Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -730,7 +951,25 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceMLBgdCrawlEnabled +This parameter is available only in the cloud-based service. + +{{ Fill ComplianceMLBgdCrawlEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -770,7 +1009,7 @@ For more information about actionable messages in connected apps, see [Connect a ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -791,7 +1030,7 @@ The workloads that are affected by this parameter are Outlook, SharePoint, Teams ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -816,7 +1055,7 @@ For more information about connectors for Outlook on the web, see [Connect apps ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -837,7 +1076,7 @@ The ConnectorsEnabledForSharepoint parameter specifies whether to enable or disa ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -858,7 +1097,7 @@ The ConnectorsEnabledForTeams parameter specifies whether to enable or disable c ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -879,7 +1118,7 @@ The ConnectorsEnabledForYammer parameter specifies whether to enable or disable ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -897,7 +1136,7 @@ The CustomerFeedbackEnabled parameter specifies whether the Exchange server is e ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -908,6 +1147,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CustomerLockboxEnabled +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DataClassifications This parameter is available only in on-premises Exchange. @@ -915,7 +1172,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2016, Exchange Server 2019 @@ -939,7 +1196,7 @@ You create authentication policies with the New-AuthenticationPolicy cmdlet to b ```yaml Type: AuthPolicyIdParameter -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2019, Exchange Online @@ -960,7 +1217,7 @@ The DefaultGroupAccessType parameter specifies the default access type for Micro ```yaml Type: ModernGroupObjectType -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -971,6 +1228,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultMinutesToReduceLongEventsBy +This parameter is available only in the cloud-based service. + +{{ Fill DefaultMinutesToReduceLongEventsBy Description }} + +```yaml +Type: Int32 +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMinutesToReduceShortEventsBy +This parameter is available only in the cloud-based service. + +{{ Fill DefaultMinutesToReduceShortEventsBy Description }} + +```yaml +Type: Int32 +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultPublicFolderAgeLimit The DefaultPublicFolderAgeLimit parameter specifies the default age limit for the contents of public folders across the entire organization. Content in a public folder is automatically deleted when this age limit is exceeded. This attribute applies to all public folders in the organization that don't have their own AgeLimit setting. @@ -978,7 +1271,7 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hou ```yaml Type: EnhancedTimeSpan -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -994,7 +1287,7 @@ The DefaultPublicFolderDeletedItemRetention parameter specifies the default valu ```yaml Type: EnhancedTimeSpan -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1022,7 +1315,7 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes(2 ```yaml Type: Unlimited -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1050,7 +1343,7 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes ( ```yaml Type: Unlimited -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1068,7 +1361,7 @@ When you move folder contents between mailboxes, a copy of the original data is ```yaml Type: EnhancedTimeSpan -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1096,7 +1389,7 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes ( ```yaml Type: Unlimited -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1117,7 +1410,7 @@ The DirectReportsGroupAutoCreationEnabled parameter specifies whether to enable ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -1202,7 +1495,7 @@ The DomainController parameter isn't supported on Edge Transport servers. An Edg ```yaml Type: Fqdn -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1223,7 +1516,7 @@ The ElcProcessingDisabled parameter specifies whether to enable or disable the p ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -1234,7 +1527,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAuthAdminReadSessionThis parameter is available only in on-premises Exchange. +### -EmptyAddressBookForNonExchangeUsers +This parameter is available only in on-premises Exchange. + +{{ Fill EmptyAddressBookForNonExchangeUsers Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAuthAdminReadSession +This parameter is available only in on-premises Exchange. The EnableAuthAdminReadSession switch enables a recipient read session in Exchange 2016 CU17 or later, or in Exchange 2019 CU6 or later. You don't need to specify a value with this switch. @@ -1251,6 +1563,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableDownloadDomains +This parameter is available only in on-premises Exchange. + +{{ Fill EnableDownloadDomains Description }} + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableForwardingAddressSyncForMailboxes +This parameter is available only in the cloud-based service. + +{{ Fill EnableForwardingAddressSyncForMailboxes Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOrgWidePermissionOnScopedRoles +This parameter is available only in on-premises Exchange. + +{{ Fill EnableOrgWidePermissionOnScopedRoles Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndUserDLUpgradeFlowsDisabled This parameter is available only in the cloud-based service. @@ -1261,7 +1627,7 @@ The EndUserDLUpgradeFlowsDisabled parameter specifies whether to prevent users f ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -1291,9 +1657,9 @@ Accept wildcard characters: False ### -EwsAllowList The EwsAllowList parameter specifies the applications that are allowed to access EWS or REST when the EwsApplicationAccessPolicy parameter is set to EwsAllowList. Other applications that aren't specified by this parameter aren't allowed to access EWS or REST. You identify the application by its user agent string value. Wildcard characters (\*) are supported. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -1364,9 +1730,9 @@ Accept wildcard characters: False ### -EwsBlockList The EwsBlockList parameter specifies the applications that aren't allowed to access EWS or REST when the EwsApplicationAccessPolicy parameter is set to EnforceBlockList. All other applications that aren't specified by this parameter are allowed to access EWS or REST. You identify the application by its user agent string value. Wildcard characters (\*) are supported. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -1410,7 +1776,7 @@ The ExchangeNotificationEnabled parameter enables or disables Exchange notificat ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -1428,7 +1794,53 @@ The ExchangeNotificationRecipients parameter specifies the recipients for Exchan ```yaml Type: MultiValuedProperty -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FindTimeAttendeeAuthenticationEnabled +This parameter is available only in the cloud-based service. + +The FindTimeAttendeeAuthenticationEnabled parameter controls whether attendees are required to verify their identity in meeting polls using the FindTime Outlook add-in. Valid values are: + +- $true: Attendees are required to validate their identity and the meeting organizer can't turn off this setting (Always On). +- $false: By default, attendees are required to verify their identity, but the meeting organizer is allowed to turn this setting off. + +For more information about FindTime, see [How to create a FindTime poll](https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FindTimeAutoScheduleDisabled +This parameter is available only in the cloud-based service. + +The FindTimeAutoScheduleDisabled parameter controls automatically scheduling the meeting once a consensus is reached in meeting polls using the FindTime Outlook add-in. Valid values are: + +- $true: Reaching a consensus for the meeting time doesn't automatically schedule the meeting, and the meeting organizer can't change this setting (Off). +- $false: By default, reaching a consensus for the meeting time doesn't automatically schedule the meeting, but meeting organizer is allowed to turn on this setting. + +For more information about FindTime, see [How to create a FindTime poll](https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -1439,9 +1851,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FindTimeOnlineMeetingOptionDisabled +This parameter is available only in the cloud-based service. + +The FindTimeOnlineMeetingOptionDisabled parameter controls the availability of the **Online meeting** checkbox for Teams or Skype in meeting polls using the FindTime Outlook add-in. Valid values are: + +- $true: The **Online meeting** checkbox is not available in the meeting poll in FindTime, and the meeting organizer can't change this setting. If your organization uses a third-party online meeting provider, the meeting organizer can make the meeting online using the third-party provider while creating the meeting based on the FindTime poll results. +- $false: The **Online meeting** checkbox is available in the meeting poll in FindTime, so the meeting organizer can choose to select or not select this setting. + +For more information about FindTime, see [How to create a FindTime poll](https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). + ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -1466,7 +1888,7 @@ Focused Inbox is a replacement for Clutter that separates the Inbox into the Foc ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -1484,7 +1906,7 @@ The Force switch specifies whether to suppress warning or confirmation messages. ```yaml Type: SwitchParameter -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 @@ -1527,7 +1949,7 @@ The Industry parameter specifies the industry that best represents your organiza ```yaml Type: IndustryType -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1550,15 +1972,15 @@ This parameter accepts IPv4 or IPv6 addresses in the following formats: - IP address range with subnet mask: For example, 192.168.8.2(255.255.255.0). - Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.3.1/24 or 2001:0DB8::CD3/60. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. This parameter has a limit of approximately 1200 entries. ```yaml Type: MultiValuedProperty -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -1574,7 +1996,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1592,7 +2014,7 @@ The IsExcludedFromOffboardMigration parameter specifies that no new moves from t ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1610,7 +2032,7 @@ The IsExcludedFromOnboardMigration parameter specifies that no new moves from yo ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1628,7 +2050,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1645,14 +2067,14 @@ The LeanPopoutEnabled parameter specifies whether to enable faster loading of po - $true: Lean pop-outs are enabled. - $false: Lean pop-outs are disabled. This is the default value. -Notes: +**Notes**: - Lean pop-outs aren't available for messages that contain attachments or information rights management (IRM) restrictions. - Outlook add-ins and Skype for Business Online presence aren't available with lean pop-outs. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1671,7 +2093,7 @@ The LinkPreviewEnabled parameter specifies whether link preview of URLs in email ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1682,6 +2104,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailboxDataEncryptionEnabled +This parameter is available only in on-premises Exchange. + +{{ Fill MailboxDataEncryptionEnabled Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MailTipsAllTipsEnabled The MailTipsAllTipsEnabled parameter specifies whether MailTips are enabled. The default value is $true. @@ -1769,7 +2209,7 @@ The ManagedFolderHomepage parameter specifies the URL of the web page that's dis ```yaml Type: String -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1792,7 +2232,7 @@ You can use the MapiHttpEnabled parameter on the Set-CASMailbox cmdlet to overri ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1803,6 +2243,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MaskClientIpInReceivedHeadersEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MaskClientIpInReceivedHeadersEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MatchSenderOrganizerProperties +This parameter is available only in the cloud-based service. + +{{ Fill MatchSenderOrganizerProperties Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MaxConcurrentMigrations This parameter is available only in on-premises Exchange. @@ -1810,7 +2286,7 @@ The MaxConcurrentMigrations parameter specifies the maximum number of concurrent ```yaml Type: Unlimited -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1821,6 +2297,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MessageRemindersEnabled +This parameter is available only in the cloud-based service. + +The MessageRemindersEnabled parameter enables or disables the message reminders feature in the organization. Valid values are: + +- $true: Message reminders are enabled. A message is moved to the top of the user's inbox if Outlook determines that the message requires follow-up or a reply. Only one message is moved at a time, and the user must take action on the message before another message is moved to the top of the Inbox. +- $false: Message reminders are disabled. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MicrosoftExchangeRecipientEmailAddresses This parameter is available only in on-premises Exchange. @@ -1830,7 +2327,7 @@ Email addresses that you specify by using the MicrosoftExchangeRecipientEmailAdd ```yaml Type: ProxyAddressCollection -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1846,11 +2343,11 @@ This parameter is available only in on-premises Exchange. The MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter specifies whether the default email address policy is automatically applied to the Exchange recipient. The default value is $true. If this parameter is set to $true, Exchange automatically adds new email addresses to the Exchange recipient when email address policies are added or modified in the Exchange organization. If this parameter is set to $false, you must manually add new email addresses to the Exchange recipient when email address policies are added or modified. -If you change the value of the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter from $false to $true, any email addresses that you defined by using the MicrosoftExchangeRecipientEmailAddresses parameter are preserved. However, the value of the MicrosoftExchangeRecipientPrimarySmtpAddress parameter reverts to MicrosoftExchange329e71ec88ae4615bbc36ab6ce41109e@\. +If you change the value of the MicrosoftExchangeRecipientEmailAddressPolicyEnabled parameter from $false to $true, any email addresses that you defined by using the MicrosoftExchangeRecipientEmailAddresses parameter are preserved. However, the value of the MicrosoftExchangeRecipientPrimarySmtpAddress parameter reverts to `MicrosoftExchange329e71ec88ae4615bbc36ab6ce41109e@`. ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1872,7 +2369,7 @@ The MicrosoftExchangeRecipientPrimarySmtpAddress parameter is meaningful only if ```yaml Type: SmtpAddress -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1897,7 +2394,7 @@ The MicrosoftExchangeRecipientReplyRecipient parameter specifies the recipient t ```yaml Type: RecipientIdParameter -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1920,7 +2417,7 @@ This setting will affect Outlook desktop at some point in the future. ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -1943,7 +2440,7 @@ When you enable modern authentication in Exchange Online, we recommend that you ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1966,7 +2463,7 @@ You can override this setting on individual mailboxes by using the OnlineMeeting ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -1984,7 +2481,7 @@ The OrganizationSummary parameter specifies a summarized description that best r ```yaml Type: MultiValuedProperty -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1998,8 +2495,6 @@ Accept wildcard characters: False ### -OutlookGifPickerDisabled This parameter is available only in the cloud-based service. -This feature is currently in Preview, is not available everywhere, and is subject to change. - The OutlookGifPickerDisabled parameter disables the GIF Search (powered by Bing) feature that's built into the Compose page in Outlook on the web. Valid values are: - $true: GIF Search in Outlook on the web is disabled. @@ -2007,7 +2502,7 @@ The OutlookGifPickerDisabled parameter disables the GIF Search (powered by Bing) ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -2037,7 +2532,7 @@ The Outlook for iOS and Android feature and services that are not FedRAMP compli ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -2055,7 +2550,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -2073,7 +2568,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -2094,7 +2589,7 @@ The OutlookPayEnabled parameter enables or disables Microsoft Pay in the Microso ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -2117,7 +2612,7 @@ A message that's permanently deleted can't be recovered by using the Recoverable ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 @@ -2135,7 +2630,7 @@ This parameter has been deprecated and is no longer used. ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -2167,7 +2662,7 @@ The PublicComputersDetectionEnabled parameter specifies whether Outlook on the w ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2185,7 +2680,7 @@ The PublicFolderContentReplicationDisabled parameter is used during public folde ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 @@ -2206,7 +2701,7 @@ The PublicFolderMailboxesLockedForNewConnections parameter specifies whether use ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -2227,7 +2722,7 @@ The PublicFolderMailboxesMigrationComplete parameter is used during public folde ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -2245,7 +2740,7 @@ The PublicFolderMigrationComplete parameter is used during public folder migrati ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -2265,7 +2760,7 @@ The PublicFoldersEnabled parameter specifies how public folders are deployed in ```yaml Type: PublicFoldersDeployment -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2284,7 +2779,7 @@ The PublicFolderShowClientControl parameter enables or disables access to public ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2016, Exchange 2019, Exchange Online @@ -2302,7 +2797,7 @@ The PublicFoldersLockedForMigration parameter specifies whether users are locked ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -2334,7 +2829,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2350,7 +2845,7 @@ The RemotePublicFolderMailboxes parameter specifies the identities of the public ```yaml Type: MultiValuedProperty -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2384,7 +2879,7 @@ The SCLJunkThreshold parameter specifies the spam confidence level (SCL) thresho ```yaml Type: Int32 -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -2395,12 +2890,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SendFromAliasEnabled +This parameter is available only in the cloud-based service. + +{{ Fill SendFromAliasEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SiteMailboxCreationURL The SiteMailboxCreationURL parameter specifies the URL that's used to create site mailboxes. Site mailboxes improve collaboration and user productivity by allowing access to both SharePoint documents and Exchange email in Outlook 2013 or later. ```yaml Type: Uri -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2419,7 +2932,7 @@ The SmtpActionableMessagesEnabled parameter specifies whether to enable or disab ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2437,7 +2950,7 @@ This parameter has been deprecated and is no longer used. ```yaml Type: MultiValuedProperty -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -2453,7 +2966,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2498,7 +3011,7 @@ There are three scenarios where meeting update messages are not auto-processed r ```yaml Type: String -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -2518,7 +3031,7 @@ Office Online Server enables users to view supported file attachments in Outlook ```yaml Type: String -Parameter Sets: AdfsAuthenticationRawConfiguration, AdfsAuthenticationParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -2539,7 +3052,7 @@ The WebPushNotificationsDisabled parameter specifies whether to enable or disabl ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -2560,7 +3073,7 @@ The WebSuggestedRepliesDisabled parameter specifies whether to enable or disable ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: ShortenEventScopeParameter Aliases: Applicable: Exchange Online @@ -2571,7 +3084,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -WhatIf The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. @@ -2588,6 +3100,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WorkspaceTenantEnabled +This parameter is available only in the cloud-based service. + +{{ Fill WorkspaceTenantEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). diff --git a/exchange/exchange-ps/exchange/Set-OutboundConnector.md b/exchange/exchange-ps/exchange/Set-OutboundConnector.md index f16d43ab1e..92d9705887 100644 --- a/exchange/exchange-ps/exchange/Set-OutboundConnector.md +++ b/exchange/exchange-ps/exchange/Set-OutboundConnector.md @@ -103,7 +103,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. diff --git a/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md index 6565560167..c5aae426ac 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md +++ b/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md @@ -89,11 +89,11 @@ In Exchange 2010 and Exchange 2013, this example sets the available authenticati ### -Identity The Identity parameter specifies the Outlook Anywhere virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter @@ -214,7 +214,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -236,9 +236,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/Set-OutlookProvider.md b/exchange/exchange-ps/exchange/Set-OutlookProvider.md index e1776d8f7f..bd589a22de 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookProvider.md +++ b/exchange/exchange-ps/exchange/Set-OutlookProvider.md @@ -152,13 +152,13 @@ Accept wildcard characters: False ``` ### -RequiredClientVersions -The RequiredClientVersions parameter specifies the minimum version of Microsoft Outlook that's allowed to connect to the Exchange server. This information is in the Autodiscover response to the client connection request. Valid input for this parameter is "\, \". +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"`. -\ 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. +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. -\ is the UTC date-time when connections by older versions of Outlook will be blocked. The UTC date-time is represented in the ISO 8601 date-time format: yyyy-mm-ddThh:mm:ss.fffZ, where yyyy = year, mm = month, dd = day, T indicates the beginning of the time component, hh = hour, mm = minute, ss = second, fff = fractions of a second and Z signifies Zulu, which is another way to denote UTC. +ExpirationDate is the UTC date-time when connections by older versions of Outlook will be blocked. The UTC date-time is represented in the ISO 8601 date-time format: yyyy-mm-ddThh:mm:ss.fffZ, where yyyy = year, mm = month, dd = day, T indicates the beginning of the time component, hh = hour, mm = minute, ss = second, fff = fractions of a second and Z signifies Zulu, which is another way to denote UTC. -An example of a valid value for this parameter is "14.0.7012.1000, 2014-01-01T12:00:00Z". +An example of a valid value for this parameter is `"14.0.7012.1000, 2020-01-01T12:00:00Z"`. ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md index bd70e344f4..29e0207f0a 100644 --- a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md @@ -298,9 +298,9 @@ The AllowedFileTypes parameter specifies the attachment file types (file extensi .avi, .bmp, .doc, .docm, .docx, .gif, .jpg, .mp3, .one, .pdf, .png, .ppsm, .ppsx, .ppt, .pptm, .pptx, .pub, .rpmsg, .rtf, .tif, .tiff, .txt, .vsd, .wav, .wma, .wmv, .xls, .xlsb, .xlsm, .xlsx, .zip -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same file types are specified in multiple lists: @@ -328,9 +328,9 @@ The AllowedMimeTypes parameter specifies the MIME extensions of attachments that - image/jpeg - image/png -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same MIME types are specified in multiple lists: @@ -379,9 +379,9 @@ The BlockedFileTypes parameter specifies a list of attachment file types (file e .ade, .adp, .apk, .app, .appx, .appcontent-ms, .appref-ms, .asp, .aspx, .asx, .bas, .bat, .cdxml, .cer, .chm, .cmd, .cnt, .com, .cpl, .crt, .csh, .der, .diagcab, .exe, .fxp, .gadget, .grp, .hlp, .hpj, .hta, .htc, .inf, .ins, .isp, .its, .jar, .jnlp, .js, .jse, .ksh, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mcf, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .mht, .mhtml, .msc, .msh, .msh1, .msh1xml, .msh2, .msh2xml, .mshxml, .msi, .msp, .mst, .msu, .ops, .osd, .pcd, .pif, .pl, .plg, .prf, .prg, .printerexport, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .psd1, .psdm1, .pssc, .pst, .py, .pyc, .pyo, .pyw, .pyz, .pyzw, .reg, .scf, .scr, .sct, .settingcontent-ms, .shb, .shs, .theme, .tmp, .udl, .url, .vb, .vbe, .vbp, .vbs, .vsmacros, .vsw, .webpnp, .website, .ws, .wsb, .wsc, .wsf, .wsh, .xbap, .xll, .xnk -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same file types are specified in multiple lists: @@ -413,9 +413,9 @@ The BlockedMimeTypes parameter specifies MIME extensions in attachments that pre - text/scriplet - x-internet-signup -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same MIME types are specified in multiple lists: @@ -519,7 +519,7 @@ This parameter is available only in the cloud-based service. The ConditionalAccessPolicy parameter specifies the Outlook on the Web Policy for limited access. For this feature to work properly, you also need to configure a Conditional Access policy in the Azure Active Directory Portal. -Note: When you enable a Conditional Access policy, users will no longer be able to access the light version of Outlook on the web. An error message will direct them to use the default premium experience. +**Note**: When you enable a Conditional Access policy, users will no longer be able to access the light version of Outlook on the web. An error message will direct them to use the default premium experience. Valid values are: @@ -615,18 +615,18 @@ Accept wildcard characters: False ``` ### -DelegateAccessEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is available or functional only in on-premises Exchange. -The DelegateAccessEnabled parameter specifies whether delegates can use Outlook Web App to open folders that they have delegate access to. Valid values are: +The DelegateAccessEnabled parameter specifies whether delegates can use Outlook on the web or Outlook Web App to open folders that they have delegate access to. Valid values are: -- $true: Delegates can open the mailbox in Outlook Web App. This is the default value. -- $false: Delegates can't open the mailbox in Outlook Web App. +- $true: Delegates can open the mailbox in Outlook on the web. This is the default value. +- $false: Delegates can't open the mailbox in Outlook on the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -823,9 +823,9 @@ The ForceSaveFileTypes parameter specifies the attachment file types (file exten .ade, .adp, .app, .asp, .aspx, .asx, .bas, .bat, .cer, .chm, .cmd, .com, .cpl, .crt, .csh, .dcr, .dir, .exe, .fxp, .gadget, .hlp, .hta, .htm, .html, .inf, .ins, .isp, .its, .js, .jse, .ksh, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .msc, .msh, .mshxml, .msi, .msp, .mst, .ops, .pcd, .pif, .plg, .prf, .prg, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .pst, .reg, .scf, .scr, .sct, .shb, .shs, .spl, .swf, .tmp, .url, .vb, .vbe, .vbs, .vsmacro, .vss, .vst, .vsw, .ws, .wsc, .wsf, .wsh -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same file types are specified in multiple lists: @@ -854,9 +854,9 @@ The ForceSaveMimeTypes parameter specifies the MIME extensions in attachments th - Application/x-shockwave-flash - text/html -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same MIME types are specified in multiple lists: @@ -1125,7 +1125,6 @@ If another policy is currently set as the default, this switch replaces the old **Note**: In Exchange Online - and excluding resource mailboxes - this value will be superseded by the **OwaMailboxPolicy** parameter in each organization's [CASMailboxPlan](https://docs.microsoft.com/powershell/module/exchange/set-casmailboxplan). That value will instead be applied per each mailbox's SKU. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -1633,8 +1632,8 @@ Accept wildcard characters: False ### -ReportJunkEmailEnabled The ReportJunkEmailEnabled parameter specifies whether users can report messages as junk or not junk to Microsoft in Outlook on the web. Valid values are: -- $true: This is the default value. Selecting a message in the Junk Email folder and clicking Not junk \> Not junk moves the message back into the Inbox and gives users the option to report the message to Microsoft. Selecting a message in any other email folder and clicking Junk \> Junk folder moves the message to the Junk Email folder and gives users the option to report the message to Microsoft. Selecting a message and clicking Not junk \> Phishing (in the Junk Email folder) and Junk \> Phishing (everywhere else) are available to report phishing messages to Microsoft. -- $false: Selecting a message in the Junk Email folder and clicking Not junk \> Not junk moves the message back into the Inbox with no option to report the message to Microsoft. Selecting a message in any other email folder and clicking Junk \> Junk moves the message to the Junk Email folder with no option to report the message to Microsoft. Selecting a message and clicking Not junk \> Phishing (in the Junk Email folder) and Junk \> Phishing (everywhere else) are available to report phishing messages to Microsoft. +- $true: This is the default value. Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox and gives users the option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk folder** moves the message to the Junk Email folder and gives users the option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. +- $false: Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox with no option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk** moves the message to the Junk Email folder with no option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. This parameter is meaningful only when the JunkEmailEnabled parameter is set to $true. @@ -2372,9 +2371,9 @@ The WebReadyFileTypes parameter specifies the attachment file types (file extens You can only remove or add values from within the list of supported file types (you can't add additional values). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parameter is set to $false. Otherwise, all supported file types are available in WebReady Document Viewing. @@ -2408,9 +2407,9 @@ The WebReadyMimeTypes parameter specifies the MIME extensions of attachments tha You can only remove or add values from within the list of supported file types (you can't add additional values). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parameter is set to $false. Otherwise, all supported MIME types are available in WebReady Document Viewing. diff --git a/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md index 04ab3a5541..5bca388672 100644 --- a/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md @@ -184,11 +184,11 @@ This example sets the ActionForUnknownFileAndMIMETypes parameter to Block on the ### -Identity 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 \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter @@ -304,9 +304,9 @@ The AllowedFileTypes parameter specifies the attachment file types (file extensi .avi, .bmp, .doc, .docm, .docx, .gif, .jpg, .mp3, .one, .pdf, .png, .ppsm, .ppsx, .ppt, .pptm, .pptx, .pub, .rpmsg, .rtf, .tif, .tiff, .txt, .vsd, .wav, .wma, .wmv, .xls, .xlsb, .xlsm, .xlsx, .zip -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same file types are specified in multiple lists: @@ -334,9 +334,9 @@ The AllowedMimeTypes parameter specifies the MIME extensions of attachments that - image/jpeg - image/png -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same MIME types are specified in multiple lists: @@ -423,9 +423,9 @@ The BlockedFileTypes parameter specifies a list of attachment file types (file e .ade, .adp, .app, .appcontent-ms, .asp, .aspx, .asx, .bas, .bat, .cer, .chm, .cmd, .cnt, .com, .cpl, .crt, .csh, .der, .diagcab, .exe, .fxp, .gadget, .grp, .hlp, .hpj, .hta, .htc, .inf, .ins, .isp, .its, .jar, .jnlp, .js, .jse, .ksh, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mcf, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .mht, .mhtml, .msc, .msh, .msh1, .msh1xml, .msh2, .msh2xml, .mshxml, .msi, .msp, .mst, .msu, .ops, .osd, .pcd, .pif, .pl, .plg, .prf, .prg, .printerexport, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .psd1, .psdm1, .pst, .reg, .scf, .scr, .sct, .settingcontent-ms, .shb, .shs, .theme, .tmp, .url, .vb, .vbe, .vbp, .vbs, .vsmacros, .vsw, .webpnp, .website, .ws, .wsc, .wsf, .wsh, .xbap, .xll, .xnk -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same file types are specified in multiple lists: @@ -457,9 +457,9 @@ The BlockedMimeTypes parameter specifies MIME extensions in attachments that pre - text/scriplet - x-internet-signup -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same MIME types are specified in multiple lists: @@ -902,9 +902,9 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro - Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. - ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -923,11 +923,11 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null (blank): This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -949,7 +949,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode @@ -1117,9 +1117,9 @@ The ForceSaveFileTypes parameter specifies the attachment file types (file exten .ade, .adp, .app, .asp, .aspx, .asx, .bas, .bat, .cer, .chm, .cmd, .com, .cpl, .crt, .csh, .dcr, .dir, .exe, .fxp, .gadget, .hlp, .hta, .htm, .html, .inf, .ins, .isp, .its, .js, .jse, .ksh, .lnk, .mad, .maf, .mag, .mam, .maq, .mar, .mas, .mat, .mau, .mav, .maw, .mda, .mdb, .mde, .mdt, .mdw, .mdz, .msc, .msh, .mshxml, .msi, .msp, .mst, .ops, .pcd, .pif, .plg, .prf, .prg, .ps1, .ps1xml, .ps2, .ps2xml, .psc1, .psc2, .pst, .reg, .scf, .scr, .sct, .shb, .shs, .spl, .swf, .tmp, .url, .vb, .vbe, .vbs, .vsmacro, .vss, .vst, .vsw, .ws, .wsc, .wsf, .wsh -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same file types are specified in multiple lists: @@ -1148,9 +1148,9 @@ The ForceSaveMimeTypes parameter specifies the MIME extensions in attachments th - Application/x-shockwave-flash - text/html -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the same MIME types are specified in multiple lists: @@ -2015,8 +2015,8 @@ Accept wildcard characters: False ### -ReportJunkEmailEnabled The ReportJunkEmailEnabled parameter specifies whether users can report messages as junk or not junk to Microsoft in Outlook on the web. Valid values are: -- $true: This is the default value. Selecting a message in the Junk Email folder and clicking Not junk \> Not junk moves the message back into the Inbox and gives users the option to report the message to Microsoft. Selecting a message in any other email folder and clicking Junk \> Junk folder moves the message to the Junk Email folder and gives users the option to report the message to Microsoft. Selecting a message and clicking Not junk \> Phishing (in the Junk Email folder) and Junk \> Phishing (everywhere else) are available to report phishing messages to Microsoft. -- $false: Selecting a message in the Junk Email folder and clicking Not junk \> Not junk moves the message back into the Inbox with no option to report the message to Microsoft. Selecting a message in any other email folder and clicking Junk \> Junk moves the message to the Junk Email folder with no option to report the message to Microsoft. Selecting a message and clicking Not junk \> Phishing (in the Junk Email folder) and Junk \> Phishing (everywhere else) are available to report phishing messages to Microsoft. +- $true: This is the default value. Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox and gives users the option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk folder** moves the message to the Junk Email folder and gives users the option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. +- $false: Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox with no option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk** moves the message to the Junk Email folder with no option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. This parameter is meaningful only when the JunkEmailEnabled parameter is set to $true. @@ -2603,9 +2603,9 @@ The WebReadyFileTypes parameter specifies the attachment file types (file extens You can only remove or add values from within the list of supported file types (you can't add additional values). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parameter is set to $false. Otherwise, all supported file types are available in WebReady Document Viewing. @@ -2639,9 +2639,9 @@ The WebReadyMimeTypes parameter specifies the MIME extensions of attachments tha You can only remove or add values from within the list of supported file types (you can't add additional values). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. This list is used only if the WebReadyDocumentViewingForAllSupportedTypes parameter is set to $false. Otherwise, all supported MIME types are available in WebReady Document Viewing. diff --git a/exchange/exchange-ps/exchange/Set-Place.md b/exchange/exchange-ps/exchange/Set-Place.md index 9281d90697..25d8848e08 100644 --- a/exchange/exchange-ps/exchange/Set-Place.md +++ b/exchange/exchange-ps/exchange/Set-Place.md @@ -389,7 +389,7 @@ Accept wildcard characters: False ### -Tags The Tags parameter specifies additional features of the room (for example, details like the type of view or furniture type). -You can specify multiple labels separated by commas: \,\,...\. If the labels contains spaces, enclose the value in quotation marks: "\","\",..."\". +You can specify multiple labels separated by commas. If the labels contains spaces, enclose the values in quotation marks: `"Label 1","Label 2",..."Label N"`. ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md index 9e092d1419..909824262a 100644 --- a/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md +++ b/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md @@ -53,7 +53,7 @@ This example replaces the text of all custom Spanish Policy Tips with the value, ### -Identity The Identity parameter specifies the custom Policy Tip you want to modify. You can use any value that uniquely identifies the custom Policy Tip. For example: -- \\\\: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - The value Url - GUID - Distinguished name (DN) diff --git a/exchange/exchange-ps/exchange/Set-PopSettings.md b/exchange/exchange-ps/exchange/Set-PopSettings.md index 670a46720e..2a6fa7b124 100644 --- a/exchange/exchange-ps/exchange/Set-PopSettings.md +++ b/exchange/exchange-ps/exchange/Set-PopSettings.md @@ -275,13 +275,13 @@ Accept wildcard characters: False ### -ExternalConnectionSettings The ExternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by external POP3 clients (POP3 connections from outside your corporate network). -This parameter uses the syntax \:\:[\]. The encryption method value is optional (blank indicates unencrypted connections). +This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). The default value is blank ($null), which means no external POP3 connection settings are configured. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The combination of encryption methods and ports that are specified for this parameter need to match the corresponding encryption methods and ports that are specified by the SSLBindings and UnencryptedOrTLSBindings parameters. @@ -301,13 +301,13 @@ Accept wildcard characters: False ### -InternalConnectionSettings The InternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by internal POP3 clients (POP3 connections from inside your corporate network). This setting is also used when a POP3 connection is forwarded to another Exchange server that's running the Microsoft Exchange POP3 service. -This parameter uses the syntax \:\:[\]. The encryption method value is optional (blank indicates unencrypted connections). +This parameter uses the syntax `HostName:Port:[]`. The encryption method value is optional (blank indicates unencrypted connections). -The default value is \:995:SSL,\:110:TLS. +The default value is `:995:SSL,:110:TLS`. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The combination of encryption methods and ports that are specified for this parameter need to match the corresponding encryption methods and ports that are specified by the SSLBindings and UnencryptedOrTLSBindings parameters. @@ -617,13 +617,13 @@ Accept wildcard characters: False ``` ### -SSLBindings -The SSLBindings parameter specifies the IP address and TCP port that's used for an POP3 connection that's always encrypted by SSL/TLS. This parameter uses the syntax \:\. +The SSLBindings parameter specifies the IP address and TCP port that's used for an POP3 connection that's always encrypted by SSL/TLS. This parameter uses the syntax `IPv4OrIPv6Address:Port`. -The default value is [::]:995,0.0.0.0:995. +The default value is `[::]:995,0.0.0.0:995`. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -658,13 +658,13 @@ Accept wildcard characters: False ``` ### -UnencryptedOrTLSBindings -The UnencryptedOrTLSBindings parameter specifies the IP address and TCP port that's used for unencrypted POP3 connections, or POP3 connections that are encrypted by using opportunistic TLS (STARTTLS) after the initial unencrypted protocol handshake. This parameter uses the syntax \:\. +The UnencryptedOrTLSBindings parameter specifies the IP address and TCP port that's used for unencrypted POP3 connections, or POP3 connections that are encrypted by using opportunistic TLS (STARTTLS) after the initial unencrypted protocol handshake. This parameter uses the syntax `IPv4OrIPv6Address:Port`. -The default value is [::]:110, 0.0.0.0:110. +The default value is `[::]:110, 0.0.0.0:110`. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md index 1de7d3bffe..418348f5f4 100644 --- a/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md @@ -53,11 +53,11 @@ This example modifies the external URL of the Contoso Windows PowerShell virtual ### -Identity The Identity parameter specifies the PowerShell virtual directory that you want to modify. You can use any value that uniquely identifies the virtual directory. For example: -- Name or \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter diff --git a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md index 765d116107..31b7a4ae87 100644 --- a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md @@ -67,7 +67,6 @@ Set-ProtectionAlert -Identity "Content search deleted" -NotifyUserOnFilterMatch: This example modifies an alert so that even though it's configured for aggregated activity, a notification is triggered during a match for the activity. A threshold of 10 detections and a TimeWindow of two hours are also configured in the same command. - ## PARAMETERS ### -Identity diff --git a/exchange/exchange-ps/exchange/Set-PublicFolder.md b/exchange/exchange-ps/exchange/Set-PublicFolder.md index 82faa64d0c..3987e6c4c2 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolder.md +++ b/exchange/exchange-ps/exchange/Set-PublicFolder.md @@ -78,7 +78,7 @@ In Exchange 2010, this example sets the folder to replicate only on weekends. ## PARAMETERS ### -Identity -The Identity parameter specifies the name and path of the public folder you want to modify. A valid value uses the format: \\\\\\\\...\\\\\\. For example, "\\Customer Discussion" or "\\Engineering\\Customer Discussion". +The Identity parameter specifies the name and path of the public folder you want to modify. A valid value uses the format: `\Level1\Level2\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. ```yaml Type: PublicFolderIdParameter @@ -424,7 +424,7 @@ The Replicas parameter specifies a list of public folder databases with which to - Distinguished name (DN) - GUID -You can specify multiple values separated by commas. If the values contain spaces, use the following syntax: \"","\",..."\". +You can specify multiple values separated by commas. If the values contain spaces, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: DatabaseIdParameter[] @@ -444,7 +444,7 @@ This parameter is available or functional only in Exchange Server 2010 The ReplicationSchedule parameter specifies the replication schedule for the folder. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can use the following values for days: diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md index d9f4fce6f8..1eb6a33e8f 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md +++ b/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md @@ -263,7 +263,7 @@ Accept wildcard characters: False ### -MaintenanceSchedule The MaintenanceSchedule parameter specifies the store maintenance schedule. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can use the following values for days: @@ -362,7 +362,7 @@ Accept wildcard characters: False ### -QuotaNotificationSchedule The QuotaNotificationSchedule parameter specifies the interval at which warning messages are sent when public folders exceed their specified size limit. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can use the following values for days: @@ -440,7 +440,7 @@ Accept wildcard characters: False ### -ReplicationSchedule The ReplicationSchedule parameter specifies the time intervals during which replication of public folders or contents may occur. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can use the following values for days: diff --git a/exchange/exchange-ps/exchange/Set-RMSTrustedPublishingDomain.md b/exchange/exchange-ps/exchange/Set-RMSTrustedPublishingDomain.md index 50df184ee3..8ef80ae905 100644 --- a/exchange/exchange-ps/exchange/Set-RMSTrustedPublishingDomain.md +++ b/exchange/exchange-ps/exchange/Set-RMSTrustedPublishingDomain.md @@ -48,8 +48,8 @@ Set-RMSTrustedPublishingDomain "Contoso TPD" -Default -ExtranetLicensingUrl http This example makes the following changes to the existing TPD Contoso TPD: - Sets Contoso TPD as the default TPD for the organization. -- Sets the external licensing URL to https://rms.contoso.com/\_wmcs/licensing. -- Sets the external certification URL to https://rms.contoso.com/\_wmcs/certification/servercertification.asmx +- Sets the external licensing URL to `https://rms.contoso.com/_wmcs/licensing`. +- Sets the external certification URL to `https://rms.contoso.com/_wmcs/certification/servercertification.asmx`. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Set-ReceiveConnector.md b/exchange/exchange-ps/exchange/Set-ReceiveConnector.md index 699cafff5c..fe8db92db4 100644 --- a/exchange/exchange-ps/exchange/Set-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/Set-ReceiveConnector.md @@ -105,7 +105,7 @@ The Identity parameter specifies the Receive connector that you want to modify. - Name - Distinguished name (DN) - GUID -- \\\\ +- ServerName\\Name ```yaml Type: ReceiveConnectorIdParameter @@ -198,7 +198,7 @@ The Banner parameter specifies a custom SMTP 220 banner that's displayed to remo The default value of this parameter is blank ($null), which uses the following SMTP banner: -220 \ Microsoft ESMTP MAIL service ready at \\ +`220 Microsoft ESMTP MAIL service ready at ` ```yaml Type: String @@ -256,7 +256,7 @@ Accept wildcard characters: False ``` ### -Bindings -The Bindings parameter specifies the local IP address and TCP port number that's used by the Receive connector. This parameter uses the syntax "\:\","\:\". You can specify an IPv4 address and port, and IPv6 address and port, or both. The IP address values 0.0.0.0 or [::]: indicate that the Receive connector uses all available local IPv4 or all IPv6 addresses. +The Bindings parameter specifies the local IP address and TCP port number that's used by the Receive connector. This parameter uses the syntax `"IPv4Address:TCPPort","IPv6Address:TCPPort"`. You can specify an IPv4 address and port, an IPv6 address and port, or both. The IP address values 0.0.0.0 or `[::]` indicate that the Receive connector uses all available local IPv4 or all IPv6 addresses. You need to specify a valid local IP address from the network adapters of the Exchange server. If you specify an invalid local IP address, the Microsoft Exchange Transport service might fail to start when the service is restarted. @@ -391,7 +391,7 @@ The DefaultDomain parameter specifies the default accepted domain to use for the Although you can configure any accepted domain as the default domain, you typically specify an authoritative domain. The default domain is used by: -- The external postmaster address: postmaster@\. +- The external postmaster address: `postmaster@`. - Encapsulated non-SMTP email addresses (Internet Mail Connector Encapsulated Address or IMCEA encapsulation). - The primary address for all recipients in the default email address policy. If you configure another accepted domain as the default domain, the default email address policy isn't automatically updated. @@ -588,7 +588,7 @@ The Fqdn parameter specifies the destination FQDN that's shown to connected mess The default value is the FQDN of theExchange server that contains the Receive connector (for example edge01.contoso.com). You can specify a different FQDN (for example, mail.contoso.com). -Don't modify this value on the default Receive connector named Default \ on Mailbox servers. If you have multiple Mailbox servers in your organization, internal mail flow between Mailbox servers fails if you change the FQDN value on this Receive connector. +Don't modify this value on the default Receive connector named `Default ` on Mailbox servers. If you have multiple Mailbox servers in your organization, internal mail flow between Mailbox servers fails if you change the FQDN value on this Receive connector. ```yaml Type: Fqdn @@ -1073,11 +1073,11 @@ Accept wildcard characters: False ### -RemoteIPRanges The RemoteIPRanges parameter specifies the remote IP addresses that the Receive connector accepts messages from. Valid values are: -- Single IP address: For example, 192.168.1.1 or fe80::39bd:88f7:6969:d223%11 . +- Single IP address: For example, 192.168.1.1 or fe80::39bd:88f7:6969:d223%11. - IP address range: For example, 192.168.1.1-192.168.1.254. - Classless Inter-Domain Routing (CIDR) IP: For example, 192.168.1.1/24 or 2001:0DB8::CD3/60. -You can specify multiple value separated by commas ("\","\"...). +You can specify multiple value separated by commas: `"Value1","Value2",..."ValueN"`. Multiple Receive connectors on the same server can have overlapping remote IP address ranges as long as one IP address range is completely overlapped by another. For example, you can configure the following remote IP address ranges on different Receive connectors on the same server: @@ -1236,7 +1236,7 @@ Accept wildcard characters: False ``` ### -TlsCertificateName -The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is "\X.500Issuer\X.500Subject". The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command $TLSCert = Get-ExchangeCertificate -Thumbprint \, run the command $TLSCertName = "\$($TLSCert.Issuer)\$($TLSCert.Subject)" and then use the value $TLSCertName for this parameter. +The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"` and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier @@ -1256,18 +1256,18 @@ The TlsDomainCapabilities parameter specifies the capabilities that the Receive This parameter uses the following syntax: -"\:\,\\>"...,"\:\,\..."... +`"Domain1:Capability1,Capability2,"...,"Domain2:Capability1,Capability2,...",...` -At the moment, this parameter can only be used in Exchange hybrid deployments and the available \ values for this scenario are: +You can only use this parameter in Exchange hybrid deployments, and the valid Capability values are: - AcceptCloudServicesMail (Exchange 2013 or later) - AcceptOorgProtocol (Exchange 2010) -There are more available values but there is no scenario to use them. For more information, see [Advanced Office 365 Routing](https://techcommunity.microsoft.com/t5/exchange-team-blog/advanced-office-365-routing-locking-down-exchange-on-premises/ba-p/609238). +More Capability values are available, but there is no scenario to use them. For more information, see [Advanced Office 365 Routing](https://techcommunity.microsoft.com/t5/exchange-team-blog/advanced-office-365-routing-locking-down-exchange-on-premises/ba-p/609238). -The available \ values are an SMTP domain (for example, contoso.com), or the value NO-TLS for non-TLS encrypted inbound connections. +The available Domain values are an SMTP domain (for example, contoso.com), or the value NO-TLS for non-TLS encrypted inbound connections. -For example, "contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptCloudServicesMail". +For example, `"contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptCloudServicesMail"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-RemoteDomain.md b/exchange/exchange-ps/exchange/Set-RemoteDomain.md index 76dc5cae25..ac4eaa72d6 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/Set-RemoteDomain.md @@ -264,7 +264,7 @@ Accept wildcard characters: False ``` ### -DisplaySenderName -Note: You should only modify this parameter under the direction of Microsoft Customer Service and Support. +**Note**: You should only modify this parameter under the direction of Microsoft Customer Service and Support. The DisplaySenderName parameter specifies whether to show the sender's Display Name in the From email address for messages sent to recipients in the remote domain. Valid values are: @@ -602,7 +602,7 @@ Accept wildcard characters: False ### -UseSimpleDisplayName The UseSimpleDisplayName parameter specifies whether the sender's simple display name is used for the From email address in messages sent to recipients in the remote domain. Valid values are: -- $true: Simple display names are used in messages sent to recipients in the remote domain. If the sender doesn't have a simple display name configured, the From email address is "EmailAddress \". +- $true: Simple display names are used in messages sent to recipients in the remote domain. If the sender doesn't have a simple display name configured, the From email address is `EmailAddress `. - $false: Simple display names aren't used in messages sent to recipients in the remote domain. This is the default value. ```yaml diff --git a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md index 943abdc584..6f4743b275 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md @@ -149,9 +149,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -182,9 +182,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command. @@ -217,7 +217,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. @@ -257,9 +257,9 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (\@\). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: @@ -327,9 +327,9 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -To enter multiple senders and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +To enter multiple senders and overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more senders without affecting any existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. This parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators. @@ -640,26 +640,26 @@ Accept wildcard characters: False ### -EmailAddresses The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is \:\,\:\,...\:\. The optional \ value specifies the type of email address. Some examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a \ value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: -- Use the \ value SMTP on the address. -- The first email address when you don't use any \ values, or when you use multiple \ values of smtp. +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. - Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\:\","\:\",..."\:\". +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\:\","\:\",...; Remove="\:\","\:\",...}. +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. ```yaml Type: ProxyAddressCollection @@ -714,9 +714,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute1 This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -736,9 +736,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute2 This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -758,9 +758,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute3 This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -780,9 +780,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute4 This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -802,9 +802,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute5 This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 -eq 'Value'"` will return a match if the property _contains_ the specified value. @@ -900,8 +900,8 @@ The MailTip parameter specifies the custom MailTip text for this recipient. The When you add a MailTip to a recipient, two things happen: -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \\This mailbox is not monitored\\. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. ```yaml Type: String @@ -921,11 +921,11 @@ The MailTipTranslations parameter specifies additional languages for the custom To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: -@{Add="\:\","\:\"...; Remove="\:\","\:\"...} +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. -\ is a valid ISO 639 two-letter culture code that's associated with the language. +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. ```yaml Type: MultiValuedProperty @@ -950,9 +950,9 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -1098,9 +1098,9 @@ Valid values for this parameter are individual senders in your organization (mai - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove senders without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove senders without affecting other existing entries, use the following syntax: `@{Add="Sender1","Sender2"...; Remove="Sender3","Sender4"...}`. The senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1131,9 +1131,9 @@ Valid values for this parameter are groups in your organization (distribution gr - Email address - GUID -You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: `Group1,Group2,...GroupN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Group1","Group2",..."GroupN"`. -To add or remove groups without affecting other existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove groups without affecting other existing entries, use the following syntax: `@{Add="Group1","Group2"...; Remove="Group3","Group4"...}`. The groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command. @@ -1166,7 +1166,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. @@ -1282,7 +1282,7 @@ Accept wildcard characters: False ``` ### -SamAccountName -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +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 @@ -1349,7 +1349,7 @@ Accept wildcard characters: False ``` ### -UserPrincipalName -The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format \@\. Typically, the \ value is the domain where the user account resides. +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 diff --git a/exchange/exchange-ps/exchange/Set-ResourceConfig.md b/exchange/exchange-ps/exchange/Set-ResourceConfig.md index 64e18d4f56..e2db5a6340 100644 --- a/exchange/exchange-ps/exchange/Set-ResourceConfig.md +++ b/exchange/exchange-ps/exchange/Set-ResourceConfig.md @@ -44,7 +44,8 @@ This example adds the custom resource properties Room/Whiteboard and Equipment/V ### Example 2 ```powershell -Set-ResourceConfig -ResourcePropertySchema @{Add="Room/TV"; Remove="Equipment/Laptop"} +Set-ResourceConfig -ResourcePropertySchema @{Add="Room/TV" +Remove="Equipment/Laptop"} ``` This example adds the custom resource property Room/TV and removes Equipment/Laptop without affecting other custom resource properties that are already configured. @@ -89,11 +90,11 @@ Accept wildcard characters: False ``` ### -ResourcePropertySchema -The ResourcePropertySchema parameter specifies the custom resource property that you want to make available to room or equipment mailboxes. This parameter uses the syntax Room/\ or Equipment/\ where the \ value doesn't contain spaces. For example, Room/Whiteboard or Equipment/Van. You can specify multiple values separated by commas. +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: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md index 3a3461cd6e..8884a2a830 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md @@ -16,6 +16,8 @@ This cmdlet is available only in Security & Compliance Center PowerShell. For mo Use the Set-RetentionCompliancePolicy cmdlet to modify existing retention policies in the Security & Compliance Center. +**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. + For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -150,7 +152,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -178,7 +180,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -203,7 +205,7 @@ You can use any value that uniquely identifies the Microsoft 365 Group. For exam - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -228,7 +230,7 @@ You can use any value that uniquely identifies the Microsoft 365 Group. For exam - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -246,7 +248,7 @@ Accept wildcard characters: False ### -AddOneDriveLocation The AddOneDriveLocation parameter specifies the OneDrive for Business sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -264,7 +266,7 @@ Accept wildcard characters: False ### -AddOneDriveLocationException This parameter specifies the OneDrive for Business sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -298,7 +300,7 @@ Accept wildcard characters: False ### -AddSharePointLocation The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to the policy until they have been indexed. @@ -318,7 +320,7 @@ Accept wildcard characters: False ### -AddSharePointLocationException This parameter specifies the SharePoint Online sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -343,7 +345,7 @@ You can use any value that uniquely identifies the user. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -383,7 +385,7 @@ You can use any value that uniquely identifies the team. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -405,7 +407,7 @@ The AddTeamsChannelLocationException parameter specifies the Teams to add to the - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -430,7 +432,7 @@ You can use any value that uniquely identifies the user. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -452,7 +454,7 @@ The AddTeamsChatLocationException parameter specifies the Teams users to add to - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -550,7 +552,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -578,7 +580,7 @@ To specify a mailbox or distribution group, you can use any value that uniquely - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -603,7 +605,7 @@ You can use any value that uniquely identifies the Microsoft 365 Group. For exam - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -628,7 +630,7 @@ You can use any value that uniquely identifies the Microsoft 365 Group. For exam - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -646,7 +648,7 @@ Accept wildcard characters: False ### -RemoveOneDriveLocation The RemoveOneDriveLocation parameter specifies the OneDrive for Business sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -664,7 +666,7 @@ Accept wildcard characters: False ### -RemoveOneDriveLocationException This parameter specifies the OneDrive for Business sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -698,7 +700,7 @@ Accept wildcard characters: False ### -RemoveSharePointLocation The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -716,7 +718,7 @@ Accept wildcard characters: False ### -RemoveSharePointLocationException This parameter specifies the SharePoint Online sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -741,7 +743,7 @@ You can use any value that uniquely identifies the user. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -773,14 +775,14 @@ Accept wildcard characters: False ``` ### -RestrictiveRetention -The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: +The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for a retention policy or retention label policy. Valid values are: - $true: Preservation Lock is enabled for the policy. No one (including an administrator) can turn off the policy or make it less restrictive. - $false: Preservation Lock isn't enabled for the policy. This is the default value. -After a policy has been locked, no one can turn off or disable it, or remove content from the policy. And it's not possible to modify or delete content that's subject to the policy during the retention period. The only ways that you can modify the retention policy are by adding content to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. +After a policy has been locked, no one can turn off or disable it, or remove content from the policy. And it's not possible to modify or delete content that's subject to the policy during the retention period. The only way that you can modify the retention policy are by adding content to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. -Therefore, before you lock a retention policy, it's critical that you understand your organization's compliance requirements, and that you don't lock a policy until you are certain that it's what you need. +Therefore, before you lock a policy for retention, it's critical that you understand your organization's compliance requirements, and that you don't lock a policy until you are certain that it's what you need. ```yaml Type: Boolean @@ -804,7 +806,7 @@ You can use any value that uniquely identifies the team. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -826,7 +828,7 @@ The RemoveTeamsChannelLocationException parameter specifies the Teams to remove - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -851,7 +853,7 @@ You can use any value that uniquely identifies the user. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -873,7 +875,7 @@ The RemoveTeamsChatLocationException parameter specifies the Teams users to remo - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md index 9925060ae2..3693b25284 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md @@ -79,6 +79,8 @@ You view and create labels by using the Get-ComplianceTag and New-ComplianceTag You can't use this parameter with the Name or PublishComplianceTag parameters. +You can't use this parameter for Teams retention rules. + ```yaml Type: String Parameter Sets: (All) @@ -130,10 +132,12 @@ Accept wildcard characters: False ### -ContentContainsSensitiveInformation The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. -This parameter uses the basic syntax @(@{Name="\";[minCount="\"],@{Name="\";[minCount="\"],...). For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). +You can't use this parameter for Teams retention rules. + ```yaml Type: PswsHashtable[] Parameter Sets: (All) @@ -188,6 +192,8 @@ The ContentMatchQuery parameter specifies a content search filter. This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +You can't use this parameter for Teams retention rules. + ```yaml Type: String Parameter Sets: (All) @@ -215,7 +221,9 @@ The ExcludedItemClasses parameter specifies the types of messages to exclude fro Additionally, you can specify [message classes for Exchange items](https://docs.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. -You can specify multiple item class values by using the syntax "Value1","Value2",..."ValueN". +You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. + +You can't use this parameter for Teams retention rules. ```yaml Type: MultiValuedProperty @@ -236,6 +244,8 @@ The ExpirationDateOption parameter specifies whether the expiration date is calc - CreationAgeInDays - ModificationAgeInDays +You can't use this parameter for Teams retention rules. + ```yaml Type: String Parameter Sets: (All) @@ -297,6 +307,8 @@ The RetentionDurationDisplayHint parameter specifies the units that are used to For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Security & Compliance Center will display 1 year as the content hold duration. +You can't use this parameter for Teams retention rules. + ```yaml Type: HoldDurationHint Parameter Sets: (All) diff --git a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md index 47de7b2c45..724195623b 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md @@ -440,7 +440,7 @@ The RetentionEnabled parameter specifies whether the tag is enabled. When set to Messages with a disabled tag are still considered tagged, so any default policy tags in the user's retention policy aren't applied to such messages. -When you set the RetentionEnabled parameter to $false, the retention period for the tag is shown as Never. Users may apply this tag to items that they want to indicate should never be deleted or should never be moved to the archive. Enabling the tag later may result in unintentional deletion or archiving of items. To avoid this situation, if a retention policy is disabled temporarily, it may be advisable to change the name of that tag so that users are discouraged from using it, such as DISABLED\_\. +When you set the RetentionEnabled parameter to $false, the retention period for the tag is shown as Never. Users may apply this tag to items that they want to indicate should never be deleted or should never be moved to the archive. Enabling the tag later may result in unintentional deletion or archiving of items. To avoid this situation, if a retention policy is disabled temporarily, it may be advisable to change the name of that tag so that users are discouraged from using it, such as `DISABLED_`. ```yaml Type: Boolean @@ -458,7 +458,7 @@ Accept wildcard characters: False ### -RetentionId The RetentionId parameter specifies an alternate tag ID to ensure the retention tag found on mailbox items tagged in one Exchange organization matches the tag when the mailbox is moved to another Exchange organization (for example, in a cross-forest deployment or in a cross-premises deployment, when a mailbox is moved from an on-premises Exchange server to the cloud, or a cloud-based mailbox is moved to an on-premises Exchange server). -It's not ordinarily required to specify or modify the RetentionId parameter for a retention tag. The parameter is populated automatically by \ when importing retention tags in a cross-forest or cross-premises deployment. +Typically, you don't need to specify or modify the RetentionId parameter for a retention tag. This parameter is populated automatically when importing retention tags in a cross-forest or cross-premises deployment. ```yaml Type: Guid diff --git a/exchange/exchange-ps/exchange/Set-RoleGroup.md b/exchange/exchange-ps/exchange/Set-RoleGroup.md index c3a015e2a9..8c1181dd1c 100644 --- a/exchange/exchange-ps/exchange/Set-RoleGroup.md +++ b/exchange/exchange-ps/exchange/Set-RoleGroup.md @@ -76,7 +76,8 @@ This example sets the role group managers list to the Seattle Role Administrator ### Example 3 ```powershell -$Credentials = Get-Credential; Set-RoleGroup "ContosoUsers: Toronto Recipient Admins" -LinkedDomainController dc02.contosousers.contoso.com -LinkedCredential $Credentials -LinkedForeignGroup "Toronto Tier 2 Administrators" +$Credentials = Get-Credential +Set-RoleGroup "ContosoUsers: Toronto Recipient Admins" -LinkedDomainController dc02.contosousers.contoso.com -LinkedCredential $Credentials -LinkedForeignGroup "Toronto Tier 2 Administrators" ``` This example modifies the linked foreign USG on the existing linked role group ContosoUsers: Toronto Recipient Admins. The foreign USG that should be linked is Toronto Tier 2 Administrators. diff --git a/exchange/exchange-ps/exchange/Set-RpcClientAccess.md b/exchange/exchange-ps/exchange/Set-RpcClientAccess.md index bf5491071d..0c2078feca 100644 --- a/exchange/exchange-ps/exchange/Set-RpcClientAccess.md +++ b/exchange/exchange-ps/exchange/Set-RpcClientAccess.md @@ -55,7 +55,7 @@ Set-RpcClientAccess -Server MBX01 -BlockedClientVersions 15.0.0-15.4737.999 This example prevents Outlook Anywhere connections by Outlook 2013 clients that don't have KB3054940 installed (version 15.0.4737.1000) on the server named MBX01. -Note: You can determine specific client software versions by parsing the RPC Client Access log files located at %ExchangeInstallPath%Logging\\RPC Client Access. +**Note**: You can determine specific client software versions by parsing the RPC Client Access log files located at %ExchangeInstallPath%Logging\\RPC Client Access. ## PARAMETERS @@ -165,7 +165,7 @@ Accept wildcard characters: False ### -MaximumConnections The MaximumConnections parameter specifies the maximum number of concurrent client connections that are allowed by the Microsoft Exchange RPC Client Access service. The default value is 65536. -Note: Although you can configure a non-default value for this parameter, changes to this setting aren't enforced. +**Note**: Although you can configure a non-default value for this parameter, changes to this setting aren't enforced. ```yaml Type: Int32 diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md index f4c88801c4..59637e2853 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md @@ -36,7 +36,7 @@ Set-SafeAttachmentPolicy [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Office 365 ATP](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md index 00f3138408..979ee437e9 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md @@ -40,7 +40,7 @@ Set-SafeAttachmentRule [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Advanced Threat Protection that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Office 365 ATP](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -138,7 +138,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -163,7 +163,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception that looks for messa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. @@ -270,7 +270,7 @@ The SentTo parameter specifies a condition that looks for recipients in messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -295,7 +295,7 @@ The SentToMemberOf parameter specifies a condition that looks for messages sent - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md index 19bcd93f4e..6afbe90627 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md @@ -43,7 +43,7 @@ Set-SafeLinksPolicy [-Identity] ``` ## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -134,7 +134,7 @@ Accept wildcard characters: False ### -DeliverMessageAfterScan The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: -- $true: Wait until Safe Links scanning is complete before delivering the message. +- $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. - $false: If Safe Links scanning can't complete, deliver the message anyway. This is the default value. ```yaml @@ -172,9 +172,9 @@ Accept wildcard characters: False ### -DoNotRewriteUrls The DoNotRewriteUrls parameter specifies the URLs that are not rewritten by Safe Links scanning. The list of entries allows users who are included in the policy to access the specified URLs that would otherwise be blocked by Safe Links. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -For details about the entry syntax, see [Entry syntax for the "Do not rewrite the following URLs" list](https://docs.microsoft.com/en-us/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). +For details about the entry syntax, see [Entry syntax for the "Do not rewrite the following URLs" list](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md b/exchange/exchange-ps/exchange/Set-SafeLinksRule.md index 2cfdb65e9f..3f7da3b2c7 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Set-SafeLinksRule.md @@ -40,7 +40,7 @@ Set-SafeLinksRule [-Identity] ``` ## DESCRIPTION -Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -138,7 +138,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -163,7 +163,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception that looks for messa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. @@ -270,7 +270,7 @@ The SentTo parameter specifies a condition that looks for recipients in messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -295,7 +295,7 @@ The SentToMemberOf parameter specifies a condition that looks for messages sent - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. diff --git a/exchange/exchange-ps/exchange/Set-SendConnector.md b/exchange/exchange-ps/exchange/Set-SendConnector.md index cc0673ee61..bd79cce6d5 100644 --- a/exchange/exchange-ps/exchange/Set-SendConnector.md +++ b/exchange/exchange-ps/exchange/Set-SendConnector.md @@ -95,7 +95,7 @@ Accept wildcard characters: False ``` ### -AddressSpaces -The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The complete syntax for entering each address space is as follows: \:\;\ +The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. - AddressSpaceType: On an Edge server, the address space type must be SMTP. In the Transport service on a Mailbox server, the address space type may be SMTP, X400, or any other text string. If you omit the address space type, SMTP is assumed. - AddressSpace: For SMTP address space types, the address space that you enter must be RFC 1035-compliant. For example, \*, \*.com, and \*.contoso.com are permitted, but \*contoso.com is not. For X.400 address space types, the address space that you enter must be RFC 1685-compliant, such as o=MySite;p=MyOrg;a=adatum;c=us. For all other values of address space type, you can enter any text for the address space. @@ -149,7 +149,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -Note: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -480,11 +480,11 @@ The LinkedReceiveConnector parameter forces all messages received by the specifi When you use the LinkedReceiveConnector parameter with this command, you must also use the following parameters with the specified values: -- AddressSpaces$null -- DNSRoutingEnabled$false -- MaxMessageSizeunlimited -- Smarthosts \ -- SmarthostAuthMechanism \ +- `AddressSpaces $null` +- `DNSRoutingEnabled $false` +- `MaxMessageSize unlimited` +- `Smarthosts ` +- `SmarthostAuthMechanism ` ```yaml Type: ReceiveConnectorIdParameter @@ -626,9 +626,9 @@ Accept wildcard characters: False ### -SmartHosts The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameteris required if you set the DNSRoutingEnabled parameter to $false and it must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. If you enter an IP address, you must enter the IP address as a literal. For example, 10.10.1.1. The smart host identity can be the FQDN of a smart-host server, a mail exchanger (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart-host server. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -678,9 +678,9 @@ Accept wildcard characters: False ### -SourceTransportServers The SourceTransportServers parameter specifies the names of the Mailbox servers that can use this Send connector. This parameter isn't valid for Send connectors configured on an Edge server. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -718,7 +718,7 @@ Accept wildcard characters: False ``` ### -TlsCertificateName -The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is "\X.500Issuer\X.500Subject". The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command $TLSCert = Get-ExchangeCertificate -Thumbprint \, run the command $TLSCertName = "\$($TLSCert.Issuer)\$($TLSCert.Subject)", and then use the value $TLSCertName for this parameter. +The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"X.500IssuerX.500Subject"`. The X.500Issuer value is found in the certificate's Issuer field, and the X.500Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet. Or, after you run Get-ExchangeCertificate to find the thumbprint value of the certificate, run the command `$TLSCert = Get-ExchangeCertificate -Thumbprint `, run the command `$TLSCertName = "$($TLSCert.Issuer)$($TLSCert.Subject)"`, and then use the value $TLSCertName for this parameter. ```yaml Type: SmtpX509Identifier diff --git a/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md b/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md index 2a36026c40..cd62a22368 100644 --- a/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md +++ b/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md @@ -93,9 +93,9 @@ The BlockedDomains parameter specifies the domain names to block. When the Sende Valid input for this parameter is one or more domains or subdomains. Wildcard characters aren't permitted. For example, if you specify the values contoso.com and marketing.contoso.com, only messages from those domains are blocked by the Sender Filter agent. Messages from sales.contoso.com aren't blocked by the Sender Filter agent. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The maximum number of entries for this parameter is 800. @@ -117,9 +117,9 @@ The BlockedDomainsAndSubdomains parameter specifies the domain names to block. W Valid input for this parameter is one or more domains. Wildcard characters aren't permitted. For example, if you specify the value contoso.com, messages from contoso.com, sales.contoso.com, and all other subdomains of contoso.com are blocked by the Sender Filter agent. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The maximum number of entries for this parameter is 800. @@ -139,9 +139,9 @@ Accept wildcard characters: False ### -BlockedSenders The BlockedSenders parameter specifies one or more SMTP email addresses to block. When the Sender Filter agent encounters a message from a sender on this list, the Sender Filter agent takes the action specified by the Action parameter. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The maximum number of entries for this parameter is 800. diff --git a/exchange/exchange-ps/exchange/Set-SettingOverride.md b/exchange/exchange-ps/exchange/Set-SettingOverride.md index 856e807a08..37ca3cc5c6 100644 --- a/exchange/exchange-ps/exchange/Set-SettingOverride.md +++ b/exchange/exchange-ps/exchange/Set-SettingOverride.md @@ -164,10 +164,10 @@ Accept wildcard characters: False ``` ### -Parameters -The Parameters parameter specifies one or more parameters for the override that are available for the combination of the Component and Section parameter values. This parameter uses the syntax @("\=\","\=\"...). For example: +The Parameters parameter specifies one or more parameters for the override that are available for the combination of the Component and Section parameter values. This parameter uses the syntax: `@("Parameter1=Value1","Parameter2=Value2"...)`. For example: -- @("Enabled=true") -- @("IMServerName=\","IMCertificateThumbprint=\") +- `@("Enabled=true")` +- `@("IMServerName=","IMCertificateThumbprint=")` ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-SharingPolicy.md b/exchange/exchange-ps/exchange/Set-SharingPolicy.md index ceeeabaa3e..c291c20722 100644 --- a/exchange/exchange-ps/exchange/Set-SharingPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SharingPolicy.md @@ -139,18 +139,18 @@ Accept wildcard characters: False ``` ### -Domains -The Domains parameter specifies domains to which this policy applies and the sharing policy action. Values for this parameter use the format \: \. +The Domains parameter specifies domains to which this policy applies and the sharing policy action. Values for this parameter use the format `Domain:SharingPolicyAction`. -The following sharing policy action values can be used: +The following SharingPolicyAction values can be used: - CalendarSharingFreeBusySimple: Share free/busy hours only. - CalendarSharingFreeBusyDetail: Share free/busy hours, subject, and location. - CalendarSharingFreeBusyReviewer: Share free/busy hours, subject, location, and the body of the message or calendar item. - ContactsSharing: Share contacts only. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. A domain doesn't include subdomains. You need to configure each subdomain separately. diff --git a/exchange/exchange-ps/exchange/Set-SiteMailbox.md b/exchange/exchange-ps/exchange/Set-SiteMailbox.md index fb956c6716..77f68b1cb6 100644 --- a/exchange/exchange-ps/exchange/Set-SiteMailbox.md +++ b/exchange/exchange-ps/exchange/Set-SiteMailbox.md @@ -182,7 +182,7 @@ You can use any value that uniquely identifies the member. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -211,7 +211,7 @@ You can use any value that uniquely identifies the owner. For example: - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] diff --git a/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md index cb93171114..d0ca71e855 100644 --- a/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md @@ -63,7 +63,7 @@ This example changes the warning quota to 9.5 GB and the prohibit send and recei Set-SiteMailboxProvisioningPolicy -Identity SM_DefaultPolicy -AliasPrefix Project ``` -This example changes the default provisioning policy named SM\_DefaultPolicy and sets the AliasPrefix value to Project. When you create new site mailboxes, the prefix Project- is automatically added to the alias. +This example changes the default provisioning policy named SM\_DefaultPolicy and sets the AliasPrefix value to Project. When you create new site mailboxes, the prefix `Project-` is automatically added to the alias. ## PARAMETERS @@ -128,7 +128,7 @@ Accept wildcard characters: False ### -DefaultAliasPrefixEnabled The DefaultAliasPrefixEnabled parameter specifies whether new site mailboxes have the default prefix text added to the alias. Valid values are: -- $true: Aliases get the default prefix text. This is the default value. In Microsoft 365, the default prefix text is SMO- (for example, the alias value BugBash\_2016 becomes SMO-BugBash\_2016). In on-premises Exchange, the default prefix text is SM- (for example, the alias value BugBash\_2016 becomes SM-BugBash\_2016). +- $true: Aliases get the default prefix text. This is the default value. In Microsoft 365, the default prefix text is `SMO-` (for example, the alias value `BugBash_2016` becomes `SMO-BugBash_2016`). In on-premises Exchange, the default prefix text is `SM-` (for example, the alias value `BugBash_2016` becomes `SM-BugBash_2016`). - $false: Aliases don't get the default prefix text. The value of this parameter is related to the value of the AliasPrefix parameter. If you specify a text string for AliasPrefix, the DefaultAliasPrefixEnabled value is ignored. Specifying a text value for AliasPrefix automatically sets the value to $false, but even if you set it to $true, the default alias prefix text isn't used. diff --git a/exchange/exchange-ps/exchange/Set-SmimeConfig.md b/exchange/exchange-ps/exchange/Set-SmimeConfig.md index 6a06eab0fd..a9d77a923c 100644 --- a/exchange/exchange-ps/exchange/Set-SmimeConfig.md +++ b/exchange/exchange-ps/exchange/Set-SmimeConfig.md @@ -316,7 +316,7 @@ Accept wildcard characters: False ``` ### -OWAEncryptionAlgorithms -The OWAEncryptionAlgorithms parameter specifies a list of symmetric encryption algorithms that are used by Outlook on the web to encrypt messages. Valid values are:: +The OWAEncryptionAlgorithms parameter specifies a list of symmetric encryption algorithms that are used by Outlook on the web to encrypt messages. Valid values are: - 6601: DES (56-bit) - 6602: RC2. Supported key lengths are 40, 56, 64, and 128. RC2 is the only supported algorithm that offers multiple key lengths. @@ -325,9 +325,9 @@ The OWAEncryptionAlgorithms parameter specifies a list of symmetric encryption a - 660F: AES192 - 6610: AES256 (This is the default value) -If you use a third-party cryptographic service provider (CSP), you need to specify the object identifier (OID) together with an algorithm ID (Outlook on the web needs an algorithm ID to infer how the algorithm should be used). For example, to provide a custom replacement for the 3DES algorithm, use the value 6603,\. +If you use a third-party cryptographic service provider (CSP), you need to specify the object identifier (OID) together with an algorithm ID (Outlook on the web needs an algorithm ID to infer how the algorithm should be used). For example, to provide a custom replacement for the 3DES algorithm, use the value `6603,`. -This parameter uses the syntax \ or RC2:\ or \,\. You can specify multiple values separated by semicolons (;). For example, to set the encryption algorithms to 3DES, RC2-128, RC2-64, DES, and RC2-56, use the following value: 6603;6602:128;6602:64;6601;6602:56. +This parameter uses the syntax `` or `RC2:` or `,`. You can specify multiple values separated by semicolons (;). For example, to set the encryption algorithms to 3DES, RC2-128, RC2-64, DES, and RC2-56, use the following value: `6603;6602:128;6602:64;6601;6602:56`. If the parameter is not specified or is not formatted correctly, Outlook on the web uses 6610 (AES256). If the encryption algorithm or minimum key length is not available on a client, Outlook on the web does not allow encryption. @@ -509,11 +509,11 @@ The OWASigningAlgorithms parameter specifies the list of symmetric encryption si - 800C: CALG\_SHA\_256 or 256-bit SHA - 8004: SHA1 or 160-bit SHA-1 (This is the default value) -If you use a third-party cryptographic service provider (CSP), you need to specify the object identifier (OID) together with an algorithm ID (Outlook on the web needs an algorithm ID to infer how the algorithm should be used). For example, to provide a custom replacement for the SHA1 algorithm, use the value 8804,\. +If you use a third-party cryptographic service provider (CSP), you need to specify the object identifier (OID) together with an algorithm ID (Outlook on the web needs an algorithm ID to infer how the algorithm should be used). For example, to provide a custom replacement for the SHA1 algorithm, use the value `8804,`. -This parameter uses the syntax \ or \:\ or \,\. You can specify multiple values separated by semicolons (;). +This parameter uses the syntax `` or `:` or `,`. You can specify multiple values separated by semicolons (;). -For example, to set the signing algorithms to CALG\_SHA\_512, SHA1, and CALG\_MD5, use the value 800E;8004;8003. +For example, to set the signing algorithms to CALG\_SHA\_512, SHA1, and CALG\_MD5, use the value `800E;8004;8003`. If this parameter is not specified or is not formatted correctly, Outlook on the web defaults to 8004 (SHA1). @@ -596,7 +596,7 @@ Accept wildcard characters: False ### -SMIMECertificateIssuingCA The SMIMECertificateIssuingCA parameter specifies the serialized certificate store (SST) that contains the Certificate Authority (CA) signing and intermediate certificate information. -You need to read the file to a byte-encoded object using the Get-Content cmdlet. For example: -SMIMECertificateIssuingCA $\(\[byte\[\]\]\(Get-Content -Encoding byte -Path "C:\\Temp\\CACertificateSerializedStore.sst" -ReadCount 0\) +You need to read the file to a byte-encoded object using the Get-Content cmdlet. For example: `-SMIMECertificateIssuingCA $([byte[]](Get-Content -Encoding byte -Path "C:\Temp\CACertificateSerializedStore.sst" -ReadCount 0)`. Each certificate is checked, and if any certificates are expired, the operation will fail. diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md index f5cc55ca34..c7afae509d 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md @@ -69,15 +69,15 @@ Accept wildcard characters: False ### -Condition The Condition parameter specifies the conditions and exceptions for the rule. This parameter uses the following syntax: -- User or group communications to supervise: "((Reviewee:\) -OR (Reviewee:\)...)". Exceptions use the syntax "(NOT((Reviewee:\) -OR (Reviewee:\)...))". -- Direction: "((Direction:Inbound) -OR (Direction:Outbound) -OR (Direction:Internal))". -- Message contains words: "((\) -OR (\)...)". Exceptions use the syntax "(NOT((\) -OR (\)...))". -- Any attachment contains words: "((Attachment:\) -OR (Attachment:\)...)". Exceptions use the syntax "(NOT((Attachment:\) -OR (Attachment:\)...))". -- Any attachment has the extension: "((AttachmentName:.\) -OR (AttachmentName:.\)...)". Exceptions use the syntax "(NOT((AttachmentName:.\) -OR (AttachmentName:.\)...))". -- Message size is larger than: "(MessageSize:\)". For example "(MessageSize:300KB)". Exceptions use the syntax "(NOT(MessageSize:\))". -- Any attachment is larger than: "(AttachmentSize:\)". For example "(AttachmentSize:3MB)". Exceptions use the syntax "(NOT(AttachmentSize:\))". +- User or group communications to supervise: `"((Reviewee:) -OR (Reviewee:)...)"`. Exceptions use the syntax `"(NOT((Reviewee:) -OR (Reviewee:)...))"`. +- Direction: `"((Direction:Inbound) -OR (Direction:Outbound) -OR (Direction:Internal))"`. +- Message contains words: `"(() -OR ()...)"`. Exceptions use the syntax `"(NOT(() -OR ()...))"`. +- Any attachment contains words: `"((Attachment:) -OR (Attachment:)...)"`. Exceptions use the syntax `"(NOT((Attachment:) -OR (Attachment:)...))"`. +- Any attachment has the extension: `"((AttachmentName:.) -OR (AttachmentName:.)...)"`. Exceptions use the syntax `"(NOT((AttachmentName:.) -OR (AttachmentName:.)...))"`. +- Message size is larger than: `"(MessageSize:)"`. For example `"(MessageSize:300KB)"`. Exceptions use the syntax `"(NOT(MessageSize:))"`. +- Any attachment is larger than: `"(AttachmentSize:)"`. For example `"(AttachmentSize:3MB)"`. Exceptions use the syntax `"(NOT(AttachmentSize:))"`. - Parentheses ( ) are required around the whole filter. -- Separate multiple conditions or exception types with the -AND operator. For example, "((Reviewee:chris@contoso.com) -AND (AttachmentSize:3MB))". +- Separate multiple conditions or exception types with the AND operator. For example, `"((Reviewee:chris@contoso.com) -AND (AttachmentSize:3MB))"`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-SweepRule.md b/exchange/exchange-ps/exchange/Set-SweepRule.md index c1eacd21bc..26b0e3adbf 100644 --- a/exchange/exchange-ps/exchange/Set-SweepRule.md +++ b/exchange/exchange-ps/exchange/Set-SweepRule.md @@ -58,8 +58,8 @@ This example modifies the existing rule that has the rule ID value x2hlsdpGmUifj The Identity parameter specifies the Sweep rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). -- Exchange Online: \\\\ (for example, rzaher\\x2hlsdpGmUifjFgxxGIOJw==. -- On-premises Exchange: \\\\ (for example, contoso.com/Users/Rick Zaher\\x2hlsdpGmUifjFgxxGIOJw==. +- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). +- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). You can get these identity values by using the Get-SweepRule cmdlet. diff --git a/exchange/exchange-ps/exchange/Set-SystemMessage.md b/exchange/exchange-ps/exchange/Set-SystemMessage.md index fd84be59cd..ee4d0484b5 100644 --- a/exchange/exchange-ps/exchange/Set-SystemMessage.md +++ b/exchange/exchange-ps/exchange/Set-SystemMessage.md @@ -61,14 +61,14 @@ The Identity parameter specifies the custom system message that you want to modi The identity value of a system message uses one of these formats: -- System messages for enhanced status codes: \\\\\\\. For example, En\\Internal\\5.1.2 or Ja\\External\\5.1.2. -- System messages for quotas: \\\\. For example, En\\ProhibitSendReceiveMailBox. +- System messages for enhanced status codes: `Language\\DSNCode`. For example, `En\Internal\5.1.2` or `Ja\External\5.1.2`. +- System messages for quotas: `Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailBox`. -\: For the list of supported language codes, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). +Language: For the list of supported language codes, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). -\: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system codes that are currently used by custom system messages, run the command Get-SystemMessage. To generate a list of default enhanced status codes that are used by Exchange, run this command: Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\\My Documents\\Default DSNs.html". +DSNCode: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system codes that are currently used by custom system messages, run the command Get-SystemMessage. To generate a list of default enhanced status codes that are used by Exchange, run this command: `Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\My Documents\Default DSNs.html"`. -\: Valid value are: +QuotaMessageType: Valid value are: Mailbox size quotas: @@ -197,24 +197,24 @@ This parameter can contain text and HTML tags. The maximum length is 512 charact The following HTML tags are available: -- \ and \ (bold) -- \ and \ (italic) -- \ (line break) -- \ and \ (paragraph) -- \ and \ (hyperlink) +- `` and `` (bold) +- `` and `` (italic) +- `
` (line break) +- `

` and `

` (paragraph) +- `
` and `` (hyperlink) You need to use single quotation marks (not double quotation marks) around the complete text string if you use the hyperlink tag. Otherwise, you'll receive an error (because of the double quotation marks in the tag). Use the following escape codes for these special characters: -- < for \<. -- > for \>. -- " for ". -- & for &. +- `<` for \< +- `>` for \> +- `"` for " +- `&` for & Here's an example value for this parameter that uses HTML tags and special characters: -'You tried to send a message to a \disabled\ mailbox. Please visit \Internal Support\ or contact "InfoSec" for more information.' +`'You tried to send a message to a disabled mailbox. Please visit Internal Support or contact "InfoSec" for more information.'` ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md index 62a41b40aa..fdeeac29ef 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md @@ -7,7 +7,7 @@ schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: -ROBOTS: NOINDEX, NOFOLLOW +ROBOTS: NOINDEX --- # Set-TenantAllowBlockListItems diff --git a/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md b/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md index d477f1abc4..2c8883cabc 100644 --- a/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md +++ b/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md @@ -197,7 +197,7 @@ Accept wildcard characters: False ``` ### -NotificationPhoneNumber -The NotificationPhoneNumber parameter specifies the telephone number to use for your text messaging notifications. This parameter uses the E.164 format: +\\ (for example, +15551234567). +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 diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md index acd1c6bec6..bbe36539c2 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md @@ -173,7 +173,7 @@ Set-ThrottlingPolicy [-Identity] ## DESCRIPTION Throttling policy settings are stored in Active Directory. -By default, there is one default user throttling policy named GlobalThrottlingPolicy with a throttling scope of Global. Microsoft Setup creates this policy as part of the Client Access server role. You shouldn't replace, re-create, or remove the existing default throttling policy. However, you can edit any additional throttling policies with the scope of Organization or Regular if you want to change your user throttling settings. You can create polices with the scope of Organization or Regular using the New-ThrottlingPolicy cmdlet. +By default, there is one default user throttling policy named GlobalThrottlingPolicy with a throttling scope of Global. Exchange Setup creates this policy as part of the Client Access server role. You shouldn't replace, re-create, or remove the existing default throttling policy. However, you can edit any additional throttling policies with the scope of Organization or Regular if you want to change your user throttling settings. You can create polices with the scope of Organization or Regular using the New-ThrottlingPolicy cmdlet. For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://docs.microsoft.com/Exchange/server-health/workload-management). @@ -183,7 +183,8 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$a = Get-ThrottlingPolicy RemoteSiteUserPolicy; $a | Set-ThrottlingPolicy -EwsMaxConcurrency 4 +$a = Get-ThrottlingPolicy RemoteSiteUserPolicy +$a | Set-ThrottlingPolicy -EwsMaxConcurrency 4 ``` This example modifies a throttling policy so that users associated with this policy can have a maximum of four concurrent requests running in Exchange Web Services. @@ -1498,7 +1499,7 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies the name of the object in Active Directory. The default policy is named DefaultThrottlingPolicy\. +The Name parameter specifies the name of the object in Active Directory. The default policy is named `DefaultThrottlingPolicy`. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index 43077bb82b..feef90c869 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -50,7 +50,7 @@ This example associates a user with a username of tonysmith to the throttling po ### Example 2 ```powershell -$b = Get-ThrottlingPolicy ITStaffPolicy; +$b = Get-ThrottlingPolicy ITStaffPolicy Set-Mailbox -Identity tonysmith -ThrottlingPolicy $b ``` diff --git a/exchange/exchange-ps/exchange/Set-TransportConfig.md b/exchange/exchange-ps/exchange/Set-TransportConfig.md index d83d65dea8..5039a5e0cb 100644 --- a/exchange/exchange-ps/exchange/Set-TransportConfig.md +++ b/exchange/exchange-ps/exchange/Set-TransportConfig.md @@ -417,13 +417,13 @@ Accept wildcard characters: False ### -ExternalPostmasterAddress The ExternalPostmasterAddress parameter specifies the email address in the From header field of an external DSN message. The default value is blank ($null). -The default value means the external postmaster address is postmaster@\ in the following locations: +The default value means the external postmaster address is `postmaster@` in the following locations: - On Hub Transport servers or the Transport service on Mailbox servers. - On Edge Transport servers that are subscribed to the Exchange organization. - In Exchange Online. -On Edge Transport servers that aren't subscribed to the Exchange organization, the default external postmaster email address is postmaster@\. +On Edge Transport servers that aren't subscribed to the Exchange organization, the default external postmaster email address is `postmaster@`. To override the default behavior, you can specify an email address for the ExternalPostMasterAddress parameter. @@ -472,13 +472,13 @@ DSN codes are entered as x.y.z and are separated by commas. By default, the foll - 5.2.0 - 5.1.4 -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Although these DSN codes are monitored by default, the associated NDRs aren't copied to the Exchange recipient or to the external postmaster address if no mailbox is assigned to the Exchange recipient or to the external postmaster address. By default, no mailbox is assigned to the Exchange recipient or to the external postmaster address. -To assign a mailbox to the Exchange recipient, use the Set-OrganizationConfig cmdlet with the MicrosoftExchangeRecipientReplyRecipient parameter. To assign a mailbox to the external postmaster address, create a new mailbox postmaster. The default email address policy of the Exchange organization should automatically add an SMTP address of postmaster@\ to the mailbox. +To assign a mailbox to the Exchange recipient, use the Set-OrganizationConfig cmdlet with the MicrosoftExchangeRecipientReplyRecipient parameter. To assign a mailbox to the external postmaster address, create a new mailbox postmaster. The default email address policy of the Exchange organization should automatically add an SMTP address of `postmaster@` to the mailbox. ```yaml Type: MultiValuedProperty @@ -630,9 +630,9 @@ This parameter is available only in on-premises Exchange. The InternalSMTPServers parameter specifies a list of internal SMTP server IP addresses or IP address ranges that should be ignored by Sender ID and connection filtering. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -1235,9 +1235,9 @@ The TLSReceiveDomainSecureList parameter specifies the domains from which you wa - Specify the domains to which you want to send domain secured email by using the TLSSendDomainSecureList parameter. - Enable Domain Security (Mutual Auth TLS) on the Send connectors that send messages to the domains that you specified in the TLSSendDomainSecureList parameter. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. The wildcard character (\*) isn't supported in the domains listed in the TLSReceiveDomainSecureList parameter or in the TLSSendDomainSecureList parameter. The default value for both parameters is an empty list ({}). @@ -1263,9 +1263,9 @@ The TLSSendDomainSecureList parameter specifies the domains from which you want - Specify the domains from which you want to receive domain secured email by using the TLSReceiveDomainSecureList parameter. - Enable Domain Security (Mutual Auth TLS) and the TLS authentication method on the Receive connectors that receive messages from the domains that you specified in the TLSReceiveDomainSecureList parameter. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. Multiple domains may be separated by commas. The wildcard character (\*) isn't supported in the domains listed in the TLSSendDomainSecureList parameter or in the TLSReceiveSecureList parameter. The default values for both parameters are an empty list ({}). diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 53119affbb..e6156e77ba 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -376,7 +376,7 @@ The AddToRecipients parameter specifies an action that adds recipients to the To - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -405,11 +405,11 @@ The AnyOfCcHeader parameter specifies a condition that looks for recipients in t - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -438,11 +438,11 @@ The AnyOfCcHeaderMemberOf parameter specifies a condition that looks for group m - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -466,7 +466,7 @@ The AnyOfRecipientAddressContainsWords parameter specifies a condition that look A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: Word[] @@ -486,11 +486,11 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. -The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: Pattern[] @@ -519,11 +519,11 @@ The AnyOfToCcHeader parameter specifies a condition that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -552,11 +552,11 @@ The AnyOfToCcHeaderMemberOf parameter specifies a condition that looks for group - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -585,11 +585,11 @@ The AnyOfToHeader parameter specifies a condition that looks for recipients in t - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -618,11 +618,11 @@ The AnyOfToHeaderMemberOf parameter specifies a condition that looks for group m - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this condition applies the rule action to all recipients of the message. For example, if the action is to reject the message, the message is rejected for all recipients of the message, not just for the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -693,7 +693,7 @@ In on-premises Exchange, this action is only available on Mailbox servers. The ApplyHtmlDisclaimerLocation parameter specifies where to insert the HTML disclaimer text in the body of messages. Valid values are: - Append: The disclaimer is added to the end of the message body. This is the default value. -- Prepend: The disclaimer is inserted to the beginning of the message body. +- Prepend: The disclaimer is inserted at the beginning of the message body. If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Append is used. @@ -921,7 +921,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The AttachmentMatchesPatterns parameter specifies a condition that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. -You can specify multiple text patterns by using the following syntax: "\","\",..."\". +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. Only the first 150 kilobytes (KB) of the attachment is scanned when trying to match a text pattern. @@ -943,7 +943,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. -The AttachmentNameMatchesPatterns parameter specifies a condition that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The AttachmentNameMatchesPatterns parameter specifies a condition that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] @@ -1068,7 +1068,7 @@ The BetweenMemberOf1 parameter specifies a condition that looks for messages tha - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1097,7 +1097,7 @@ The BetweenMemberOf2 parameter specifies a condition that looks for messages tha - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1126,7 +1126,7 @@ The BlindCopyTo parameter specifies an action that adds recipients to the Bcc fi - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1212,7 +1212,7 @@ The CopyTo parameter specifies an action that adds recipients to the Cc field of - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1398,11 +1398,11 @@ The ExceptIfAnyOfCcHeader parameter specifies an exception that looks for recipi - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1431,11 +1431,11 @@ The ExceptIfAnyOfCcHeaderMemberOf parameter specifies an exception that looks fo - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1459,7 +1459,7 @@ The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: Word[] @@ -1479,11 +1479,11 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. -The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: Pattern[] @@ -1512,11 +1512,11 @@ The ExceptIfAnyOfToCcHeader parameter specifies an exception that looks for reci - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1545,11 +1545,11 @@ The ExceptIfAnyOfToCcHeaderMemberOf parameter specifies an exception that looks - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1578,11 +1578,11 @@ The ExceptIfAnyOfToHeader parameter specifies an exception that looks for recipi - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1611,11 +1611,11 @@ The ExceptIfAnyOfToHeaderMemberOf parameter specifies an exception that looks fo - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. A match for this exception prevents the rule action from being applied to all recipients of the message. For example, if the action is to reject the message, the message is delivered to all recipients of the message, not just to the specified recipients. -Note: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. +**Note**: This condition or exception doesn't consider messages that are sent to recipient proxy addresses. It only matches messages that are sent to the recipient's primary email address. ```yaml Type: RecipientIdParameter[] @@ -1750,7 +1750,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfAttachmentMatchesPatterns parameter specifies an exception that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. -You can specify multiple text patterns by using the following syntax: "\","\",..."\". +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. Only the first 150 KB of the attachment is scanned when trying to match a text pattern. @@ -1772,7 +1772,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is only available on Mailbox servers. -The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] @@ -1895,7 +1895,7 @@ The ExceptIfBetweenMemberOf1 parameter specifies an exception that looks for mes - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1924,7 +1924,7 @@ The ExceptIfBetweenMemberOf2 parameter specifies an exception that looks for mes - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -1975,7 +1975,7 @@ The ExceptIfFrom parameter specifies an exception that looks for messages from s - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -2019,7 +2019,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. -The ExceptIfFromAddressMatchesPatterns parameter specifies an exception that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfFromAddressMatchesPatterns parameter specifies an exception that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -2050,7 +2050,7 @@ The ExceptIfFromMemberOf parameter specifies an exception that looks for message - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -2231,7 +2231,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. -The ExceptIfHeaderMatchesPatterns parameter specifies an exception that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfHeaderMatchesPatterns parameter specifies an exception that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. You specify the header field to search by using the ExceptIfHeaderMatchesMessageHeader parameter. @@ -2262,7 +2262,7 @@ The ExceptIfManagerAddresses parameter specifies the users (managers) for the Ex - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You specify if you want to look for these users as managers of senders or recipients by using the ExceptIfManagerForEvaluatedUser parameter. @@ -2329,7 +2329,7 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfMessageContainsDataClassifications parameter specifies an exception that looks for sensitive information types in the body of messages, and in any attachments. -This parameter uses the syntax @{\},@{\},...@{\}. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. +This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). @@ -2384,13 +2384,13 @@ In on-premises Exchange, this exception is only available on Mailbox servers. The ExceptIfMessageTypeMatches parameter specifies an exception that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook or Outlook). +- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). - Encrypted: Encrypted messages. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured. - Voicemail: Voice mail messages forwarded by Unified Messaging service. - Signed: Digitally signed messages. -- ApprovalRequest: Moderations request messages sent to moderators. +- ApprovalRequest: Moderation request messages sent to moderators. - ReadReceipt: Read receipts. ```yaml @@ -2541,7 +2541,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is only available on Mailbox servers. -The ExceptIfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -2840,7 +2840,7 @@ The ExceptIfSentTo parameter specifies an exception that looks for recipients in - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -2865,7 +2865,7 @@ The ExceptIfSentToMemberOf parameter specifies an exception that looks for messa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. @@ -2934,7 +2934,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. -The ExceptIfSubjectMatchesPatterns parameter specifies an exception that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfSubjectMatchesPatterns parameter specifies an exception that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] @@ -2976,7 +2976,7 @@ This parameter specifies an exception or part of an exception for the rule. The In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. -The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] @@ -3049,7 +3049,7 @@ The From parameter specifies a condition that looks for messages from specific s - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -3093,7 +3093,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. -The FromAddressMatchesPatterns parameter specifies a condition that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The FromAddressMatchesPatterns parameter specifies a condition that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -3124,7 +3124,7 @@ The FromMemberOf parameter specifies a condition that looks for messages sent by - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -3363,7 +3363,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. -The HeaderMatchesPatterns parameter specifies a condition that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The HeaderMatchesPatterns parameter specifies a condition that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. You specify the header field to search by using the HeaderMatchesMessageHeader parameter. @@ -3459,7 +3459,7 @@ The entry contains the following information: - Source: MSExchange Messaging Policies - Event ID: 4000 - Task Category: Rules -- EventData: The following message is logged by an action in the rules: \ +- EventData: `The following message is logged by an action in the rules: ` ```yaml Type: EventLogText @@ -3488,7 +3488,7 @@ The ManagerAddresses parameter specifies the users (managers) for the ExceptIfMa - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You specify if you want to look for these users as managers of senders or recipients by using the ManagerForEvaluatedUser parameter. @@ -3555,7 +3555,7 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The MessageContainsDataClassifications parameter specifies a condition that looks for sensitive information types in the body of messages, and in any attachments. -This parameter uses the syntax @{\},@{\},...@{\}. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. +This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). @@ -3612,13 +3612,13 @@ In on-premises Exchange, this condition is only available on Mailbox servers. The MessageTypeMatches parameter specifies a condition that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook or Outlook). +- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). - Encrypted: Encrypted messages. - Calendaring: Meeting requests and responses. - PermissionControlled: Messages that have specific permissions configured. - Voicemail: Voice mail messages forwarded by Unified Messaging service. - Signed: Digitally signed messages. -- ApprovalRequest: Moderations request messages sent to moderators. +- ApprovalRequest: Moderation request messages sent to moderators. - ReadReceipt: Read receipts. ```yaml @@ -3693,7 +3693,7 @@ The ModerateMessageByUser parameter specifies an action that forwards messages f - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You can't use a distribution group as a moderator. @@ -3761,7 +3761,7 @@ This parameter specifies an action or part of an action for the rule. In on-premises Exchange, this action is available on Mailbox servers and Edge Transport servers. -The PrependSubject parameter specifies an action that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks (")\> +The PrependSubject parameter specifies an action that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. @@ -3960,7 +3960,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is only available on Mailbox servers. -The RecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The RecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -4031,7 +4031,7 @@ The RedirectMessageTo parameter specifies a rule action that redirects messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -4519,7 +4519,7 @@ The SentTo parameter specifies a condition that looks for recipients in messages - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: RecipientIdParameter[] @@ -4548,7 +4548,7 @@ The SentToMemberOf parameter specifies a condition that looks for messages sent - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. @@ -4772,7 +4772,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. -The SubjectMatchesPatterns parameter specifies a condition that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The SubjectMatchesPatterns parameter specifies a condition that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] @@ -4814,7 +4814,7 @@ This parameter specifies a condition or part of a condition for the rule. The na In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. -The SubjectOrBodyMatchesPatterns parameter specifies a condition that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: "\","\",..."\". +The SubjectOrBodyMatchesPatterns parameter specifies a condition that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. ```yaml Type: Pattern[] diff --git a/exchange/exchange-ps/exchange/Set-TransportServer.md b/exchange/exchange-ps/exchange/Set-TransportServer.md index a9f23f387f..1a22084ab6 100644 --- a/exchange/exchange-ps/exchange/Set-TransportServer.md +++ b/exchange/exchange-ps/exchange/Set-TransportServer.md @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-TransportServer cmdlet to modify settings that are associated with the Hub Transport server role or the Edge Transport server role. -Note: In Exchange 2013 or later, use the Set-TransportService cmdlet instead. If you have scripts that use Set-TransportServer, update them to use Set-TransportService. +**Note**: In Exchange 2013 or later, use the Set-TransportService cmdlet instead. If you have scripts that use Set-TransportServer, update them to use Set-TransportService. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -744,9 +744,9 @@ Accept wildcard characters: False ### -ExternalDNSServers The ExternalDNSServers parameter specifies the list of external DNS servers that the server queries when resolving a remote domain. DNS servers are specified by IP address. The default value is an empty list ({}). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the ExternalDNSServers parameter and its list of DNS servers isn't used. @@ -834,9 +834,9 @@ Accept wildcard characters: False ### -InternalDNSServers The InternalDNSServers parameter specifies the list of DNS servers that should be used when resolving a domain name. DNS servers are specified by IP address. The default value is any empty list ({}). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. 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. diff --git a/exchange/exchange-ps/exchange/Set-TransportService.md b/exchange/exchange-ps/exchange/Set-TransportService.md index 7dc0c977f4..8a80004b96 100644 --- a/exchange/exchange-ps/exchange/Set-TransportService.md +++ b/exchange/exchange-ps/exchange/Set-TransportService.md @@ -778,9 +778,9 @@ Accept wildcard characters: False ### -ExternalDNSServers The ExternalDNSServers parameter specifies the list of external DNS servers that the server queries when resolving a remote domain. DNS servers are specified by IP address. The default value is an empty list ({}). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. If the value of the ExternalDNSAdapterEnabled parameter is set to $true, the ExternalDNSServers parameter and its list of DNS servers isn't used. @@ -866,9 +866,9 @@ Accept wildcard characters: False ### -InternalDNSServers The InternalDNSServers parameter specifies the list of DNS servers that should be used when resolving a domain name. DNS servers are specified by IP address. The default value is any empty list ({}). -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. 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. diff --git a/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md index ab58fa58e3..8cfff14ce1 100644 --- a/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md +++ b/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md @@ -376,7 +376,7 @@ Accept wildcard characters: False ### -BusinessHoursSchedule The BusinessHoursSchedule parameter specifies the hours the business is open. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. You can specify multiple schedules separated by commas: "\","\",..."\". +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. You can use the following values for days: diff --git a/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md b/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md index d6cb493937..1b44ec3731 100644 --- a/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md +++ b/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md @@ -84,7 +84,6 @@ Accept pipeline input: True Accept wildcard characters: False ``` - ### -Confirm The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. @@ -107,9 +106,9 @@ Accept wildcard characters: False ### -DialPlans The DialPlans parameter specifies the dial plan used by the Microsoft Exchange Unified Messaging Call Router service. The Exchange server only needs to be associated with a UM dial plan if Lync Server 2010, Lync Server 2013, or Skype for Business Server 2015 is used in your organization. To remove an Exchange server from a dial plan, use $null. The default is no dial plans assigned. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-UMDialPlan.md b/exchange/exchange-ps/exchange/Set-UMDialPlan.md index 6dea4a99d5..f47e0c6367 100644 --- a/exchange/exchange-ps/exchange/Set-UMDialPlan.md +++ b/exchange/exchange-ps/exchange/Set-UMDialPlan.md @@ -103,7 +103,9 @@ This example configures the UM dial plan MyDialPlan to use a welcome greeting. ### Example 3 ```powershell -$csv=import-csv "C:\MyInCountryGroups.csv"; Set-UMDialPlan -Identity MyDialPlan -ConfiguredInCountryOrRegionGroups $csv; Set-UMDialPlan -Identity MyDialPlan -AllowedInCountryOrRegionGroups "local, long distance" +$csv=import-csv "C:\MyInCountryGroups.csv" +Set-UMDialPlan -Identity MyDialPlan -ConfiguredInCountryOrRegionGroups $csv +Set-UMDialPlan -Identity MyDialPlan -AllowedInCountryOrRegionGroups "local, long distance" ``` This example configures the UM dial plan MyDialPlan with dialing rules. diff --git a/exchange/exchange-ps/exchange/Set-UMMailbox.md b/exchange/exchange-ps/exchange/Set-UMMailbox.md index 73f0faf28a..a2a80f1ecf 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailbox.md +++ b/exchange/exchange-ps/exchange/Set-UMMailbox.md @@ -381,7 +381,7 @@ Accept wildcard characters: False ### -PhoneProviderId This parameter is available only in the cloud-based service. -The PhoneProviderId parameter specifies the user's phone number and mobile service provider. This information is used to provide custom call forwarding and cancelling voice mail setup instructions based on the mobile phone provider. +The PhoneProviderId parameter specifies the user's phone number and mobile service provider. This information is used to provide custom call forwarding and cancelling voice mail set up instructions based on the mobile phone provider. ```yaml Type: String diff --git a/exchange/exchange-ps/exchange/Set-UMService.md b/exchange/exchange-ps/exchange/Set-UMService.md index 50f66a0e42..0590333364 100644 --- a/exchange/exchange-ps/exchange/Set-UMService.md +++ b/exchange/exchange-ps/exchange/Set-UMService.md @@ -124,9 +124,9 @@ Exchange 2016 and Exchange 2013 servers can't be associated with a TelExt or E.1 You can also use this parameter to associate Exchange 2010 Unified Messaging servers to a UM dial plan. -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -160,7 +160,7 @@ Accept wildcard characters: False ### -GrammarGenerationSchedule The GrammarGenerationSchedule parameter specifies the scheduled times to start speech grammar generation. This parameter allows only one start time per day. The default scheduled time for grammar generation is 02:00-02:30 local time each day. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. You can specify multiple schedules separated by commas: "\","\",..."\". +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. You can use the following values for days: diff --git a/exchange/exchange-ps/exchange/Set-UmServer.md b/exchange/exchange-ps/exchange/Set-UmServer.md index 21d58c1a1c..035feab84b 100644 --- a/exchange/exchange-ps/exchange/Set-UmServer.md +++ b/exchange/exchange-ps/exchange/Set-UmServer.md @@ -172,7 +172,7 @@ Accept wildcard characters: False ### -GrammarGenerationSchedule The GrammarGenerationSchedule parameter specifies the scheduled times to start speech grammar generation. This parameter allows only one start time per day. The default scheduled time for grammar generation is 02:00-02:30 local time each day. -The syntax for this parameter is: StartDay.Hour:Minute \[AM/PM\]-EndDay.Hour:Minute \[AM/PM\]. You can specify multiple schedules separated by commas: "\","\",..."\". +The syntax for this parameter is: `StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]`. You can specify multiple schedules separated by commas: `"Schedule1","Schedule2",..."ScheduleN"`. You can use the following values for days: diff --git a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md index 1860fb2128..6ceb0bd269 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md @@ -104,6 +104,7 @@ The RetentionDuration parameter specifies how long audit log records are kept. V - SixMonths - NineMonths - TwelveMonths +- TenYears This parameter is required when modifying an audit log retention policy. @@ -111,7 +112,7 @@ This parameter is required when modifying an audit log retention policy. Type: UnifiedAuditLogRetentionDuration Parameter Sets: (All) Aliases: -Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths +Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears Applicable: Security & Compliance Center Required: True @@ -159,7 +160,7 @@ Accept wildcard characters: False ### -Operations The Operations parameter specifies the audit log operations that are retained by the policy. The values you specify will overwrite any existing entries. For a list of the available values for this parameter, see [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -194,7 +195,7 @@ Accept wildcard characters: False ### -UserIds The UserIds parameter specifies the audit logs that are retained by the policy based on the ID of the user who performed the action. The values you specify will overwrite any existing entries. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md index 88cefda9f7..2aa1628970 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedGroup.md @@ -146,7 +146,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. By default, this parameter is blank ($null), which allows this recipient to accept messages from all senders. @@ -169,7 +169,7 @@ The AccessType parameter specifies the privacy type for the Microsoft 365 Group. - Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. - Private: The group content and conversations are only available to members of the group, and joining the group requires approval from a group owner. -Note: Although a user needs to be a member to participate in a private group, anyone can send email to a private group, and receive replies from the private group. +**Note**: Although a user needs to be a member to participate in a private group, anyone can send email to a private group, and receive replies from the private group. ```yaml Type: ModernGroupTypeInfo @@ -187,7 +187,7 @@ Accept wildcard characters: False ### -Alias The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Microsoft 365 Group. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. -The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. ```yaml Type: String @@ -270,7 +270,7 @@ The CalendarMemberReadOnly switch specifies whether to set read-only Calendar pe - To set read-only Calendar permissions, use the CalendarMemberReadOnly switch without a value. - To remove read-only Calendar permissions, use this exact syntax: -CalendarMemberReadOnly:$false. -To view the current value of the CalendarMemberReadOnly property on a Microsoft 365 Group, replace \ with the email address of the group, and run this command: Get-UnifiedGroup -Identity \ -IncludeAllProperties | Format-List \*Calendar\*. +To view the current value of the CalendarMemberReadOnly property on a Microsoft 365 Group, replace `` with the email address of the group, and run this command: `Get-UnifiedGroup -Identity -IncludeAllProperties | Format-List *Calendar*`. ```yaml Type: SwitchParameter @@ -624,24 +624,24 @@ Accept wildcard characters: False ### -EmailAddresses The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is \:\,\:\,...\:\. The optional \ value specifies the type of email address. Some examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a \ value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: -- Use the \ value SMTP on the address. -- The first email address when you don't use any \ values, or when you use multiple \ values of smtp. +- Use the Type value SMTP on the address. +- The first email address when you don't use any Type values, or when you use multiple lowercase smtp Type values. - Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. -To replace all existing proxy email addresses with the values you specify, use the following syntax: "\:\","\:\",..."\:\". +To replace all existing proxy email addresses with the values you specify, use the following syntax: `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. -To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="\:\","\:\",...; Remove="\:\","\:\",...}. +To add or remove specify proxy addresses without affecting other existing values, use the following syntax: `@{Add="Type:EmailAddress1","Type:EmailAddress2",...; Remove="Type:EmailAddress3","Type:EmailAddress4",...}`. ```yaml Type: ProxyAddressCollection @@ -659,9 +659,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute1 This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -679,9 +679,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute2 This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -699,9 +699,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute3 This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -719,9 +719,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute4 This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -739,9 +739,9 @@ Accept wildcard characters: False ### -ExtensionCustomAttribute5 This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You can specify up to 1300 values separated by commas. -To enter multiple values that overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values that overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. ```yaml Type: MultiValuedProperty @@ -773,7 +773,7 @@ Accept wildcard characters: False ``` ### -GrantSendOnBehalfTo -The GrantSendOnBehalfTo parameter specifies who can send on behalf of this Microsoft 365 Group. Although messages that are sent on behalf of the group clearly show the sender in the From field (\ on behalf of \), replies to these messages are delivered to the group, not the sender. +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: @@ -788,9 +788,9 @@ The sender you specify for this parameter must a mailbox, mail user or mail-enab - SamAccountName - User ID or user principal name (UPN) -To enter multiple values and overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "\","\",..."\". +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="\","\"...; Remove="\","\"...}. +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. By default, this parameter is blank, which means no one else has permission to send on behalf of this Microsoft 365 Group group. @@ -884,8 +884,8 @@ The MailTip parameter specifies the custom MailTip text for this recipient. The When you add a MailTip to a recipient, two things happen: -- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \\This mailbox is not monitored\\. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. -- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. +- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: `This mailbox is not monitored`. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters. +- The text is automatically added to the MailTipTranslations property of the recipient as the default value: `default:`. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa. ```yaml Type: String @@ -905,11 +905,11 @@ The MailTipTranslations parameter specifies additional languages for the custom To add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax: -@{Add="\:\","\:\"...; Remove="\:\","\:\"...} +`@{Add="Culture1:Localized text 1","\Culture2:Localized text 2"...; Remove="Culture3:Localized text 3","Culture4:Localized text 4"...}`. -\ is a valid ISO 639 two-letter culture code that's associated with the language. +CultureN is a valid ISO 639 two-letter culture code that's associated with the language. -For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: @{Add="ES:Esta caja no se supervisa."}. +For example, suppose this recipient currently has the MailTip text: "This mailbox is not monitored." To add the Spanish translation, use the following value for this parameter: `@{Add="ES:Esta caja no se supervisa."}`. ```yaml Type: MultiValuedProperty @@ -992,7 +992,7 @@ The ModeratedBy parameter specifies one or more moderators for this recipient. A - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true. @@ -1076,7 +1076,7 @@ To specify senders for this parameter, you can use any value that uniquely ident - Email address - GUID -You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. To add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters. diff --git a/exchange/exchange-ps/exchange/Set-User.md b/exchange/exchange-ps/exchange/Set-User.md index 445bcc5b97..84e97805bd 100644 --- a/exchange/exchange-ps/exchange/Set-User.md +++ b/exchange/exchange-ps/exchange/Set-User.md @@ -26,6 +26,8 @@ Set-User [-Identity] [-Arbitration] [-AssistantName ] [-AuthenticationPolicy ] + [-BlockCloudCache ] + [-CanHaveCloudCache ] [-CertificateSubject ] [-City ] [-Company ] @@ -67,6 +69,7 @@ Set-User [-Identity] [-SamAccountName ] [-SeniorityIndex ] [-SimpleDisplayName ] + [-SkipDualWrite] [-StateOrProvince ] [-StreetAddress ] [-StsRefreshTokensValidFrom ] @@ -75,6 +78,7 @@ Set-User [-Identity] [-UMCallingLineIds ] [-UMDtmfMap ] [-UserPrincipalName ] + [-VIP ] [-WebPage ] [-WhatIf] [-WindowsEmailAddress ] @@ -204,6 +208,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BlockCloudCache +This parameter is available only in the cloud-based service. + +{{ Fill BlockCloudCache Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CanHaveCloudCache +This parameter is available only in the cloud-based service. + +{{ Fill CanHaveCloudCache Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CertificateSubject This parameter is available only in on-premises Exchange. @@ -724,9 +764,7 @@ The PermanentlyClearPreviousMailboxInfo switch specifies whether to clear the Ex Clearing these attributes might be required in mailbox move and re-licensing scenarios between on-premises Exchange and Microsoft 365. For more information, see [Permanently Clear Previous Mailbox Info](https://techcommunity.microsoft.com/t5/exchange-team-blog/permanently-clear-previous-mailbox-info/ba-p/607619). -> - [!CAUTION] -> This switch permanently deletes the existing cloud mailbox and its associated archive, prevents you from reconnecting to the mailbox, and prevents you from recovering content from the mailbox. +**Caution**: This switch permanently deletes the existing cloud mailbox and its associated archive, prevents you from reconnecting to the mailbox, and prevents you from recovering content from the mailbox. ```yaml Type: SwitchParameter @@ -884,7 +922,7 @@ Accept wildcard characters: False ### -SamAccountName This parameter is available only in on-premises Exchange. -The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. +The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, \_, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters. ```yaml Type: String @@ -921,7 +959,8 @@ The SimpleDisplayName parameter is used to display an alternative description of - a - z - A - Z - 0 - 9 -- "\", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?". +- space +- `" ' ( ) + , - . / : ?` ```yaml Type: String @@ -936,6 +975,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SkipDualWrite +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StateOrProvince The StateOrProvince parameter specifies the user's state or province. @@ -1043,17 +1100,17 @@ Accept wildcard characters: False ### -UMDtmfMap The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax: -- emailAddress:\ -- lastNameFirstName:\ -- firstNameLastName:\ +- `emailAddress:` +- `lastNameFirstName:` +- `firstNameLastName:` -To enter values that overwrite all existing entries, use the following syntax: emailAddress:\,lastNameFirstName:\,firstNameLastName:\. +To enter values that overwrite all existing entries, use the following syntax: `emailAddress:,lastNameFirstName:,firstNameLastName:`. -If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:\, all existing lastNameFirstName and firstNameLastName values are removed. +If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only `emailAddress:`, all existing lastNameFirstName and firstNameLastName values are removed. -To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"; Remove="emailAddress:\","lastNameFirstName:\","firstNameLastName:\"}. +To add or remove values without affecting other existing entries, use the following syntax: `@{Add="emailAddress:","lastNameFirstName:","firstNameLastName:"; Remove="emailAddress:","lastNameFirstName:","firstNameLastName:"}`. -If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:\","emailAddress:\} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. +If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use `@{Add="emailAddress:","emailAddress:}` to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values. ```yaml Type: MultiValuedProperty @@ -1071,7 +1128,7 @@ Accept wildcard characters: False ### -UserPrincipalName This parameter is available only in on-premises Exchange. -The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format \@\. Typically, the \ value is the domain where the user account resides. +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 @@ -1086,6 +1143,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VIP +This parameter is available only in the cloud-based service. + +The VIP parameter specifies whether the user is a priority account. Valid values are: + +- $true: The user is a priority account. +- $false: The user is not a priority account. + +For more information about priority accounts, see [Manage and monitor priority accounts](https://docs.microsoft.com/microsoft-365/admin/setup/priority-accounts). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WebPage The WebPage parameter specifies the user's Web page. diff --git a/exchange/exchange-ps/exchange/Set-UserAnalyticsConfig.md b/exchange/exchange-ps/exchange/Set-UserAnalyticsConfig.md index c6916bce96..d0535f0b03 100644 --- a/exchange/exchange-ps/exchange/Set-UserAnalyticsConfig.md +++ b/exchange/exchange-ps/exchange/Set-UserAnalyticsConfig.md @@ -43,10 +43,10 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -Set-UserAnalyticsConfig -Identity "Kathleen Reiter" -PrivacyMode OptIn +Set-UserAnalyticsConfig -Identity "Kathleen Reiter" -PrivacyMode Opt-In ``` -This example sets the MyAnalytics privacy setting to OptIn for the user named Kathleen Reiter. +This example sets the MyAnalytics privacy setting to Opt-In for the user named Kathleen Reiter. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md b/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md index 8958994a7b..73aea79e27 100644 --- a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md @@ -14,8 +14,6 @@ ms.author: chrisda ## SYNOPSIS This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). -**Note**: This cmdlet is being replaced by the [Set-MyAnalyticsFeatureConfig](https://docs.microsoft.com/powershell/module/exchange/set-myanalyticsfeatureconfig) cmdlet. - Use the Set-UserBriefingConfig cmdlet to enable or disable the Briefing for a user. For more details about configuring the Briefing, see [Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin). For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). diff --git a/exchange/exchange-ps/exchange/Set-UserPhoto.md b/exchange/exchange-ps/exchange/Set-UserPhoto.md index 3470ab1c3e..d4413e3080 100644 --- a/exchange/exchange-ps/exchange/Set-UserPhoto.md +++ b/exchange/exchange-ps/exchange/Set-UserPhoto.md @@ -103,7 +103,8 @@ This example uploads and saves a photo to Paul Cannon's user account using a sin ### Example 2 ```powershell -Set-UserPhoto -Identity "Ann Beebe" -PictureData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\AnnBeebe.jpg")) -Preview; Set-UserPhoto "Ann Beebe" -Save +Set-UserPhoto -Identity "Ann Beebe" -PictureData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\AnnBeebe.jpg")) -Preview +Set-UserPhoto "Ann Beebe" -Save ``` This example shows how to use two commands to upload and save a preview photo to Ann Beebe's user account. The first command uploads a preview photo to Ann Beebe's user account, and the second command saves the uploaded photo as the preview photo. @@ -165,7 +166,7 @@ Accept wildcard characters: False ### -PictureData The PictureData parameter specifies the photo file that will be uploaded to the user's account. -This parameter uses the syntax ([System.IO.File]::ReadAllBytes("\")). The following is an example. ([System.IO.File]::ReadAllBytes("C:\\Documents\\Pictures\\MyPhoto.jpg")). +This parameter uses the syntax: `([System.IO.File]::ReadAllBytes(""))`. For example `([System.IO.File]::ReadAllBytes("C:\Documents\Pictures\MyPhoto.jpg"))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md index bc7459c861..a11c1c8d60 100644 --- a/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md @@ -38,7 +38,6 @@ Set-WebServicesVirtualDirectory [-Identity] [-MRSProxyEnabled ] [-MRSProxyMaxConnections ] [-OAuthAuthentication ] - [-OAuthAuthentication ] [-UpdateManagementVirtualDirectory] [-WhatIf] [-WindowsAuthentication ] @@ -77,11 +76,11 @@ This example enables MRSProxy on the EWS default website. MRSProxy is the servic ### -Identity 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 \\\Name +- Name or Server\\Name - Distinguished name (DN) - GUID -The Name value uses the syntax "\ (\)" from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax \\*. +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. ```yaml Type: VirtualDirectoryIdParameter @@ -116,7 +115,7 @@ Accept wildcard characters: False ``` ### -CertificateAuthentication -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. +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 @@ -211,7 +210,7 @@ Accept wildcard characters: False The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. -- Single SPN or comma delimited list of valid SPNs: The SPN value format is \/\. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. ```yaml Type: MultiValuedProperty @@ -233,9 +232,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend - Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. - Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. -Note: - -If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. ```yaml Type: ExtendedProtectionTokenCheckingMode diff --git a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md index 57675cd76e..061b13d568 100644 --- a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md +++ b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md @@ -101,17 +101,17 @@ Accept wildcard characters: False ### -ReportType The ReportType parameter specifies the type of historical search that you want to perform. You can use one of the following values: -- ATPReport: Advanced Threat Protection File Types Report and Advanced Threat Protection Message Disposition Report -- ATPV2: Exchange Online Protection and Advanced Threat Protection E-mail Malware Report. -- ATPDocument: Advanced Threat Protection Content Malware Report for files in SharePoint, OneDrive and Microsoft Teams. +- ATPReport: Defender for Office 365 File types report and Defender for Office 365 Message disposition report +- ATPV2: Exchange Online Protection and Defender for Office 365 Malware detection in email report. +- ATPDocument: Defender for Office 365 Content Malware Report for Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. - DLP: Data Loss Prevention Report. - Malware: Malware Detections Report. - MessageTrace: Message Trace Report. - MessageTraceDetail: Message Trace Details Report. -- Phish: Exchange Online Protection and Advanced Threat Protection E-mail Phish Report. +- Phish: Exchange Online Protection and Defender for Office 365 E-mail Phish Report. - SPAM: SPAM Detections Report. - Spoof: Spoof Mail Report. -- TransportRule: Transport or Mail FLow Rules Report. +- TransportRule: Transport or Mail Flow Rules Report. - UnifiedDLP: Unified Data Loss Prevention Report. You also need to specify at least one of the following values in the command: MessageID, RecipientAddress, or SenderAddress. @@ -240,7 +240,7 @@ Accept wildcard characters: False ### -NotifyAddress The NotifyAddress parameter specifies the email addresses of internal recipients to notify when the historical search is complete. The email address must be in an accepted domain that's configured for your organization. You can enter multiple email addresses separated by commas. -To view the results of the historical search, you need to specify at least one email address for the NotifyAddress parameter. Otherwise, you need to click on the completed message trace in the Exchange admin center at Mail flow \> Message trace. +To view the results of the historical search, you need to specify at least one email address for the NotifyAddress parameter. Otherwise, you need to click on the completed message trace in the Exchange admin center at **Mail flow** \> **Message trace**. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/Start-MailboxSearch.md b/exchange/exchange-ps/exchange/Start-MailboxSearch.md index b632ae6b79..d196c6d0e4 100644 --- a/exchange/exchange-ps/exchange/Start-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Start-MailboxSearch.md @@ -16,6 +16,8 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Start-MailboxSearch cmdlet to restart or resume a mailbox search that's been stopped. +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). + For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX diff --git a/exchange/exchange-ps/exchange/Stop-MailboxSearch.md b/exchange/exchange-ps/exchange/Stop-MailboxSearch.md index b398f7b767..aec4bedce5 100644 --- a/exchange/exchange-ps/exchange/Stop-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Stop-MailboxSearch.md @@ -16,6 +16,8 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Stop-MailboxSearch cmdlet to stop a mailbox search that's in progress. +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). + For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md index fc71941b49..149e683199 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md @@ -53,7 +53,7 @@ This example suspends all export requests that are in progress by using the Get- ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the export request. By default, export requests are named \\\MailboxExportX (where X = 0-9). Use the following syntax: \\\\. +The Identity parameter specifies the identity of the export request. By default, export requests are named `\MailboxExportX` (where X = 0-9). Use the following syntax: `Alias\Name`. ```yaml Type: MailboxExportRequestIdParameter diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md index ecfa16705f..cd889fad38 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md @@ -55,7 +55,7 @@ This example suspends all import requests that are in progress by using the Get- ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the import request. By default, import requests are named \\\MailboxImportX (where X = 0-9). If you created the request by using the Name parameter, use the following syntax: \\\\. +The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you created the request by using the Name parameter, use the following syntax: `Alias\Name`. ```yaml Type: MailboxImportRequestIdParameter diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md index 4cb04158e2..9a69a28cc4 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md @@ -51,7 +51,7 @@ This example suspends all restore requests that are in progress by using the Get ## PARAMETERS ### -Identity -The Identity parameter specifies the identity of the restore request. The Identity parameter consists of the alias of the mailbox to be restored and the name that was specified when the restore request was created. The identity of the restore request uses the following syntax: \\\\. +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). diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md index d5a404ac9d..cb12246c00 100644 --- a/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md @@ -44,7 +44,7 @@ This example suspends the specified public folder mailbox migration request. ## PARAMETERS ### -Identity -The Identity parameter specifies the public folder mailbox migration request that you want to suspend. This value uses the syntax \\PublicFolderMailboxMigration\ (for example, \\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e). +The Identity parameter specifies the public folder mailbox migration request that you want to suspend. This value uses the syntax `\PublicFolderMailboxMigration` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). ```yaml Type: PublicFolderMailboxMigrationRequestIdParameter diff --git a/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md b/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md index 73c9693e14..d8d6ca4961 100644 --- a/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md @@ -56,9 +56,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Latency(MS): The time required to complete the test in milliseconds. - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \ to the command. For example: - -Test-ActiveSyncConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\\My Documents\\EAS Test.html" +You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-ActiveSyncConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EAS Test.html"`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md b/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md index 07842493b9..8f1e052ccc 100644 --- a/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md @@ -56,9 +56,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Latency(MS): The time required to complete the test in milliseconds. - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \ to the command. For example: - -Test-CalendarConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\\My Documents\\Calendar Test.html" +You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-CalendarConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\Calendar Test.html"`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md index d526e2b66e..449a55e676 100644 --- a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md @@ -31,7 +31,7 @@ Test-ClientAccessRule -AuthenticationType -Pr ## DESCRIPTION Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. -Note: Currently, not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: +**Note**: Currently, not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: - OutlookWebApp:BasicAuthentication and AdfsAuthentication. - ExchangeAdminCenter:BasicAuthentication and AdfsAuthentication. diff --git a/exchange/exchange-ps/exchange/Test-DataClassification.md b/exchange/exchange-ps/exchange/Test-DataClassification.md new file mode 100644 index 0000000000..04ab225727 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-DataClassification.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +online version: https://docs.microsoft.com/powershell/module/exchange/test-dataclassification +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center +title: Test-DataClassification +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-DataClassification + +## SYNOPSIS +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. + +Use the Test-DataClassification cmdlet to find the confidence and count of a sensitive information type that's found in a specified text string. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-DataClassification + [-ClassificationNames ] + [-DomainController ] + [-TestTextExtractionResults ] + [-TextToClassify ] + [] +``` + +## DESCRIPTION +This cmdlet lets you know the classification results that are returned by the Microsoft classification engine in specific text. The classification results include the sensitive type, its count, and confidence. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$r = Test-DataClassification -TextToClassify "Credit card information Visa: 4485 3647 3952 7352. Patient Identifier or SSN: 452-12-1232" +$r.ClassificationResults +``` + +This example lists all sensitive info types, their count, and confidence in the specified text string. + +## PARAMETERS + +### -ClassificationNames +The ClassificationNames parameter specifies the sensitive information type that you want to find in the text specified by the TextToClassify parameter. Valid values are: + +- Name +- Id (GUID value) + +You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TestTextExtractionResults +The TestTextExtractionResults parameter specifies the extracted text from the Test-TextExtraction cmdlet as the input text stream. + +```yaml +Type: TestTextExtractionResult[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -TextToClassify +The TextToClassify parameter specifies the text string for which classification results need to be shown. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### + +## OUTPUTS + +### + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-EcpConnectivity.md b/exchange/exchange-ps/exchange/Test-EcpConnectivity.md index 2a87b3943c..f62490d42e 100644 --- a/exchange/exchange-ps/exchange/Test-EcpConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-EcpConnectivity.md @@ -55,9 +55,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Latency(MS): The time required to complete the test in milliseconds. - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \ to the command. For example: - -Test-EcpConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\\My Documents\\EAC Test.html" +You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-EcpConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EAC Test.html"`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Test-ImapConnectivity.md b/exchange/exchange-ps/exchange/Test-ImapConnectivity.md index a72c606396..219521eb34 100644 --- a/exchange/exchange-ps/exchange/Test-ImapConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-ImapConnectivity.md @@ -56,15 +56,13 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Latency(MS): The time required to complete the test in milliseconds. - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \ to the command. For example: - -Test-IMAPConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\\My Documents\\IMAP Test.html" +You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-IMAPConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\IMAP Test.html"`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). **Important Note**: In Exchange 2013 or later, when you run this command to test a single mailbox on an Exchange server that isn't hosting the active mailbox database copy for the mailbox, you might see the following error message: -Unable to create MailboxSession object to access the mailbox \[user@consoto.com\]. Detailed error information: \[Microsoft.Exchange.Data.Storage.WrongServerException\]: The user and the mailbox are in different Active Directory sites. Inner error \[Microsoft.Mapi.MapiExceptionMailboxInTransit\]: MapiExceptionMailboxInTransit: Detected site violation \(hr=0x0, ec=1292\) +`Unable to create MailboxSession object to access the mailbox [user@consoto.com]. Detailed error information: [Microsoft.Exchange.Data.Storage.WrongServerException]: The user and the mailbox are in different Active Directory sites. Inner error [Microsoft.Mapi.MapiExceptionMailboxInTransit]: MapiExceptionMailboxInTransit: Detected site violation (hr=0x0, ec=1292)` When you receive this error, run the command again on the server that's hosting the active mailbox database copy to verify that IMAP works for the mailbox. diff --git a/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md new file mode 100644 index 0000000000..7e7c1507f6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Exchange.WebClient-Help.xml +online version: https://docs.microsoft.com/powershell/module/exchange/test-m365dataatrestencryptionpolicy +applicable: Exchange Online +title: Test-M365DataAtRestEncryptionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-M365DataAtRestEncryptionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Test-M365DataAtRestEncryptionPolicy cmdlet to test an existing Microsoft 365 data-at-rest encryption policy. + +**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-M365DataAtRestEncryptionPolicy [[-Identity] ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Test-M365DataAtRestEncryptionPolicy -Identity "Contoso Corporate" +``` + +This example tests the Microsoft 365 data-at-rest encryption policy named Contoso Corporate. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Microsoft 365 data-at-rest encryption policy that you want to test. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can find the existing data-at-rest encryption policies by using the Get-M365DataAtRestEncryptionPolicy cmdlet. + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### + +## OUTPUTS + +### + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-Mailflow.md b/exchange/exchange-ps/exchange/Test-Mailflow.md index 8e25c5f5af..739b200460 100644 --- a/exchange/exchange-ps/exchange/Test-Mailflow.md +++ b/exchange/exchange-ps/exchange/Test-Mailflow.md @@ -105,14 +105,14 @@ Test-Mailflow [[-Identity] ] ## DESCRIPTION The Test-Mailflow cmdlet tests mail submission, transport, and delivery. The cmdlet verifies that each Mailbox server can successfully send itself a message. You can also use this cmdlet to verify that the system mailbox on one Mailbox server can successfully send a message to the system mailbox on another Mailbox server. A system mailbox is required on all servers that are involved in the test. -The test messages are available in the target user or system mailbox. The message subject is Test-Mailflow \, and the message body contains the text This is a Test-Mailflow probe message. +The test messages are available in the target user or system mailbox. The message subject is `Test-Mailflow `, and the message body contains the text `This is a Test-Mailflow probe message`. The Test-Mailflow results are displayed on-screen. The interesting values in the results are: - TestMailflowResult: The values returned are typically Success or \*FAILURE\*. - MessageLatencyTime: The time required to complete the test (deliver the test message). The value uses the syntax hh:mm:ss.ffff where hh = hours, mm = minutes, ss = seconds and ffff = fractions of a second. -You can write the Test-Mailflow results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding "\> \" to the command. For example: +You can write the Test-Mailflow results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-Mailflow -AutoDiscoverTargetMailboxServer | ConvertTo-Csv > "C:\My Documents\test-mailflow 2020-05-01.csv"`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md b/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md index 0821853c54..5f3efe710a 100644 --- a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md +++ b/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md @@ -185,14 +185,16 @@ For IMAP migrations, this example verifies the connection to the IMAP mail serve ### Example 2 ```powershell -$Credentials = Get-Credential; Test-MigrationServerAvailability -ExchangeOutlookAnywhere -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials +$Credentials = Get-Credential +Test-MigrationServerAvailability -ExchangeOutlookAnywhere -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials ``` This example uses the Autodiscover and ExchangeOutlookAnywhere parameters to verify the connection to an on-premises Exchange server in preparation for migrating on-premises mailboxes to Exchange Online. You can use a similar example to test the connection settings for a staged Exchange migration or a cutover Exchange migration. ### Example 3 ```powershell -$Credentials = Get-Credential; Test-MigrationServerAvailability -ExchangeOutlookAnywhere -ExchangeServer exch2k3.contoso.com -Credentials $Credentials -RPCProxyServer mail.contoso.com -Authentication NTLM +$Credentials = Get-Credential +Test-MigrationServerAvailability -ExchangeOutlookAnywhere -ExchangeServer exch2k3.contoso.com -Credentials $Credentials -RPCProxyServer mail.contoso.com -Authentication NTLM ``` This example verifies the connection to a server running Microsoft Exchange Server 2003 named exch2k3.contoso.com and uses NTLM for the authentication method. @@ -206,7 +208,8 @@ This example verifies the connection settings to a remote server using the setti ### Example 5 ```powershell -$MRSEndpoints = (Get-MigrationEndpoint).RemoteServer; Foreach ($MEP in $MRSEndpoints) {Test-MigrationServerAvailability -Endpoint $MEP} +$MRSEndpoints = (Get-MigrationEndpoint).Identity +Foreach ($MEP in $MRSEndpoints) {Test-MigrationServerAvailability -Endpoint $MEP} ``` This example tests multiple existing endpoints. @@ -549,7 +552,7 @@ This parameter is available only in the cloud-based service. The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. -Use the following format for the value of this parameter: ([System.IO.File]::ReadAllBytes(\)). For example: -CSVData ([System.IO.File]::ReadAllBytes("C:\\Users\\Administrator\\Desktop\\service-account.json")) +Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes())`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json"))`. ```yaml Type: Byte[] diff --git a/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md b/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md index ad3f83ba45..0973e86b1b 100644 --- a/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md @@ -410,15 +410,15 @@ The ProbeIdentity parameter specifies the probe to use. Valid values are: Outlook Anywhere (RPC over HTTP) probes: -- Outlook.Protocol\OutlookRpcSelfTestProbe: Validates that the RPC/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity. -- Outlook.Protocol\OutlookRpcDeepTestProbe: Validates that the RPC/HTTP endpoint is working on the Mailbox server. It will attempt to connect to and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet. -- Outlook.Protocol\OutlookRpcDeepTestProbe\: Validates that the RPC/HTTP endpoint is working on the Mailbox Server. It will attempt to connect to and log in to the mailbox in the specified mailbox database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, "Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"). +- `Outlook.Protocol\OutlookRpcSelfTestProbe`: Validates that the RPC/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity. +- `Outlook.Protocol\OutlookRpcDeepTestProbe`: Validates that the RPC/HTTP endpoint is working on the Mailbox server. It will attempt to connect to and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet. +- `Outlook.Protocol\OutlookRpcDeepTestProbe\`: Validates that the RPC/HTTP endpoint is working on the Mailbox Server. It will attempt to connect to and log in to the mailbox in the specified mailbox database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). MAPI over HTTP probes: -- OutlookMapiHttp.Protocol\OutlookMapiHttpSelfTestProbe: Validates that the MAPI/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity. -- OutlookMapiHttp.Protocol\OutlookMapiHttpDeepTestProbe: Validates that the MAPI/HTTP endpoint is working on the Mailbox server. It will attempt to connect and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet. -- OutlookMapiHttp.Protocol\OutlookRpcDeepTestProbe\: Validates that the MAPI/HTTP endpoint is working on the Mailbox Server. It will attempt to connect and log in to the mailbox in the specified database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, "Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"). +- `OutlookMapiHttp.Protocol\OutlookMapiHttpSelfTestProbe`: Validates that the MAPI/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity. +- `OutlookMapiHttp.Protocol\OutlookMapiHttpDeepTestProbe`: Validates that the MAPI/HTTP endpoint is working on the Mailbox server. It will attempt to connect and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet. +- `OutlookMapiHttp.Protocol\OutlookRpcDeepTestProbe\`: Validates that the MAPI/HTTP endpoint is working on the Mailbox Server. It will attempt to connect and log in to the mailbox in the specified database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). ```yaml Type: String @@ -516,8 +516,8 @@ This parameter is available or functional only in Exchange Server 2010. The RpcProxyTestType parameter specifies which HTTP endpoint the command should connect to. Valid values are: -- Internal: Refers to the local computer name (https://\, for example, https://CAS01). -- External: Refers to a public namespace (the external HTTP URL on the /rpc virtual directory, for example, https://mail.contoso.com). +- Internal: Refers to the local computer name (`https://`, for example, `https://CAS01`). +- External: Refers to a public namespace (the external HTTP URL on the /rpc virtual directory, for example, `https://mail.contoso.com`). ```yaml Type: RpcProxyTestType diff --git a/exchange/exchange-ps/exchange/Test-PopConnectivity.md b/exchange/exchange-ps/exchange/Test-PopConnectivity.md index fb97687558..0dbfa4e319 100644 --- a/exchange/exchange-ps/exchange/Test-PopConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-PopConnectivity.md @@ -56,9 +56,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Latency(MS): The time required to complete the test in milliseconds. - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \ to the command. For example: - -Test-PopConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\\My Documents\\POP Test.html" +You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-PopConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\POP Test.html"`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md b/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md index a43ce4a84c..f4270d0170 100644 --- a/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md @@ -68,9 +68,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Latency(MS): The time required to complete the test in milliseconds. - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \ to the command. For example: - -Test-PowerShellConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\\My Documents\\PowerShell Test.html" +You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-PowerShellConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\PowerShell Test.html"`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). @@ -85,7 +83,8 @@ This example tests the PowerShell (Default Web Site) virtual directory on the MB ### Example 2 ```powershell -$UserCredentials = Get-Credential; Test-PowerShellConnectivity -ConnectionUri https://contoso.com/powershell -TestCredential $UserCredentials -Authentication Basic +$UserCredentials = Get-Credential +Test-PowerShellConnectivity -ConnectionUri https://contoso.com/powershell -TestCredential $UserCredentials -Authentication Basic ``` This example tests the remote PowerShell virtual directory that's available at `https://contoso.com/powershell`. A mismatch between the SSL certificate and the URL isn't expected, so the TrustAnySSLCertificate switch isn't used. The virtual directory is configured to use Basic authentication. diff --git a/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md b/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md index ca367800d4..27af2fb1c5 100644 --- a/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md @@ -39,7 +39,7 @@ When you run the Test-SmtpConnectivity cmdlet against a Mailbox server, the cmdl - StatusCode: The result of the connection attempt. This can be one of the following values: Success, Unable to connect, Transient error, Permanent error, External error. - Details: The actual response received from the server being tested. If the connection attempt isn't successful, this field contains an error string. -The Test-SmtpConnectivity results are displayed on-screen. You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding "\> \" to the command. For example: +You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding ` > ` to the command. For example: `Test-SmtpConnectivity Mailbox01 | ConvertTo-Csv > "C:\My Documents\SMTP Test.csv"`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Test-SystemHealth.md b/exchange/exchange-ps/exchange/Test-SystemHealth.md index 22071afdcc..63db47c02d 100644 --- a/exchange/exchange-ps/exchange/Test-SystemHealth.md +++ b/exchange/exchange-ps/exchange/Test-SystemHealth.md @@ -60,7 +60,8 @@ This example gathers data about your Exchange system. ### Example 2 ```powershell -$temp=Test-SystemHealth -OutData; Set-Content -Value $temp.FileData -Path d:\temp\SystemHealthOutData.xml -Encoding Byte +$temp=Test-SystemHealth -OutData +Set-Content -Value $temp.FileData -Path d:\temp\SystemHealthOutData.xml -Encoding Byte ``` This example saves the output data as a byte stream to the temporary variable $temp. Then the content is written to the file SystemHealthOutData.xml using the Set-Content cmdlet. diff --git a/exchange/exchange-ps/exchange/Test-TextExtraction.md b/exchange/exchange-ps/exchange/Test-TextExtraction.md new file mode 100644 index 0000000000..851e63ed3a --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-TextExtraction.md @@ -0,0 +1,141 @@ +--- +external help file: Microsoft.Exchange.RemoteConnections-Help.xml +online version: https://docs.microsoft.com/powershell/module/exchange/test-textextraction +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +title: Test-TextExtraction +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + + +# Test-TextExtraction + +## SYNOPSIS +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. + +Use the Test-TextExtraction cmdlet to find the text that is extracted from a specified email message in Exchange flow. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-TextExtraction [-FileData] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +This cmdlet returns the text that is found in a file in Exchange. The Microsoft classification engine uses this text to classify content and determine which sensitive information types are found in this file/message. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$content = Test-TextExtraction -FileData (Get-Content -Path '.\finalcial data.msg' -Encoding byte -ReadCount 0) +$content.ExtractedResults +``` + +This example returns the text that's extracted from the email "financial data.msg" + +### Example 2 +```powershell +$content = Test-TextExtraction -FileData (Get-Content -Path '.\finalcial data.msg' -Encoding byte -ReadCount 0) +Test-DataClassification -TestTextExtractionResults $tr.ExtractedResults +``` + +This example extracts the text from the email "financial data.msg" and returns the sensitive information types, their confidence, and count. + +## PARAMETERS + +### -FileData +The FileData parameter specifies the name and path of the file from which text should be extracted. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `(Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0)`. + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. + +- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`. +- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +### + +## OUTPUTS + +### + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md b/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md index 34cfa4e0d4..baeafcd773 100644 --- a/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md @@ -87,9 +87,7 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Result: The values returned are typically Success or \*FAILURE\*. - Latency(MS): The time required to complete the test in milliseconds -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding \> \ to the command. For example: - -Test-WebServicesConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\\My Documents\\EWS Test.html" +You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-WebServicesConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EWS Test.html"`. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md b/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md index 086cb31fed..a6cb8f0648 100644 --- a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md @@ -63,7 +63,7 @@ The SoftDeletedObject parameter specifies the soft-deleted Microsoft 365 Group t - SamAccountName - User ID or user principal name (UPN) -Note: You might need to use the DistinguishedName or ExchangeGuid property to identify the soft-deleted Microsoft 365 Group, because it's possible for an active Microsoft 365 Group and a soft-deleted Microsoft 365 Group to have the same primary SMTP address. +**Note**: You might need to use the DistinguishedName or ExchangeGuid property to identify the soft-deleted Microsoft 365 Group, because it's possible for an active Microsoft 365 Group and a soft-deleted Microsoft 365 Group to have the same primary SMTP address. ```yaml Type: UnifiedGroupIdParameter diff --git a/exchange/exchange-ps/exchange/Update-AddressList.md b/exchange/exchange-ps/exchange/Update-AddressList.md index cb0fbe7ff5..a395c77590 100644 --- a/exchange/exchange-ps/exchange/Update-AddressList.md +++ b/exchange/exchange-ps/exchange/Update-AddressList.md @@ -48,7 +48,7 @@ The Identity parameter specifies the address list that you want to update. You c - Name - Distinguished name (DN) - GUID -- Path: (\\\) or [\\\\) +- Path: `"\AddressListName"` or `"\ContainerName\AddressListName"` (for example, `"\All Users"` or `"\All Contacts\Marketing"`) ```yaml Type: AddressListIdParameter diff --git a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md index 6daa4c53de..ea236d9bb7 100644 --- a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md @@ -75,7 +75,7 @@ The Members parameter specifies the users that will replace the current eDiscove - Canonical DN - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md index 0342ca4d98..6fa1002a26 100644 --- a/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md @@ -135,7 +135,7 @@ The Members parameter specifies the recipients (mail-enabled objects) that will - Email address - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. Although it isn't required, it's a good idea to add only security principals (for example, mailboxes and mail users with user accounts or other mail-enabled security groups) to mail-enabled security groups. If you assign permissions to a mail-enabled security group, any members that aren't security principals (for example, mail contacts or distribution groups) won't have the permissions assigned. diff --git a/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md b/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md index 1fe8064347..a77cb3529c 100644 --- a/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md @@ -110,7 +110,7 @@ You can use any value that uniquely identifies the recipient. For example: - Email address - GUID -To replace the current members of the group with the recipients that you specify, use the syntax @("\","\"...). To add new group members without affecting the existing members, see Example 2 in the Examples section. +To replace the current members of the group with the recipients that you specify, use the syntax `@("Recipient1","Recipient2",..."RecipientN")`. To add new group members without affecting the existing members, see Example 2 in the Examples section. ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md b/exchange/exchange-ps/exchange/Update-HybridConfiguration.md index 029f76b9a9..3ad71d29e6 100644 --- a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md +++ b/exchange/exchange-ps/exchange/Update-HybridConfiguration.md @@ -37,14 +37,16 @@ You need to be assigned permissions before you can run this cmdlet. Although thi ### Example 1 ```powershell -$OnPremisesCreds = Get-Credential; $TenantCreds = Get-Credential; Update-HybridConfiguration -OnPremisesCredentials $OnPremisesCreds -TenantCredentials $TenantCreds +$OnPremisesCreds = Get-Credential +$TenantCreds = Get-Credential +Update-HybridConfiguration -OnPremisesCredentials $OnPremisesCreds -TenantCredentials $TenantCreds ``` This example defines the credentials that are used to update the hybrid configuration object and connect to the Microsoft 365 for enterprises organization. -Use the first command to specify your on-premises organization credentials. For example, run this command and enter \\\admin@contoso.com and the associated password in the resulting Windows PowerShell Credential Request dialog box. +Use the first command to specify your on-premises organization credentials. For example, run this command and enter `\admin@contoso.com` and the associated password in the resulting Windows PowerShell Credential Request dialog box. -Use the second command to specify your Microsoft 365 organization credentials. For example, run this command and then enter admin@contoso.onmicrosoft.com and the associated account password in the resulting Windows PowerShell Credential Request dialog box. +Use the second command to specify your Microsoft 365 organization credentials. For example, run this command and then enter `admin@contoso.onmicrosoft.com` and the associated account password in the resulting Windows PowerShell Credential Request dialog box. Use the last command to define the credentials that are used to update the hybrid configuration object and connect to the Microsoft 365 organization. diff --git a/exchange/exchange-ps/exchange/Update-RoleGroupMember.md b/exchange/exchange-ps/exchange/Update-RoleGroupMember.md index 546c902f84..db3f64d2ed 100644 --- a/exchange/exchange-ps/exchange/Update-RoleGroupMember.md +++ b/exchange/exchange-ps/exchange/Update-RoleGroupMember.md @@ -61,14 +61,15 @@ This example sets the Recipient Administrators role group membership list to Mar ### Example 3 ```powershell -Update-RoleGroupMember "Organization Management" -Members @{Add=(Get-Mailbox David).Identity, (Get-Group "Help Desk Managers").Identity; Remove=(Get-Mailbox "Christine").Identity, (Get-Mailbox "Isabel").Identity} +Update-RoleGroupMember "Organization Management" -Members @{Add=(Get-Mailbox David).Identity, (Get-Group "Help Desk Managers").Identity +Remove=(Get-Mailbox "Christine").Identity, (Get-Mailbox "Isabel").Identity} ``` This example adds multiple members to, and removes multiple members from, a role group without replacing all the existing members on the role group. This example makes use of multivalued property syntax that's described in the topic [Modifying multivalued properties](https://docs.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). When you use this multivalued property syntax, you must manually retrieve the Identity of the mailbox or mail-enabled security group that you want to add to or remove from the role group. Use the syntax that matches the type of object you want to add or remove: -Mailbox: If you want to add or remove a mailbox, use the syntax (Get-Mailbox "\").Identity +Mailbox: If you want to add or remove a mailbox, use the syntax `(Get-Mailbox "").Identity`. -Mail-enabled security group: If you want to add or remove a mail-enabled security group, use the syntax (Get-Group "\").Identity +Mail-enabled security group: If you want to add or remove a mail-enabled security group, use the syntax `(Get-Group "").Identity`. ## PARAMETERS diff --git a/exchange/exchange-ps/exchange/Update-SafeList.md b/exchange/exchange-ps/exchange/Update-SafeList.md index 1897124f5e..07a0a32048 100644 --- a/exchange/exchange-ps/exchange/Update-SafeList.md +++ b/exchange/exchange-ps/exchange/Update-SafeList.md @@ -49,7 +49,8 @@ This example updates Safe Senders List data for the single user kim@contoso.com. ### Example 2 ```powershell -Set-AdServerSettings -ViewEntireForest $true; Get-Mailbox -ResultSize Unlimited -RecipientTypeDetails UserMailbox | Update-Safelist +Set-AdServerSettings -ViewEntireForest $true +Get-Mailbox -ResultSize Unlimited -RecipientTypeDetails UserMailbox | Update-Safelist ``` This example updates safelist data for all user mailboxes in your Exchange organization. By default, the Exchange Management Shell is configured to retrieve or modify objects that reside in the domain in which the Exchange server resides. Therefore, to retrieve all the mailboxes in your Exchange organization, you must first set the scope of the Exchange Management Shell to the entire forest using the Set-AdServerSettings cmdlet. diff --git a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md index 2603ba5b38..73926c5e46 100644 --- a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md @@ -53,7 +53,7 @@ The Users parameter specifies the users that will replace the current eDiscovery - Canonical DN - GUID -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: String[] diff --git a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md b/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md index 64d711bc66..f45b75fec7 100644 --- a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Upgrade-DistributionGroup cmdlet to upgrade distribution groups to Microsoft 365 Groups. This cmdlet only works on distribution groups, not mail-enabled security groups. -Note: Before you use this cmdlet, verify there are no email address policies that you created with the IncludeUnifiedGroupRecipients parameter; otherwise the command will fail. Remove and recreate the email address policies after you upgrade your distribution groups to Microsoft 365 Groups. +**Note**: Before you use this cmdlet, verify there are no email address policies that you created with the IncludeUnifiedGroupRecipients parameter; otherwise the command will fail. Remove and recreate the email address policies after you upgrade your distribution groups to Microsoft 365 Groups. **Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). diff --git a/exchange/exchange-ps/exchange/Validate-OutboundConnector.md b/exchange/exchange-ps/exchange/Validate-OutboundConnector.md index 40b11c91c7..5a33f9c5e8 100644 --- a/exchange/exchange-ps/exchange/Validate-OutboundConnector.md +++ b/exchange/exchange-ps/exchange/Validate-OutboundConnector.md @@ -71,7 +71,7 @@ Accept wildcard characters: False ### -Recipients The Recipients parameter specifies one or more email addresses to send a test message to. The email addresses need to be in the domain that's configured on the connector. -To enter multiple values, use the following syntax: \,\,...\. If the values contain spaces or otherwise require quotation marks, use the following syntax: "\","\",..."\". +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index 51229e0f91..51277df401 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -44,7 +44,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-AdSiteLink](Set-AdSiteLink.md) -## advanced-threat-protection Cmdlets +## defender-for-office-365 Cmdlets ### [Disable-AntiPhishRule](Disable-AntiPhishRule.md) ### [Disable-SafeAttachmentRule](Disable-SafeAttachmentRule.md) @@ -754,6 +754,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-IRMConfiguration](Get-IRMConfiguration.md) +### [Get-M365DataAtRestEncryptionPolicy](Get-M365DataAtRestEncryptionPolicy.md) + +### [Get-M365DataAtRestEncryptionPolicyAssignment](Get-M365DataAtRestEncryptionPolicyAssignment.md) + ### [Get-OMEConfiguration](Get-OMEConfiguration.md) ### [Get-OMEMessageStatus](Get-OMEMessageStatus.md) @@ -772,6 +776,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [New-ExchangeCertificate](New-ExchangeCertificate.md) +### [New-M365DataAtRestEncryptionPolicy](New-M365DataAtRestEncryptionPolicy.md) + ### [New-OMEConfiguration](New-OMEConfiguration.md) ### [Remove-ExchangeCertificate](Remove-ExchangeCertificate.md) @@ -784,6 +790,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-IRMConfiguration](Set-IRMConfiguration.md) +### [Set-M365DataAtRestEncryptionPolicy](Set-M365DataAtRestEncryptionPolicy.md) + +### [Set-M365DataAtRestEncryptionPolicyAssignment](Set-M365DataAtRestEncryptionPolicyAssignment.md) + ### [Set-OMEConfiguration](Set-OMEConfiguration.md) ### [Set-OMEMessageRevocation](Set-OMEMessageRevocation.md) @@ -1892,6 +1902,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-PolicyTipConfig](Set-PolicyTipConfig.md) +### [Test-DataClassification](Test-DataClassification.md) + +### [Test-TextExtraction](Test-TextExtraction.md) + ## policy-and-compliance-ediscovery Cmdlets ### [Add-ComplianceCaseMember](Add-ComplianceCaseMember.md) diff --git a/exchange/exchange-ps/exchange/set-CASMailboxPlan.md b/exchange/exchange-ps/exchange/set-CASMailboxPlan.md index 6b35c8c626..42cf62de08 100644 --- a/exchange/exchange-ps/exchange/set-CASMailboxPlan.md +++ b/exchange/exchange-ps/exchange/set-CASMailboxPlan.md @@ -55,7 +55,7 @@ The Identity parameter specifies the CAS mailbox plan that you want to modify. Y - Distinguished name (DN) - GUID -The display name and name of the CAS mailbox plan is the same as the corresponding mailbox plan (for example, ExchangeOnlineEnterprise and ExchangeOnlineEnterprise-\, respectively). +The display name and name of the CAS mailbox plan is the same as the corresponding mailbox plan (for example, `ExchangeOnlineEnterprise` and `ExchangeOnlineEnterprise-`, respectively). ```yaml Type: MailboxPlanIdParameter diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index 062cebea65..1409612971 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -14,50 +14,50 @@ "Set-ADServerSettings": "active-directory", "Set-ADSite": "active-directory", "Set-AdSiteLink": "active-directory", - "Disable-AntiPhishRule": "advanced-threat-protection", - "Disable-SafeAttachmentRule": "advanced-threat-protection", - "Disable-SafeLinksRule": "advanced-threat-protection", - "Enable-AntiPhishRule": "advanced-threat-protection", - "Enable-SafeAttachmentRule": "advanced-threat-protection", - "Enable-SafeLinksRule": "advanced-threat-protection", - "Get-AdvancedThreatProtectionDocumentDetail": "advanced-threat-protection", - "Get-AdvancedThreatProtectionDocumentReport": "advanced-threat-protection", - "Get-AdvancedThreatProtectionTrafficReport": "advanced-threat-protection", - "Get-AntiPhishPolicy": "advanced-threat-protection", - "Get-AntiPhishRule": "advanced-threat-protection", - "Get-AtpPolicyForO365": "advanced-threat-protection", - "Get-ATPTotalTrafficReport": "advanced-threat-protection", - "Get-MailDetailATPReport": "advanced-threat-protection", - "Get-MailTrafficATPReport": "advanced-threat-protection", - "Get-PhishFilterPolicy": "advanced-threat-protection", - "Get-SafeAttachmentPolicy": "advanced-threat-protection", - "Get-SafeAttachmentRule": "advanced-threat-protection", - "Get-SafeLinksAggregateReport": "advanced-threat-protection", - "Get-SafeLinksDetailRepor": "advanced-threat-protection", - "Get-SafeLinksPolicy": "advanced-threat-protection", - "Get-SafeLinksRule": "advanced-threat-protection", - "Get-SpoofMailReport": "advanced-threat-protection", - "Get-UrlTrace": "advanced-threat-protection", - "New-AntiPhishPolicy": "advanced-threat-protection", - "New-AntiPhishRule": "advanced-threat-protection", - "New-SafeAttachmentPolicy": "advanced-threat-protection", - "New-SafeAttachmentRule": "advanced-threat-protection", - "New-SafeLinksPolicy": "advanced-threat-protection", - "New-SafeLinksRule": "advanced-threat-protection", - "Remove-AntiPhishPolicy": "advanced-threat-protection", - "Remove-AntiPhishRule": "advanced-threat-protection", - "Remove-SafeAttachmentPolicy": "advanced-threat-protection", - "Remove-SafeAttachmentRule": "advanced-threat-protection", - "Remove-SafeLinksPolicy": "advanced-threat-protection", - "Remove-SafeLinksRule": "advanced-threat-protection", - "Set-AntiPhishPolicy": "advanced-threat-protection", - "Set-AntiPhishRule": "advanced-threat-protection", - "Set-AtpPolicyForO365": "advanced-threat-protection", - "Set-PhishFilterPolicy": "advanced-threat-protection", - "Set-SafeAttachmentPolicy": "advanced-threat-protection", - "Set-SafeAttachmentRule": "advanced-threat-protection", - "Set-SafeLinksPolicy": "advanced-threat-protection", - "Set-SafeLinksRule": "advanced-threat-protection", + "Disable-AntiPhishRule": "defender-for-office-365", + "Disable-SafeAttachmentRule": "defender-for-office-365", + "Disable-SafeLinksRule": "defender-for-office-365", + "Enable-AntiPhishRule": "defender-for-office-365", + "Enable-SafeAttachmentRule": "defender-for-office-365", + "Enable-SafeLinksRule": "defender-for-office-365", + "Get-AdvancedThreatProtectionDocumentDetail": "defender-for-office-365", + "Get-AdvancedThreatProtectionDocumentReport": "defender-for-office-365", + "Get-AdvancedThreatProtectionTrafficReport": "defender-for-office-365", + "Get-AntiPhishPolicy": "defender-for-office-365", + "Get-AntiPhishRule": "defender-for-office-365", + "Get-AtpPolicyForO365": "defender-for-office-365", + "Get-ATPTotalTrafficReport": "defender-for-office-365", + "Get-MailDetailATPReport": "defender-for-office-365", + "Get-MailTrafficATPReport": "defender-for-office-365", + "Get-PhishFilterPolicy": "defender-for-office-365", + "Get-SafeAttachmentPolicy": "defender-for-office-365", + "Get-SafeAttachmentRule": "defender-for-office-365", + "Get-SafeLinksAggregateReport": "defender-for-office-365", + "Get-SafeLinksDetailRepor": "defender-for-office-365", + "Get-SafeLinksPolicy": "defender-for-office-365", + "Get-SafeLinksRule": "defender-for-office-365", + "Get-SpoofMailReport": "defender-for-office-365", + "Get-UrlTrace": "defender-for-office-365", + "New-AntiPhishPolicy": "defender-for-office-365", + "New-AntiPhishRule": "defender-for-office-365", + "New-SafeAttachmentPolicy": "defender-for-office-365", + "New-SafeAttachmentRule": "defender-for-office-365", + "New-SafeLinksPolicy": "defender-for-office-365", + "New-SafeLinksRule": "defender-for-office-365", + "Remove-AntiPhishPolicy": "defender-for-office-365", + "Remove-AntiPhishRule": "defender-for-office-365", + "Remove-SafeAttachmentPolicy": "defender-for-office-365", + "Remove-SafeAttachmentRule": "defender-for-office-365", + "Remove-SafeLinksPolicy": "defender-for-office-365", + "Remove-SafeLinksRule": "defender-for-office-365", + "Set-AntiPhishPolicy": "defender-for-office-365", + "Set-AntiPhishRule": "defender-for-office-365", + "Set-AtpPolicyForO365": "defender-for-office-365", + "Set-PhishFilterPolicy": "defender-for-office-365", + "Set-SafeAttachmentPolicy": "defender-for-office-365", + "Set-SafeAttachmentRule": "defender-for-office-365", + "Set-SafeLinksPolicy": "defender-for-office-365", + "Set-SafeLinksRule": "defender-for-office-365", "Add-AttachmentFilterEntry": "antispam-antimalware", "Add-ContentFilterPhrase": "antispam-antimalware", "Add-IPAllowListEntry": "antispam-antimalware", @@ -365,6 +365,8 @@ "Get-DataEncryptionPolicy": "encryption-and-certificates", "Get-ExchangeCertificate": "encryption-and-certificates", "Get-IRMConfiguration": "encryption-and-certificates", + "Get-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", + "Get-M365DataAtRestEncryptionPolicyAssignment": "encryption-and-certificates", "Get-OMEConfiguration": "encryption-and-certificates", "Get-OMEMessageStatus": "encryption-and-certificates", "Get-RMSTemplate": "encryption-and-certificates", @@ -374,18 +376,22 @@ "Import-RMSTrustedPublishingDomain": "encryption-and-certificates", "New-DataEncryptionPolicy": "encryption-and-certificates", "New-ExchangeCertificate": "encryption-and-certificates", + "New-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", "New-OMEConfiguration": "encryption-and-certificates", "Remove-ExchangeCertificate": "encryption-and-certificates", "Remove-OMEConfiguration": "encryption-and-certificates", "Remove-RMSTrustedPublishingDomain": "encryption-and-certificates", "Set-DataEncryptionPolicy": "encryption-and-certificates", "Set-IRMConfiguration": "encryption-and-certificates", + "Set-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", + "Set-M365DataAtRestEncryptionPolicyAssignment": "encryption-and-certificates", "Set-OMEConfiguration": "encryption-and-certificates", "Set-OMEMessageRevocation": "encryption-and-certificates", "Set-RMSTemplate": "encryption-and-certificates", "Set-RMSTrustedPublishingDomain": "encryption-and-certificates", "Set-SmimeConfig": "encryption-and-certificates", "Test-IRMConfiguration": "encryption-and-certificates", + "Test-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", "Add-FederatedDomain": "federation-and-hybrid", "Disable-RemoteMailbox": "federation-and-hybrid", "Enable-RemoteMailbox": "federation-and-hybrid", @@ -930,6 +936,8 @@ "Set-DlpSensitiveInformationType": "policy-and-compliance-dlp", "Set-DlpSensitiveInformationTypeRulePackage": "policy-and-compliance-dlp", "Set-PolicyTipConfig": "policy-and-compliance-dlp", + "Test-DataClassification": "policy-and-compliance-dlp", + "Test-TextExtraction": "policy-and-compliance-dlp", "Add-ComplianceCaseMember": "policy-and-compliance-ediscovery", "Add-eDiscoveryCaseAdmin": "policy-and-compliance-ediscovery", "Get-CaseHoldPolicy": "policy-and-compliance-ediscovery", diff --git a/officewebapps/docs-conceptual/index.md b/officewebapps/docs-conceptual/index.md index 8ac54086df..2b011f543a 100644 --- a/officewebapps/docs-conceptual/index.md +++ b/officewebapps/docs-conceptual/index.md @@ -1,9 +1,12 @@ --- -title: Office Online Server cmdlet reference +title: Office Online Server cmdlet help reference +description: "Learn about the Office Online Server PowerShell cmdlet help reference." --- -# Office Online Server cmdlet reference -Welcome to the Office Online Server PowerShell cmdlet help references. The Office Online Server cmdlets provide the command line interface for administration and management. +# Office Online Server cmdlet help reference -Here you will find all of the Office Online Server PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. +Welcome to the Office Online Server PowerShell cmdlet **Help** reference. The Office Online Server cmdlets provide the command line interface for administration and management. + +Here, you will find all of the Office Online Server PowerShell **Help** topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content, go to the source GitHub repo and look through the README. + +The repo is located here: and you can find the README displayed at the bottom of the page. diff --git a/repo_docs/NEW_CMDLETS.md b/repo_docs/NEW_CMDLETS.md index 45bed125cc..466491765a 100644 --- a/repo_docs/NEW_CMDLETS.md +++ b/repo_docs/NEW_CMDLETS.md @@ -107,7 +107,7 @@ Either way, take note of your module name. You'll need it in the next steps. ### Step 5: Verify your PSSession variable name -**Note**: This step is required in Exchange, Skype for Business Online and other products that use remote PowerShell in their connection instructions (one or more **xxx-xxxSession** commands are present). **If you're using SharePoint, SharePoint Online or another product that doesn't use remote PowerShell, you can skip this step**. +**Note**: This step is required in Exchange, Skype for Business Online and other products that use remote PowerShell. **If you're using SharePoint, SharePoint Online or another product that doesn't use remote PowerShell, you can skip this step**. Check the details of your connection instructions, but your session information is stored in a variable. For example, in the Exchange connection instructions, the variable is `$Session`. You'll use this variable name in later steps. @@ -178,7 +178,7 @@ You have two choices: - \ is the value you found in [Step 4](#step-4-find-your-module-name) (for example, `tmp_byivwzpq.e1k` or `Microsoft.Online.SharePoint.PowerShell`). -- \ is the remote PowerShell session variable from [Step 5](#step-5-verify-your-your-pssession-variable-name) (for example, `$Session`) _and is required only if the connection instructions used remote PowerShell (one or more **xxx-xxxSession** commands)_. +- \ is the remote PowerShell session variable from [Step 5](#step-5-verify-your-your-pssession-variable-name) (for example, `$Session`) _and is required only if the connection uses remote PowerShell_. Failure to use the _Session_ parameter in remote PowerShell environments leads to weird results: multiple syntax blocks/parameter sets aren't recognized and are collapsed into one big block, the Type value is Object for all parameters, the Required value is False for all parameters, etc. @@ -338,7 +338,10 @@ When you're done editing the topics, upload them to GitHub. Note that you need t ![Open a pull request page](../images/open-a-pull-request-page.png) > [!NOTE] -> Your permissions in the repo determine what you see. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages.

The point is: click any green buttons that are presented to you until there are no more. +> +> Your permissions in the repo determine what you see. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages. +> +> The point is: click any green buttons that are presented to you until there are no more. ### Step 9: Add the new cmdlets to the TOC file @@ -386,7 +389,10 @@ After you're done editing the TOC files: ![Open a pull request page](../images/open-a-pull-request-page.png) > [!NOTE] -> Your permissions in the repo determine what you see. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages.

The point is: click any green buttons that are presented to you until there are no more. +> +> Your permissions in the repo determine what you see. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages. +> +> The point is: click any green buttons that are presented to you until there are no more. ## Appendix diff --git a/repo_docs/UPDATE_CMDLETS.md b/repo_docs/UPDATE_CMDLETS.md index 11a1d12d8f..e6efdf6eb7 100644 --- a/repo_docs/UPDATE_CMDLETS.md +++ b/repo_docs/UPDATE_CMDLETS.md @@ -40,9 +40,9 @@ Import-Module platyPS This step is the same as in [Create new cmdlet topics](NEW_CMDLETS.md#step-5-verify-your-your-pssession-variable-name). -To recap: this step is required in Exchange, Skype for Business Online and other products that use remote PowerShell in their connection instructions (one or more **xxx-xxxSession** commands are present), and the value is most likely `$Session`. +To recap: this step is required in Exchange, Skype for Business Online and other products that use remote PowerShell, and the value is most likely `$Session`. -If you're using SharePoint, SharePoint Online or another product that doesn't use remote PowerShell to connect, you can skip this step. +If you're using SharePoint, SharePoint Online or another product that doesn't use remote PowerShell, you can skip this step. ### Step 5: Use New-MarkdownHelp to dump the latest version of the cmdlet to a file @@ -159,7 +159,10 @@ At this point, the steps are basically identical to [Short URL: aka.ms/office-po ![Open a pull request page](../images/open-a-pull-request-page.png) > [!NOTE] -> Your permissions in the repo determine what you see. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages.

The point is: click any green buttons that are presented to you until there are no more. +> +> Your permissions in the repo determine what you see. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages. +> +> The point is: click any green buttons that are presented to you until there are no more. ## Remove existing parameters from existing topics diff --git a/sharepoint/docs-conceptual/sharepoint-online/connect-sharepoint-online.md b/sharepoint/docs-conceptual/sharepoint-online/connect-sharepoint-online.md index cdc56fe978..1cba9fcb33 100644 --- a/sharepoint/docs-conceptual/sharepoint-online/connect-sharepoint-online.md +++ b/sharepoint/docs-conceptual/sharepoint-online/connect-sharepoint-online.md @@ -5,22 +5,28 @@ ms.service: sharepoint-powershell # Get started with SharePoint Online Management Shell # -To get started using PowerShell to manage SharePoint Online, you need to install the latest SharePoint Online Management Shell is installed and connect to SharePoint Online. +To get started using PowerShell to manage SharePoint Online, you need to install the SharePoint Online Management Shell and connect to SharePoint Online. Install the SharePoint Online Management Shell by downloading and running the [SharePoint Online Management Shell](https://go.microsoft.com/fwlink/p/?LinkId=255251) or installing the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/Microsoft.Online.SharePoint.PowerShell/). Once installed, the module is available for use, and you do not need to install it again until you need features introduced in a later version. For example, you may need to install a new version for TLS 1.2 negotiation after October 2018. -First you can check if you have already installed SharePoint Online Management Shell by running the following command in administrative mode in PowerShell: +First you can check if you have already installed the SharePoint Online Management Shell by running the following command in administrative mode in PowerShell: ```powershell Get-Module -Name Microsoft.Online.SharePoint.PowerShell -ListAvailable | Select Name,Version ``` -If your operating system is using PowerShell 5 or newer, you can install the SharePoint Online Management Shell also by running the following command in administrative mode: +If your operating system is using PowerShell 5 or newer, you can also install the SharePoint Online Management Shell by running the following command in administrative mode: ```powershell Install-Module -Name Microsoft.Online.SharePoint.PowerShell ``` +If you don't have administrative privileges on the system, you can install the SharePoint Online Management Shell only for the current user by running the following command: + +```powershell +Install-Module -Name Microsoft.Online.SharePoint.PowerShell -Scope CurrentUser +``` + To ensure you have all available cmdlets, you should always make sure the module is up to date. You can update the SharePoint Online Management Shell by running the following command in administrative mode: ```powershell @@ -29,30 +35,26 @@ Update-Module -Name Microsoft.Online.SharePoint.PowerShell To open the SharePoint Online Management Shell command prompt, from the **Start** screen, type **sharepoint**, and then click **SharePoint Online Management Shell**. -[!VIDEO https://www.youtube.com/embed/TMzHAWEQjlk] +> [!VIDEO https://www.youtube.com/embed/TMzHAWEQjlk] -## To connect with a user name and password ## +## To connect with a user name and password -1. Fill in the values for the **$adminUPN** and **$orgName** variables (replacing all the text between the quotes, including the < and > characters), and then run the following commands at the SharePoint Online Management Shell command prompt: +1. Run the following command at the SharePoint Online Management Shell command prompt: ```powershell - $adminUPN="" - $orgName="" - $userCredential = Get-Credential -UserName $adminUPN -Message "Type the password." - Connect-SPOService -Url https://$orgName-admin.sharepoint.com -Credential $userCredential + Connect-SPOService -Url https://contoso-admin.sharepoint.com -Credential admin@contoso.com ``` 2. When prompted with the Windows PowerShell credential request dialog box, type the password for the SharePoint admin account. To assign a user the SharePoint admin role, see [Assign admin roles](https://docs.microsoft.com/microsoft-365/admin/add-users/assign-admin-roles) or [Assign admin roles to Microsoft 365 user accounts with PowerShell](https://docs.microsoft.com/microsoft-365/enterprise/assign-roles-to-user-accounts-with-microsoft-365-powershell). -## To connect with multifactor authentication (MFA) ## +## To connect with multifactor authentication (MFA) -1. Fill in the value for the **$orgName** variable (replacing all the text between the quotes, including the < and > characters), and then run the following commands at the SharePoint Online Management Shell command prompt: +1. Run the following command at the SharePoint Online Management Shell command prompt: ```powershell - $orgName="" - Connect-SPOService -Url https://$orgName-admin.sharepoint.com + Connect-SPOService -Url https://contoso-admin.sharepoint.com ``` 2. When prompted with the **Microsoft SharePoint Online Management Shell** dialog box, type the account name and password for a SharePoint administrator account, and then click **Sign in**. diff --git a/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md b/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md index ec1fad1927..006d20848d 100644 --- a/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md +++ b/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md @@ -1,44 +1,42 @@ --- title: PnP PowerShell Overview ms.service: sharepoint-powershell +description: "SharePoint PnP PowerShell Overview" --- + # PnP PowerShell overview SharePoint Patterns and Practices (PnP) contains a library of PowerShell commands (PnP PowerShell) that allows you to perform complex provisioning and artifact management actions towards SharePoint. The commands use CSOM and can work against both SharePoint Online as SharePoint On-Premises. ![SharePoint Patterns and Practices](https://devofficecdn.azureedge.net/media/Default/PnP/sppnp.png) -_**Applies to:** SharePoint Online, SharePoint 2019, SharePoint 2016, SharePoint 2013_ +_**Applies to:** SharePoint Online | SharePoint 2019 | SharePoint 2016 | SharePoint 2013_ -## Installation +## Installation # There are 3 ways to install the cmdlets. We recommend, where possible, to install them from the [PowerShell Gallery](https://www.powershellgallery.com). Alternatively you can download the setup files or run a PowerShell script to download the PowerShellGet module and install the cmdlets subsequently. -### PowerShell Gallery - +### PowerShell Gallery ### If you main OS is Windows 10, or if you have [PowerShellGet](https://github.com/powershell/powershellget) installed, you can run the following commands to install the PowerShell cmdlets: -|SharePoint Version|Command to install| -|---|---| -|SharePoint Online|`Install-Module SharePointPnPPowerShellOnline`| -|SharePoint 2019|`Install-Module SharePointPnPPowerShell2019`| -|SharePoint 2016|`Install-Module SharePointPnPPowerShell2016`| -|SharePoint 2013|`Install-Module SharePointPnPPowerShell2013`| +|**SharePoint Version**|**Command to install**| +|------------------|------------------| +|SharePoint Online|```Install-Module SharePointPnPPowerShellOnline ```| +|SharePoint 2019|```Install-Module SharePointPnPPowerShell2019```| +|SharePoint 2016|```Install-Module SharePointPnPPowerShell2016```| +|SharePoint 2013|```Install-Module SharePointPnPPowerShell2013```| -> [!NOTE] -> If you install the latest PowerShellGet from Github, you might receive an error message stating +*Notice*: if you install the latest PowerShellGet from Github, you might receive an error message stating >PackageManagement\Install-Package : The version 'x.x.x.x' of the module 'SharePointPnPPowerShellOnline' being installed is not catalog signed. -In order to install the cmdlets when you get this error specify the -SkipPublisherCheck switch with the Install-Module cmdlet, e.g. `Install-Module SharePointPnPPowerShellOnline -SkipPublisherCheck -AllowClobber`. - -### Setup files +In order to install the cmdlets when you get this error specify the -SkipPublisherCheck switch with the Install-Module cmdlet, e.g. ```Install-Module SharePointPnPPowerShellOnline -SkipPublisherCheck -AllowClobber``` +### Setup files ## You can download setup files from the [releases](https://github.com/pnp/pnp-powershell/releases) section of the PnP PowerShell repository. These files will up be updated on a monthly basis. Run the install and restart any open instances of PowerShell to use the cmdlets. -### Installation script - -This is an alternative for installation on machines that have at least PowerShell v3 installed. You can find the version of PowerShell by opening PowerShell and running `$PSVersionTable.PSVersion`. The value for `Major` should be above 3. +### Installation script ## +This is an alternative for installation on machines that have at least PowerShell v3 installed. You can find the version of PowerShell by opening PowerShell and running ```$PSVersionTable.PSVersion```. The value for ```Major``` should be above 3. To install the cmdlets you can run the below command which will install PowerShell Package Management and then install the PowerShell Modules from the PowerShell Gallery. @@ -46,15 +44,14 @@ To install the cmdlets you can run the below command which will install PowerShe Invoke-Expression (New-Object Net.WebClient).DownloadString('https://raw.githubusercontent.com/pnp/PnP-PowerShell/master/Samples/Modules.Install/Install-SharePointPnPPowerShell.ps1') ``` -## Updating - +## Updating ## Every month a new release will be made available of the PnP PowerShell Cmdlets. If you earlier installed the cmdlets using the setup file, simply download the [latest version](https://github.com/SharePoint/PnP-PowerShell/releases/latest) and run the setup. This will update your existing installation. -If you have installed the cmdlets using PowerShellGet with `Install-Module` from the PowerShell Gallery then you will be able to use the following command to install the latest updated version: +If you have installed the cmdlets using PowerShellGet with ```Install-Module``` from the PowerShell Gallery then you will be able to use the following command to install the latest updated version: ```powershell Update-Module SharePointPnPPowerShell* -``` +``` This will automatically load the module after starting PowerShell 3.0. @@ -64,7 +61,7 @@ You can check the installed PnP-PowerShell versions with the following command: Get-Module SharePointPnPPowerShell* -ListAvailable | Select-Object Name,Version | Sort-Object Version -Descending ``` -## Getting Started +## Getting Started # To use the library you first need to connect to your tenant: @@ -72,7 +69,7 @@ To use the library you first need to connect to your tenant: Connect-PnPOnline –Url https://yoursite.sharepoint.com –Credentials (Get-Credential) ``` -Notice: if you use multi-factor authentication on your tenant, use +Notice: if you use multi-factor authentication on your tenant, use ```powershell Connect-PnPOnline -Url https://yoursite.sharepoint.com -UseWebLogin @@ -86,640 +83,640 @@ Get-Command -Module *PnP* At the following links you will find a few videos on how to get started with the cmdlets: -- -- -- - -### Setting up credentials +* https://channel9.msdn.com/blogs/OfficeDevPnP/PnP-Web-Cast-Introduction-to-Office-365-PnP-PowerShell +* https://channel9.msdn.com/blogs/OfficeDevPnP/Introduction-to-PnP-PowerShell-Cmdlets +* https://channel9.msdn.com/blogs/OfficeDevPnP/PnP-Webcast-PnP-PowerShell-Getting-started-with-latest-updates +### Setting up credentials ## See this [wiki page](https://github.com/pnp/PnP-PowerShell/wiki/How-to-use-the-Windows-Credential-Manager-to-ease-authentication-with-PnP-PowerShell) for more information on how to use the Windows Credential Manager to setup credentials that you can use in unattended scripts ## Cmdlet overview -### Apps - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Add-PnPApp|Add/uploads an available app to the app catalog|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Get-PnPApp|Returns the available apps from the app catalog|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Install-PnPApp|Installs an available app from the app catalog|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Publish-PnPApp|Publishes/Deploys/Trusts an available app in the app catalog|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Remove-PnPApp|Removes an app from the app catalog|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Uninstall-PnPApp|Uninstalls an available add-in from the site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Unpublish-PnPApp|Unpublishes/retracts an available add-in from the app catalog|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Update-PnPApp|Updates an available app from the app catalog|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Get-PnPAppInstance|Returns a SharePoint AddIn Instance|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Uninstall-PnPAppInstance|Removes an app from a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPApplicationCustomizer|Adds a SharePoint Framework client side extension application customizer|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Get-PnPApplicationCustomizer|Returns all SharePoint Framework client side extension application customizers|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Remove-PnPApplicationCustomizer|Removes a SharePoint Framework client side extension application customizer|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Set-PnPApplicationCustomizer|Updates a SharePoint Framework client side extension application customizer|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Import-PnPAppPackage|Adds a SharePoint Addin to a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Sync-PnPAppToTeams|Synchronize an app from the tenant app catalog to the Microsoft Teams app catalog|SharePoint Online| -|@SharePointPnPPowerShell.Grant-PnPTenantServicePrincipalPermission|Explicitly grants a specified permission to the "SharePoint Online Client" service principal|SharePoint Online| - -### Base Cmdlets - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Request-PnPAccessToken|Requests an OAuth Access token|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPAppAuthAccessToken|Returns the access token|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPAuthenticationRealm|Returns the authentication realm|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPAzureCertificate|Get PEM values and manifest settings for an existing certificate (.pfx) for use when using CSOM via an app-only ADAL application. See for a sample on how to get started. KeyCredentials contains the ADAL app manifest sections. Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPAzureCertificate|Generate a new 2048bit self-signed certificate and manifest settings for use when using CSOM via an app-only ADAL application. See for a sample on how to get started. KeyCredentials contains the ADAL app manifest sections. Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPConnection|Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPContext|Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPContext|Set the ClientContext|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPException|Returns the last exception that occurred|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPHealthScore|Retrieves the healthscore of the site given in his Url parameter or from the current connection if the Url parameter is not provided|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019| -|@SharePointPnPPowerShell.Connect-PnPOnline|Connect to a SharePoint site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Disconnect-PnPOnline|Disconnects the context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPProperty|Returns a previously not loaded property of a ClientObject|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Invoke-PnPQuery|Executes the currently queued actions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Invoke-PnPSPRestMethod|Invokes a REST request towards a SharePoint site|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPStoredCredential|Adds a credential to the Windows Credential Manager|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPStoredCredential|Get a credential|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPStoredCredential|Removes a credential|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTraceLog|Turn log tracing on or off|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Branding - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Add-PnPCustomAction|Adds a custom action|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPCustomAction|Return user custom actions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPCustomAction|Removes a custom action|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPFooter|Gets the configuration regarding the footer of the current web|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPFooter|Configures the footer of the current web|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPHomePage|Return the homepage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPHomePage|Sets the home page of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPJavaScriptBlock|Adds a link to a JavaScript snippet/block to a web or site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPJavaScriptLink|Adds a link to a JavaScript file to a web or sitecollection, valid only for SharePoint classic site experience.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPJavaScriptLink|Returns all or a specific custom action(s) with location type ScriptLink|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPJavaScriptLink|Removes a JavaScript link or block from a web or sitecollection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPMasterPage|Returns the URLs of the default Master Page and the custom Master Page.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPMasterPage|Set the masterpage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPMinimalDownloadStrategy|Activates or deactivates the minimal downloading strategy.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPNavigationNode|Adds an item to a navigation element|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPNavigationNode|Returns all or a specific navigation node|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPNavigationNode|Removes a menu item from either the quicklaunch or top navigation|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Disable-PnPResponsiveUI|Deactivate the PnP Response UI add-on|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Enable-PnPResponsiveUI|Activates the PnP Response UI Add-on|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTheme|Returns the current theme/composed look of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTheme|Sets the theme of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPWebTheme|Sets the theme of the current web.|SharePoint Online| - -### Client-Side Pages - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Get-PnPAvailableClientSideComponents|Gets the available client side components on a particular page|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Move-PnPClientSideComponent|Moves a Client-Side Component to a different section/column|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Add-PnPClientSidePage|Adds a Client-Side Page|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.ConvertTo-PnPClientSidePage|Converts a classic page (wiki or web part page) into a Client-Side Page|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPClientSidePage|Gets a modern site page|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Remove-PnPClientSidePage|Removes a Client-Side Page|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Set-PnPClientSidePage|Sets parameters of a Client-Side Page|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Save-PnPClientSidePageConversionLog|Persists the current client side page conversion log data to the loggers linked to the last used page transformation run. Needs to be used in conjunction with the -LogSkipFlush flag on the ConvertTo-PnPClientSidePage cmdlet|SharePoint Online| -|@SharePointPnPPowerShell.Export-PnPClientSidePageMapping|Gets the built-in maping files or a custom mapping file for your publishing portal page layouts. These mapping files are used to tailor the page transformation experience.|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPClientSidePageSection|Adds a new section to a Client-Side page|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Add-PnPClientSideText|Adds a text element to a client-side page.|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Add-PnPClientSideWebPart|Adds a Client-Side Web Part to a client-side page|SharePoint Online, SharePoint 2019| - -### Content Types - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Add-PnPContentType|Adds a new content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPContentType|Retrieves a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPContentType|Removes a content type from a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPContentTypeFromList|Removes a content type from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPContentTypePublishingHubUrl|Returns the url to Content Type Publishing Hub|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPContentTypeToList|Adds a new content type to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPDefaultContentTypeToList|Sets the default content type for a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPFieldFromContentType|Removes a site column from a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPFieldToContentType|Adds an existing site column to a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Diagnostic utilities - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Measure-PnPList|Returns statistics on the list object. This may fail on lists larger than the list view threshold|SharePoint Online, SharePoint 2016, SharePoint 2019| -|@SharePointPnPPowerShell.Measure-PnPResponseTime|Gets statistics on response time for the specified endpoint by sending probe requests|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Measure-PnPWeb|Returns statistics on the web object|SharePoint Online, SharePoint 2016, SharePoint 2019| - -### Document Sets - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Remove-PnPContentTypeFromDocumentSet|Removes a content type from a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPContentTypeToDocumentSet|Adds a content type to a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPDocumentSet|Creates a new document set in a library.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPDocumentSetField|Sets a site column from the available content types to a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPDocumentSetTemplate|Retrieves a document set template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Event Receivers - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Add-PnPEventReceiver|Adds a new remote event receiver|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPEventReceiver|Return registered eventreceivers|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPEventReceiver|Remove an eventreceiver|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Features - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.New-PnPExtensibilityHandlerObject|Creates an ExtensibilityHandler Object, to be used by the Get-PnPProvisioningTemplate cmdlet|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Disable-PnPFeature|Disables a feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Enable-PnPFeature|Enables a feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPFeature|Returns all activated or a specific activated feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Fields - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Add-PnPField|Add a field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPField|Returns a field from a list or site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPField|Removes a field from a list or a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPField|Changes one or more properties of a field in a specific list or for the whole web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPFieldFromXml|Adds a field to a list or as a site column based upon a CAML/XML field definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPTaxonomyField|Add a taxonomy field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPView|Change view properties|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Files and Folders - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Add-PnPFile|Uploads a file to Web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Copy-PnPFile|Copies a file or folder to a different location. This location can be within the same document library, same site, same site collection or even to another site collection on the same tenant. Currently there is a 200MB file size limit for the file or folder to be copied.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Find-PnPFile|Finds a file in the virtual file system of the web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPFile|Downloads a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Move-PnPFile|Moves a file or folder to a different location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPFile|Removes a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Rename-PnPFile|Renames a file in its current location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPFileCheckedIn|Checks in a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPFileCheckedOut|Checks out a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPFileVersion|Retrieves all versions of a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPFileVersion|Removes all or a specific file version.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Reset-PnPFileVersion|Resets a file to its previous version|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Restore-PnPFileVersion|Restores a specific file version.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPFolder|Creates a folder within a parent folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPFolder|Return a folder object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Move-PnPFolder|Move a folder to another location in the current web. If you want to move a folder to a different site collection, use the Move-PnPFile cmdlet instead, which also supports moving folders and also across site collections.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPFolder|Deletes a folder within a parent folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Rename-PnPFolder|Renames a folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Resolve-PnPFolder|Returns a folder from a given site relative path, and will create it if it does not exist.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPFolderItem|List content in folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Copy-PnPItemProxy|Proxy cmdlet for using Copy-Item between SharePoint provider and FileSystem provider|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Move-PnPItemProxy|Proxy cmdlet for using Move-Item between SharePoint provider and FileSystem provider|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Information Management - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Get-PnPLabel|Gets the Office 365 retention label/tag of the specified list or library (if applicable)|SharePoint Online| -|@SharePointPnPPowerShell.Reset-PnPLabel|Resets a retention label on the specified list or library to None|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPLabel|Sets a retention label on the specified list or library. Use Reset-PnPLabel to remove the label again.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPListInformationRightsManagement|Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPListInformationRightsManagement|Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteClosure|Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPSiteClosure|Opens or closes a site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPSitePolicy|Sets a site policy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSitePolicy|Retrieves all or a specific site policy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Lists - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Clear-PnPDefaultColumnValues|Clear default column values for a document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPDefaultColumnValues|Gets the default column values for all folders in document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPDefaultColumnValues|Sets default column values for a document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPFolderPermission|Sets folder permissions. Use Get-PnPRoleDefinition to retrieve all available roles you can add or remove using this cmdlet.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPList|Returns lists from SharePoint|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPList|Creates a new list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPList|Deletes a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPList|Updates list settings|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPListItem|Adds an item to the list and sets the creation time to the current date and time. The author is set to the current authenticated user executing the cmdlet. In order to set the author to a different user, please refer to Set-PnPListItem.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPListItem|Retrieves list items|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPListItem|Deletes an item from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPListItem|Updates a list item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPListItemPermission|Sets list item permissions. Use Get-PnPRoleDefinition to retrieve all available roles you can add or remove using this cmdlet.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Move-PnPListItemToRecycleBin|Moves an item from a list to the Recycle Bin|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPListPermission|Sets list permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Request-PnPReIndexList|Marks the list for full indexing during the next incremental crawl|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPView|Adds a view to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPView|Returns one or all views from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPView|Deletes a view from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Management API - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Get-PnPManagementApiAccessToken|Gets an access token for the Office 365 Management API|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPOffice365CurrentServiceStatus|Gets current service status of the Office 365 Services from the Office 365 Management API|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPOffice365HistoricalServiceStatus|Gets the historical service status of the Office 365 Services of the last 7 days from the Office 365 Management API|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPOffice365ServiceMessage|Gets the service messages regarding services in Office 365 from the Office 365 Management API|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPOffice365Services|Gets the services available in Office 365 from the Office 365 Management API|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPOfficeManagementApiAccessToken|Gets an access token for the Microsoft Office 365 Management API from the current connection|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPUnifiedAuditLog|Gets unified audit logs from the Office 365 Management API. Requires the Azure Active Directory application permission 'ActivityFeed.Read'.|SharePoint Online| - -### Microsoft Graph - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Get-PnPAADUser|Retrieves users from Azure Active Directory|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPAccessToken|Returns the current OAuth Access token|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPDeletedMicrosoft365Group|Gets one deleted Microsoft 365 Group or a list of deleted Microsoft 365 Groups|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPDeletedMicrosoft365Group|Permanently removes one deleted Microsoft 365 Group|SharePoint Online| -|@SharePointPnPPowerShell.Restore-PnPDeletedMicrosoft365Group|Restores one deleted Microsoft 365 Group|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPGraphSubscription|Gets subscriptions from Microsoft Graph. Requires the Azure Active Directory application permission 'Subscription.Read.All'.|SharePoint Online| -|@SharePointPnPPowerShell.New-PnPGraphSubscription|Creates a new Microsof Graph Subscription which allows your webhook API to be called when a change occurs in Microsoft Graph|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPGraphSubscription|Removes an existing Microsoft Graph subscription. Required Azure Active Directory application permission depends on the resource the subscription exists on, see .|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPGraphSubscription|Updates an existing Microsoft Graph subscription. Required Azure Active Directory application permission depends on the resource the subscription exists on, see .|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPMicrosoft365Group|Gets one Microsoft 365 Group or a list of Microsoft 365 Groups|SharePoint Online| -|@SharePointPnPPowerShell.New-PnPMicrosoft365Group|Creates a new Microsoft 365 Group|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPMicrosoft365Group|Removes one Microsoft 365 Group|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPMicrosoft365Group|Sets Microsoft 365 Group properties|SharePoint Online| -|@SharePointPnPPowerShell.Reset-PnPMicrosoft365GroupExpiration|Renews the Microsoft 365 Group by extending its expiration with the number of days defined in the group expiration policy set on the Azure Active Directory|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPMicrosoft365GroupMember|Adds members to a particular Microsoft 365 Group|SharePoint Online| -|@SharePointPnPPowerShell.Clear-PnPMicrosoft365GroupMember|Removes all current members from a particular Microsoft 365 Group|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPMicrosoft365GroupMember|Removes members from a particular Microsoft 365 Group|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPMicrosoft365GroupMembers|Gets members of a particular Microsoft 365 Group (aka Unified Group). Requires the Azure Active Directory application permissions 'Group.Read.All' and 'User.Read.All'.|SharePoint Online| -|@SharePointPnPPowerShell.Clear-PnPMicrosoft365GroupOwner|Removes all current owners from a particular Microsoft 365 Group (aka Unified Group)|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPMicrosoft365GroupOwner|Removes owners from a particular Microsoft 365 Group|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPMicrosoft365GroupOwners|Gets owners of a particular Microsoft 365 Group|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPSiteClassification|Adds one ore more site classification values to the list of possible values|SharePoint Online| -|@SharePointPnPPowerShell.Disable-PnPSiteClassification|Disables Site Classifications for the tenant|SharePoint Online| -|@SharePointPnPPowerShell.Enable-PnPSiteClassification|Enables Site Classifications for the tenant|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteClassification|Returns the defined Site Classifications for the tenant|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPSiteClassification|Removes one or more existing site classification values from the list of available values|SharePoint Online| -|@SharePointPnPPowerShell.Update-PnPSiteClassification|Updates Site Classifications for the tenant|SharePoint Online| - -### Microsoft Teams - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Get-PnPTeamsApp|Gets one Microsoft Teams App or a list of all apps.|SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTeamsApp|Adds an app to the Teams App Catalog.|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPTeamsApp|Removes an app from the Teams AppCatalog.|SharePoint Online| -|@SharePointPnPPowerShell.Update-PnPTeamsApp|Updates an existing app in the Teams App Catalog.|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPTeamsChannel|Adds a channel to an existing Microsoft Teams instance.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTeamsChannel|Gets the channels for a specified Team.|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPTeamsChannel|Removes a channel from a Microsoft Teams instance.|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTeamsChannel|Updates an existing Teams Channel|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTeamsChannelMessage|Sends a message to a Microsoft Teams Channel.|SharePoint Online| -|@SharePointPnPPowerShell.Submit-PnPTeamsChannelMessage|Sends a message to a Microsoft Teams Channel.|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPTeamsTab|Adds a tab to an existing Channel|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTeamsTab|Gets one or all tabs in a channel.|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPTeamsTab|Removes a Microsoft Teams tab in a channel.|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTeamsTab|Updates Teams Tab settings|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTeamsTeam|Gets one Microsoft Teams Team or a list of Teams.|SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTeamsTeam|Creates a new Team in Microsoft Teams. The cmdlet will create a Microsoft 365 group and then add a team to the group.|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPTeamsTeam|Removes a Microsoft Teams Team instance|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTeamsTeam|Updates an existing Team.|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTeamsTeamArchivedState|Sets the archived state of a team.|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTeamsTeamPicture|Sets the picture of an existing team.|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPTeamsUser|Adds a channel to an existing Microsoft Teams instance.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTeamsUser|Returns owners, members or guests from a team.|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPTeamsUser|Removes users from a team.|SharePoint Online| - -### Provisioning - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Export-PnPClientSidePage|Exports a Client Side Page to a PnP Provisioning Template|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPDataRowsToProvisioningTemplate|Adds datarows to a list inside a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPFileFromProvisioningTemplate|Removes a file from a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPFileToProvisioningTemplate|Adds a file to a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Convert-PnPFolderToProvisioningTemplate|Creates a pnp package file of an existing template xml, and includes all files in the current folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPListFoldersToProvisioningTemplate|Adds folders to a list in a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Export-PnPListToProvisioningTemplate|Exports one or more lists to provisioning template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPProvisioningTemplate|Adds a PnP Provisioning Template object to a tenant template|SharePoint Online| -|@SharePointPnPPowerShell.Apply-PnPProvisioningTemplate|Applies a site template to a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Convert-PnPProvisioningTemplate|Converts a provisioning template to an other schema version|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPProvisioningTemplate|Generates a provisioning site template from a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPProvisioningTemplate|Creates a new provisioning template object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Read-PnPProvisioningTemplate|Loads/Reads a PnP file from the file system or a string|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Save-PnPProvisioningTemplate|Saves a PnP site template to the file system|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPProvisioningTemplateFromFolder|Generates a provisioning template from a given folder, including only files that are present in that folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPProvisioningTemplateMetadata|Sets metadata of a provisioning template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPTenantSequence|Adds a tenant sequence object to a tenant template|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantSequence|Returns one ore more provisioning sequence object(s) from a tenant template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTenantSequence|Creates a new tenant sequence object|SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTenantSequenceCommunicationSite|Creates a communication site object|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPTenantSequenceSite|Adds a existing tenant sequence site object to a tenant template|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantSequenceSite|Returns one ore more sites from a tenant template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPTenantSequenceSubSite|Adds a tenant sequence sub site object to a tenant sequence site object|SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTenantSequenceTeamNoGroupSite|Creates a new team site without a Microsoft 365 group in-memory object|SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTenantSequenceTeamNoGroupSubSite|Creates a team site subsite with no Microsoft 365 group object|SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTenantSequenceTeamSite|Creates a team site object|SharePoint Online| -|@SharePointPnPPowerShell.Apply-PnPTenantTemplate|Applies a tenant template to the current tenant. You must have the Office 365 Global Admin role to run this cmdlet successfully.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantTemplate|Generates a provisioning tenant template from a site. If the site is a hubsite any connected site will be included.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTenantTemplate|Creates a new tenant template object|SharePoint Online| -|@SharePointPnPPowerShell.Read-PnPTenantTemplate|Loads/Reads a PnP tenant template from the file system and returns an in-memory instance of this template.|SharePoint Online| -|@SharePointPnPPowerShell.Save-PnPTenantTemplate|Saves a PnP provisioning hierarchy to the file system|SharePoint Online| -|@SharePointPnPPowerShell.Test-PnPTenantTemplate|Tests a tenant template for invalid references|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Publishing - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Set-PnPAvailablePageLayouts|Sets the available page layouts for the current site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPDefaultPageLayout|Sets a specific page layout to be the default page layout for a publishing site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPHtmlPublishingPageLayout|Adds a HTML based publishing page layout|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPMasterPage|Adds a Masterpage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPPublishingImageRendition|Adds an Image Rendition if the Name of the Image Rendition does not already exist. This prevents creating two Image Renditions that share the same name.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPPublishingImageRendition|Returns all image renditions or if Identity is specified a specific one|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPPublishingImageRendition|Removes an existing image rendition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPPublishingPage|Adds a publishing page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPPublishingPageLayout|Adds a publishing page layout|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPWikiPage|Adds a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPWikiPage|Removes a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPWikiPageContent|Gets the contents/source of a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPWikiPageContent|Sets the contents of a wikipage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Records Management - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Get-PnPInPlaceRecordsManagement|Returns if the place records management feature is enabled.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPInPlaceRecordsManagement|Activates or deactivates in the place records management feature.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Disable-PnPInPlaceRecordsManagementForSite|Disables in place records management for a site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Enable-PnPInPlaceRecordsManagementForSite|Enables in place records management for a site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Clear-PnPListItemAsRecord|Undeclares a list item as a record|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPListItemAsRecord|Declares a list item as a record, for more information, see .|SharePoint Online| -|@SharePointPnPPowerShell.Test-PnPListItemIsRecord|Checks if a list item is a record|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPListRecordDeclaration|Returns the manual record declaration settings for a list|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPListRecordDeclaration|The RecordDeclaration parameter supports 4 values: AlwaysAllowManualDeclaration NeverAllowManualDeclaration UseSiteCollectionDefaults|SharePoint Online| - -### Search - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Get-PnPSearchConfiguration|Returns the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPSearchConfiguration|Remove the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPSearchConfiguration|Sets the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSearchCrawlLog|Returns entries from the SharePoint search crawl log. Make sure you are granted access to the crawl log via the SharePoint search admin center at `https://-admin.sharepoint.com/_layouts/15/searchadmin/crawllogreadpermission.aspx` in order to run this cmdlet.|SharePoint Online| -|@SharePointPnPPowerShell.Submit-PnPSearchQuery|Executes an arbitrary search query against the SharePoint search index|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSearchSettings|Retrieves search settings for a site|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPSearchSettings|Sets search settings for a site|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteSearchQueryResults|Executes a search query to retrieve indexed site collections|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### SharePoint Recycle Bin - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Clear-PnPRecycleBinItem|Permanently deletes all or a specific recycle bin item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPRecycleBinItem|Returns the items in the recycle bin from the context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Move-PnPRecycleBinItem|Moves all items or a specific item in the first stage recycle bin of the current site collection to the second stage recycle bin|SharePoint Online| -|@SharePointPnPPowerShell.Restore-PnPRecycleBinItem|Restores the provided recycle bin item to its original location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantRecycleBinItem|Returns all modern and classic site collections in the tenant scoped recycle bin|SharePoint Online| - -### SharePoint WebHooks - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Add-PnPWebhookSubscription|Adds a new Webhook subscription|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPWebhookSubscription|Removes a Webhook subscription from the resource|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPWebhookSubscription|Updates a Webhook subscription|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPWebhookSubscriptions|Gets all the Webhook subscriptions of the resource|SharePoint Online| - -### Sites - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Set-PnPAppSideLoading|Enables the App SideLoading Feature on a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPAuditing|Get the Auditing setting of a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPAuditing|Set Auditing setting for a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Enable-PnPCommSite|Enables the modern communication site experience on a classic team site.|SharePoint Online| -|@SharePointPnPPowerShell.Test-PnPOffice365GroupAliasIsUsed|Tests if a given alias is already used used|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPRoleDefinition|Adds a Role Definition (Permission Level) to the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPRoleDefinition|Retrieves a Role Definitions of a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPRoleDefinition|Remove a Role Definition from a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Disable-PnPSharingForNonOwnersOfSite|Configures the site to only allow sharing of the site and items in the site by owners|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSharingForNonOwnersOfSite|Returns $false if sharing of the site and items in the site is restricted only to owners or $true if members and owners are allowed to share|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSite|Returns the current site collection from the context.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPSite|Sets Site Collection properties.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPSiteCollectionAdmin|Adds one or more users as site collection administrators to the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteCollectionAdmin|Returns the current site collection administrators of the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPSiteCollectionAdmin|Removes one or more users as site collection administrators from the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Install-PnPSolution|Installs a sandboxed solution to a site collection. WARNING! This method can delete your composed look gallery due to the method used to activate the solution. We recommend you to only to use this cmdlet if you are okay with that.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Uninstall-PnPSolution|Uninstalls a sandboxed solution from a site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPTeamsTeam|Adds a Teams team to an existing, group connected, site collection|SharePoint Online| - -### Taxonomy - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Get-PnPSiteCollectionTermStore|Returns the site collection term store|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Export-PnPTaxonomy|Exports a taxonomy to either the output or to a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Import-PnPTaxonomy|Imports a taxonomy from either a string array or a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTaxonomyFieldValue|Sets a taxonomy term value in a listitem field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTaxonomyItem|Returns a taxonomy item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPTaxonomyItem|Removes a taxonomy item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTaxonomySession|Returns a taxonomy session|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTerm|Returns a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTerm|Creates a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTermGroup|Returns a taxonomy term group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTermGroup|Creates a taxonomy term group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPTermGroup|Removes a taxonomy term group and all its containing termsets|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Import-PnPTermGroupFromXml|Imports a taxonomy TermGroup from either the input or from an XML file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Export-PnPTermGroupToXml|Exports a taxonomy TermGroup to either the output or to an XML file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTermLabel|Creates a localized label for a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTermSet|Returns a taxonomy term set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Import-PnPTermSet|Imports a taxonomy term set from a file in the standard format.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPTermSet|Creates a taxonomy term set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Tenant Administration - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Register-PnPAppCatalogSite|Creates a new App Catalog Site and sets this site as the Tenant App Catalog|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPGraphAccessToken|Returns the current OAuth Access token for the Microsoft Graph API|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPHideDefaultThemes|Returns if the default / OOTB themes should be visible to users or not.|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPHideDefaultThemes|Defines if the default / OOTB themes should be visible to users or not.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPHomeSite|Returns the home site url for your tenant|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPHomeSite|Removes the currently set site as the home site|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPHomeSite|Sets the home site for your tenant|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPHubSite|Retrieve all or a specific hubsite.|SharePoint Online| -|@SharePointPnPPowerShell.Register-PnPHubSite|Registers a site as a hubsite|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPHubSite|Sets hub site properties|SharePoint Online| -|@SharePointPnPPowerShell.Unregister-PnPHubSite|Unregisters a site as a hubsite|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPHubSiteAssociation|Connects a site to a hubsite.|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPHubSiteAssociation|Disconnects a site from a hubsite.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPHubSiteChild|Retrieves all sites linked to a specific hub site|SharePoint Online| -|@SharePointPnPPowerShell.Grant-PnPHubSiteRights|Grant additional permissions to the permissions already in place to associate sites to Hub Sites for one or more specific users|SharePoint Online| -|@SharePointPnPPowerShell.Revoke-PnPHubSiteRights|Revoke permissions to the permissions already in place to associate sites to Hub Sites for one or more specific users|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPIsSiteAliasAvailable|Validates if a certain alias is still available to be used to create a new site collection for. If it is not, it will propose an alternative alias and URL which is still available.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPKnowledgeHubSite|Gets the Knowledge Hub Site URL for your tenant|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPKnowledgeHubSite|Removes the Knowledge Hub Site setting for your tenant|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPKnowledgeHubSite|Sets the Knowledge Hub Site for your tenant|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPMicrosoft365GroupToSite|Groupifies a classic team site by creating a Microsoft 365 group for it and connecting the site with the newly created group|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPOrgAssetsLibrary|Adds a given document library as a organizational asset source|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPOrgAssetsLibrary|Returns the list of all the configured organizational asset libraries|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPOrgAssetsLibrary|Removes a given document library as a organizational asset source|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPOrgNewsSite|Adds the site as an organization news source in your tenant|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPOrgNewsSite|Returns the list of all the configured organizational news sites.|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPOrgNewsSite|Removes a given site from the list of organizational news sites.|SharePoint Online| -|@SharePointPnPPowerShell.Initialize-PnPPowerShellAuthentication|Initializes a Azure AD App and optionally creates a new self-signed certificate to use with the application registration.|SharePoint Online| -|@SharePointPnPPowerShell.Disable-PnPPowerShellTelemetry|Disables PnP PowerShell telemetry tracking|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Enable-PnPPowerShellTelemetry|Enables PnP PowerShell telemetry tracking.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPPowerShellTelemetryEnabled|Returns true if the PnP PowerShell Telemetry has been enabled.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPSite|Creates either a communication site or a Microsoft 365 group-connected team site|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPSiteCollectionAppCatalog|Adds a Site Collection scoped App Catalog to a site|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPSiteCollectionAppCatalog|Removes a Site Collection scoped App Catalog from a site|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPSiteDesign|Creates a new Site Design on the current tenant.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteDesign|Retrieve Site Designs that have been registered on the current tenant.|SharePoint Online| -|@SharePointPnPPowerShell.Invoke-PnPSiteDesign|Apply a Site Design to an existing site. *Requires Tenant Administration Rights*|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPSiteDesign|Removes a Site Design|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPSiteDesign|Updates a Site Design on the current tenant.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteDesignRights|Returns the principals with design rights on a specific Site Design|SharePoint Online| -|@SharePointPnPPowerShell.Grant-PnPSiteDesignRights|Grants the specified principals rights to use the site design.|SharePoint Online| -|@SharePointPnPPowerShell.Revoke-PnPSiteDesignRights|Revokes the specified principals rights to use the site design.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteDesignRun|Retrieves a list of site designs applied to a specified site collection. If the WebUrl parameter is not specified we show the list of designs applied to the current site. The returned output includes the ID of the scheduled job, the web and site IDs, and the site design ID, version, and title.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteDesignRunStatus|Retrieves and displays a list of all site script actions executed for a specified site design applied to a site.|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPSiteDesignTask|This command is used to apply a published site design to a specified site collection target. It schedules the operation, allowing for the application of larger site scripts (Invoke-PnPSiteDesign is limited to 30 actions and subactions). This command is intended to replace Invoke-PnPSiteDesign and is useful when you need to apply a large number of actions or multiple site scripts.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteDesignTask|Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design task and the URL for the site where the site design is scheduled to be applied.|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPSiteDesignTask|Removes a Site Design Task. If the execution of the associated site script has already started the execution will not be terminated.|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPSiteScript|Creates a new Site Script on the current tenant.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteScript|Retrieve Site Scripts that have been registered on the current tenant.|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPSiteScript|Removes a Site Script|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPSiteScript|Updates an existing Site Script on the current tenant.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteScriptFromList|Generates a Site Script from an existing list|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSiteScriptFromWeb|Generates a Site Script from an existing site|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPStorageEntity|Retrieve Storage Entities / Farm Properties from either the Tenant App Catalog or from the current site if it has a site scope app catalog.|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPStorageEntity|Remove Storage Entities / Farm Properties from either the tenant scoped app catalog or the current site collection if the site has a site collection scoped app catalog|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPStorageEntity|Set Storage Entities / Farm Properties in either the tenant scoped app catalog or the site collection app catalog.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenant|Returns organization-level site collection properties|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTenant|Sets organization-level site collection properties|SharePoint Online| -|@SharePointPnPPowerShell.Clear-PnPTenantAppCatalogUrl|Removes the url of the tenant scoped app catalog. It will not delete the site collection itself.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantAppCatalogUrl|Retrieves the url of the tenant scoped app catalog|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTenantAppCatalogUrl|Sets the url of the tenant scoped app catalog|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantCdnEnabled|Retrieves if the Office 365 Content Delivery Network has been enabled.|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTenantCdnEnabled|Enables or disabled the public or private Office 365 Content Delivery Network (CDN).|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPTenantCdnOrigin|Adds a new origin to the public or private content delivery network (CDN).|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantCdnOrigin|Returns the current registered origins from the public or private content delivery network (CDN).|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPTenantCdnOrigin|Removes an origin from the Public or Private content delivery network (CDN).|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantCdnPolicies|Returns the CDN Policies for the specified CDN (Public| Private).|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTenantCdnPolicy|Sets the CDN Policies for the specified CDN (Public| Private).|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantId|Returns the Tenant ID|SharePoint Online| -|@SharePointPnPPowerShell.Clear-PnPTenantRecycleBinItem|Permanently deletes a site collection from the tenant scoped recycle bin|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Restore-PnPTenantRecycleBinItem|Restores a site collection from the tenant scoped recycle bin|SharePoint Online| -|@SharePointPnPPowerShell.Disable-PnPTenantServicePrincipal|Enables the current tenant's "SharePoint Online Client" service principal.|SharePoint Online| -|@SharePointPnPPowerShell.Enable-PnPTenantServicePrincipal|Enables the current tenant's "SharePoint Online Client" service principal.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantServicePrincipal|Returns the current tenant's "SharePoint Online Client" service principal.|SharePoint Online| -|@SharePointPnPPowerShell.Revoke-PnPTenantServicePrincipalPermission|Revokes a permission that was previously granted to the "SharePoint Online Client" service principal.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantServicePrincipalPermissionGrants|Gets the collection of permission grants for the "SharePoint Online Client" service principal|SharePoint Online| -|@SharePointPnPPowerShell.Approve-PnPTenantServicePrincipalPermissionRequest|Approves a permission request for the current tenant's "SharePoint Online Client" service principal|SharePoint Online| -|@SharePointPnPPowerShell.Deny-PnPTenantServicePrincipalPermissionRequest|Denies a permission request for the current tenant's "SharePoint Online Client" service principal|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantServicePrincipalPermissionRequests|Gets the collection of permission requests for the "SharePoint Online Client" service principal|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantSite|Retrieve site information.|SharePoint Online, SharePoint 2016, SharePoint 2019| -|@SharePointPnPPowerShell.New-PnPTenantSite|Creates a new (classic) site collection for the current tenant|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPTenantSite|Removes a site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTenantSite|Updates settings of a site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantSyncClientRestriction|Returns organization-level OneDrive synchronization restriction settings|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPTenantSyncClientRestriction|Sets organization-level sync client restriction properties|SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPTenantTheme|Adds or updates a theme to the tenant.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTenantTheme|Returns all or a specific theme|SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPTenantTheme|Removes a theme|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPTimeZoneId|Returns a time zone ID|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPWebTemplates|Returns the available classic web templates|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### User and group management - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Add-PnPAlert|Adds an alert for a user to a list|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Get-PnPAlert|Returns registered alerts for a user.|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Remove-PnPAlert|Removes an alert for a user|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Get-PnPGroup|Returns a specific SharePoint group or all SharePoint groups in site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPGroup|Adds group to the Site Groups List and returns a group object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPGroup|Removes a group from a web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPGroup|Updates a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPGroupMembers|Retrieves all members of a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPGroupPermissions|Returns the permissions for a specific SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPGroupPermissions|Adds and/or removes permissions of a specific SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPUser|Returns site users of current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPUser|Adds a user to the built-in Site User Info List and returns a user object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPUser|Removes a specific user from the site collection User Information List|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPUserFromGroup|Removes a user from a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPUserToGroup|Adds a user to a SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### User Profiles - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.New-PnPPersonalSite|Office365 only: Creates a personal / OneDrive For Business site|SharePoint Online| -|@SharePointPnPPowerShell.New-PnPUPABulkImportJob|Submit up a new user profile bulk import job.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPUPABulkImportStatus|Get user profile bulk import status.|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPUserOneDriveQuota|Retrieves the current quota set on the OneDrive for Business site for a specific user|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPUserOneDriveQuota|Sets the quota on the OneDrive for Business site for a specific user|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Reset-PnPUserOneDriveQuotaToDefault|Resets the current quota set on the OneDrive for Business site for a specific user to the tenant default|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPUserProfileProperty|You must connect to the tenant admin website (`https://:-admin.sharepoint.com`) with Connect-PnPOnline in order to use this cmdlet.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPUserProfileProperty|Office365 only: Uses the tenant API to retrieve site information. You must connect to the tenant admin website (`https://:-admin.sharepoint.com`) with Connect-PnPOnline in order to use this command.|SharePoint Online| - -### Utilities - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Send-PnPMail|Sends an email using the Office 365 SMTP Service or SharePoint, depending on the parameters specified. See detailed help for more information.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Web Parts - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Get-PnPClientSideComponent|Retrieve one or more Client-Side components from a site page|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Remove-PnPClientSideComponent|Removes a Client-Side component from a page|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Set-PnPClientSideText|Set Client-Side Text Component properties|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Set-PnPClientSideWebPart|Set Client-Side Web Part properties|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Get-PnPWebPart|Returns a web part definition object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPWebPart|Removes a web part from a page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPWebPartProperty|Returns a web part property|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPWebPartProperty|Sets a web part property|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPWebPartToWebPartPage|Adds a web part to a web part page in a specified zone|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPWebPartToWikiPage|Adds a web part to a wiki page in a specified table row and column|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPWebPartXml|Returns the web part XML of a web part registered on a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Webs - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Get-PnPAvailableLanguage|Returns the available languages on the current web|SharePoint Online, SharePoint 2019| -|@SharePointPnPPowerShell.Set-PnPIndexedProperties|Marks values of the propertybag to be indexed by search. Notice that this will overwrite the existing flags, i.e. only the properties you define with the cmdlet will be indexed.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPIndexedProperty|Marks the value of the propertybag key specified to be indexed by search.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPIndexedProperty|Removes a key from propertybag to be indexed by search. The key and it's value remain in the propertybag, however it will not be indexed anymore.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPIndexedPropertyKeys|Returns the keys of the property bag values that have been marked for indexing by search|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPPropertyBag|Returns the property bag values.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPPropertyBagValue|Removes a value from the property bag|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPPropertyBagValue|Sets a property bag value|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Request-PnPReIndexWeb|Marks the web for full indexing during the next incremental crawl|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPRequestAccessEmails|Returns the request access e-mail addresses|SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPRequestAccessEmails|Sets Request Access Email on a web|SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPSubWebs|Returns the subwebs of the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPWeb|Returns the current web object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.New-PnPWeb|Creates a new subweb under the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPWeb|Removes a subweb in the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPWeb|Sets properties on a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Invoke-PnPWebAction|Executes operations on web, lists and list items.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Set-PnPWebPermission|Set permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| - -### Workflows - -|Cmdlet|Description|Platform| -|---|---|---| -|@SharePointPnPPowerShell.Add-PnPWorkflowDefinition|Adds a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPWorkflowDefinition|Returns a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPWorkflowDefinition|Removes a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPWorkflowInstance|Gets SharePoint 2010/2013 workflow instances|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Resume-PnPWorkflowInstance|Resume a workflow|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Start-PnPWorkflowInstance|Starts a SharePoint 2010/2013 workflow instance on a list item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Stop-PnPWorkflowInstance|Stops a workflow instance|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Add-PnPWorkflowSubscription|Adds a workflow subscription to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Get-PnPWorkflowSubscription|Return a workflow subscription|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| -|@SharePointPnPPowerShell.Remove-PnPWorkflowSubscription|Removes a SharePoint 2010/2013 workflow subscription|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online| + +### Apps +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Add-PnPApp |Add/uploads an available app to the app catalog|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Get-PnPApp |Returns the available apps from the app catalog|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Install-PnPApp |Installs an available app from the app catalog|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Publish-PnPApp |Publishes/Deploys/Trusts an available app in the app catalog|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Remove-PnPApp |Removes an app from the app catalog|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Uninstall-PnPApp |Uninstalls an available add-in from the site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Unpublish-PnPApp |Unpublishes/retracts an available add-in from the app catalog|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Update-PnPApp |Updates an available app from the app catalog|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Get-PnPAppInstance |Returns a SharePoint AddIn Instance|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Uninstall-PnPAppInstance |Removes an app from a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPApplicationCustomizer |Adds a SharePoint Framework client side extension application customizer|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Get-PnPApplicationCustomizer |Returns all SharePoint Framework client side extension application customizers|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Remove-PnPApplicationCustomizer |Removes a SharePoint Framework client side extension application customizer|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Set-PnPApplicationCustomizer |Updates a SharePoint Framework client side extension application customizer|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Import-PnPAppPackage |Adds a SharePoint Addin to a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Sync-PnPAppToTeams |Synchronize an app from the tenant app catalog to the Microsoft Teams app catalog|SharePoint Online +@SharePointPnPPowerShell.Grant-PnPTenantServicePrincipalPermission |Explicitly grants a specified permission to the "SharePoint Online Client" service principal|SharePoint Online + + +### Base Cmdlets +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Request-PnPAccessToken |Requests an OAuth Access token|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPAppAuthAccessToken |Returns the access token|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPAuthenticationRealm |Returns the authentication realm|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPAzureCertificate |Get PEM values and manifest settings for an existing certificate (.pfx) for use when using CSOM via an app-only ADAL application. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. KeyCredentials contains the ADAL app manifest sections. Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPAzureCertificate |Generate a new 2048bit self-signed certificate and manifest settings for use when using CSOM via an app-only ADAL application. See https://github.com/SharePoint/PnP-PowerShell/tree/master/Samples/SharePoint.ConnectUsingAppPermissions for a sample on how to get started. KeyCredentials contains the ADAL app manifest sections. Certificate contains the PEM encoded certificate. PrivateKey contains the PEM encoded private key of the certificate.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPConnection |Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPContext |Returns the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPContext |Set the ClientContext|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPException |Returns the last exception that occurred|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPHealthScore |Retrieves the healthscore of the site given in his Url parameter or from the current connection if the Url parameter is not provided|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 +@SharePointPnPPowerShell.Connect-PnPOnline |Connect to a SharePoint site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Disconnect-PnPOnline |Disconnects the context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPProperty |Returns a previously not loaded property of a ClientObject|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Invoke-PnPQuery |Executes the currently queued actions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Invoke-PnPSPRestMethod |Invokes a REST request towards a SharePoint site|SharePoint Online +@SharePointPnPPowerShell.Add-PnPStoredCredential |Adds a credential to the Windows Credential Manager|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPStoredCredential |Get a credential|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPStoredCredential |Removes a credential|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPTraceLog |Turn log tracing on or off|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Branding +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Add-PnPCustomAction |Adds a custom action|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPCustomAction |Return user custom actions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPCustomAction |Removes a custom action|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPFooter |Gets the configuration regarding the footer of the current web|SharePoint Online +@SharePointPnPPowerShell.Set-PnPFooter |Configures the footer of the current web|SharePoint Online +@SharePointPnPPowerShell.Get-PnPHomePage |Return the homepage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPHomePage |Sets the home page of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPJavaScriptBlock |Adds a link to a JavaScript snippet/block to a web or site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPJavaScriptLink |Adds a link to a JavaScript file to a web or sitecollection, valid only for SharePoint classic site experience.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPJavaScriptLink |Returns all or a specific custom action(s) with location type ScriptLink|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPJavaScriptLink |Removes a JavaScript link or block from a web or sitecollection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPMasterPage |Returns the URLs of the default Master Page and the custom Master Page.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPMasterPage |Set the masterpage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPMinimalDownloadStrategy |Activates or deactivates the minimal downloading strategy.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPNavigationNode |Adds an item to a navigation element|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPNavigationNode |Returns all or a specific navigation node|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPNavigationNode |Removes a menu item from either the quicklaunch or top navigation|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Disable-PnPResponsiveUI |Deactivate the PnP Response UI add-on|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Enable-PnPResponsiveUI |Activates the PnP Response UI Add-on|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPTheme |Returns the current theme/composed look of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPTheme |Sets the theme of the current web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPWebTheme |Sets the theme of the current web.|SharePoint Online + + +### Client-Side Pages +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Get-PnPAvailableClientSideComponents |Gets the available client side components on a particular page|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Move-PnPClientSideComponent |Moves a Client-Side Component to a different section/column|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Add-PnPClientSidePage |Adds a Client-Side Page|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.ConvertTo-PnPClientSidePage |Converts a classic page (wiki or web part page) into a Client-Side Page|SharePoint Online +@SharePointPnPPowerShell.Get-PnPClientSidePage |Gets a modern site page|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Remove-PnPClientSidePage |Removes a Client-Side Page|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Set-PnPClientSidePage |Sets parameters of a Client-Side Page|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Save-PnPClientSidePageConversionLog |Persists the current client side page conversion log data to the loggers linked to the last used page transformation run. Needs to be used in conjunction with the -LogSkipFlush flag on the ConvertTo-PnPClientSidePage cmdlet|SharePoint Online +@SharePointPnPPowerShell.Export-PnPClientSidePageMapping |Get's the built-in maping files or a custom mapping file for your publishing portal page layouts. These mapping files are used to tailor the page transformation experience.|SharePoint Online +@SharePointPnPPowerShell.Add-PnPClientSidePageSection |Adds a new section to a Client-Side page|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Add-PnPClientSideText |Adds a text element to a client-side page.|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Add-PnPClientSideWebPart |Adds a Client-Side Web Part to a client-side page|SharePoint Online, SharePoint 2019 + + +### Content Types +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Add-PnPContentType |Adds a new content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPContentType |Retrieves a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPContentType |Removes a content type from a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPContentTypeFromList |Removes a content type from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPContentTypePublishingHubUrl |Returns the url to Content Type Publishing Hub|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPContentTypeToList |Adds a new content type to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPDefaultContentTypeToList |Sets the default content type for a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPFieldFromContentType |Removes a site column from a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPFieldToContentType |Adds an existing site column to a content type|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Diagnostic utilities +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Measure-PnPList |Returns statistics on the list object. This may fail on lists larger than the list view threshold|SharePoint Online, SharePoint 2016, SharePoint 2019 +@SharePointPnPPowerShell.Measure-PnPResponseTime |Gets statistics on response time for the specified endpoint by sending probe requests|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Measure-PnPWeb |Returns statistics on the web object|SharePoint Online, SharePoint 2016, SharePoint 2019 + + +### Document Sets +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Remove-PnPContentTypeFromDocumentSet |Removes a content type from a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPContentTypeToDocumentSet |Adds a content type to a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPDocumentSet |Creates a new document set in a library.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPDocumentSetField |Sets a site column from the available content types to a document set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPDocumentSetTemplate |Retrieves a document set template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Event Receivers +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Add-PnPEventReceiver |Adds a new remote event receiver|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPEventReceiver |Return registered eventreceivers|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPEventReceiver |Remove an eventreceiver|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Features +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.New-PnPExtensibilityHandlerObject |Creates an ExtensibilityHandler Object, to be used by the Get-PnPProvisioningTemplate cmdlet|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Disable-PnPFeature |Disables a feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Enable-PnPFeature |Enables a feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPFeature |Returns all activated or a specific activated feature|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Fields +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Add-PnPField |Add a field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPField |Returns a field from a list or site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPField |Removes a field from a list or a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPField |Changes one or more properties of a field in a specific list or for the whole web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPFieldFromXml |Adds a field to a list or as a site column based upon a CAML/XML field definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPTaxonomyField |Add a taxonomy field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPView |Change view properties|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Files and Folders +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Add-PnPFile |Uploads a file to Web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Copy-PnPFile |Copies a file or folder to a different location. This location can be within the same document library, same site, same site collection or even to another site collection on the same tenant. Currently there is a 200MB file size limit for the file or folder to be copied.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Find-PnPFile |Finds a file in the virtual file system of the web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPFile |Downloads a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Move-PnPFile |Moves a file or folder to a different location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPFile |Removes a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Rename-PnPFile |Renames a file in its current location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPFileCheckedIn |Checks in a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPFileCheckedOut |Checks out a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPFileVersion |Retrieves all versions of a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPFileVersion |Removes all or a specific file version.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Reset-PnPFileVersion |Resets a file to its previous version|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Restore-PnPFileVersion |Restores a specific file version.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPFolder |Creates a folder within a parent folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPFolder |Return a folder object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Move-PnPFolder |Move a folder to another location in the current web. If you want to move a folder to a different site collection, use the Move-PnPFile cmdlet instead, which also supports moving folders and also accross site collections.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPFolder |Deletes a folder within a parent folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Rename-PnPFolder |Renames a folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Resolve-PnPFolder |Returns a folder from a given site relative path, and will create it if it does not exist.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPFolderItem |List content in folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Copy-PnPItemProxy |Proxy cmdlet for using Copy-Item between SharePoint provider and FileSystem provider|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Move-PnPItemProxy |Proxy cmdlet for using Move-Item between SharePoint provider and FileSystem provider|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Information Management +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Get-PnPLabel |Gets the Office 365 retention label/tag of the specified list or library (if applicable)|SharePoint Online +@SharePointPnPPowerShell.Reset-PnPLabel |Resets a retention label on the specified list or library to None|SharePoint Online +@SharePointPnPPowerShell.Set-PnPLabel |Sets a retention label on the specified list or library. Use Reset-PnPLabel to remove the label again.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPListInformationRightsManagement |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPListInformationRightsManagement |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteClosure |Get the site closure status of the site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPSiteClosure |Opens or closes a site which has a site policy applied|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPSitePolicy |Sets a site policy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPSitePolicy |Retrieves all or a specific site policy|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Lists +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Clear-PnPDefaultColumnValues |Clear default column values for a document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPDefaultColumnValues |Gets the default column values for all folders in document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPDefaultColumnValues |Sets default column values for a document library|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPFolderPermission |Sets folder permissions. Use Get-PnPRoleDefinition to retrieve all available roles you can add or remove using this cmdlet.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPList |Returns lists from SharePoint|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPList |Creates a new list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPList |Deletes a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPList |Updates list settings|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPListItem |Adds an item to the list and sets the creation time to the current date and time. The author is set to the current authenticated user executing the cmdlet. In order to set the author to a different user, please refer to Set-PnPListItem.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPListItem |Retrieves list items|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPListItem |Deletes an item from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPListItem |Updates a list item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPListItemPermission |Sets list item permissions. Use Get-PnPRoleDefinition to retrieve all available roles you can add or remove using this cmdlet.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Move-PnPListItemToRecycleBin |Moves an item from a list to the Recycle Bin|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPListPermission |Sets list permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Request-PnPReIndexList |Marks the list for full indexing during the next incremental crawl|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPView |Adds a view to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPView |Returns one or all views from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPView |Deletes a view from a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Management API +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Get-PnPManagementApiAccessToken |Gets an access token for the Office 365 Management API|SharePoint Online +@SharePointPnPPowerShell.Get-PnPOffice365CurrentServiceStatus |Gets current service status of the Office 365 Services from the Office 365 Management API|SharePoint Online +@SharePointPnPPowerShell.Get-PnPOffice365HistoricalServiceStatus |Gets the historical service status of the Office 365 Services of the last 7 days from the Office 365 Management API|SharePoint Online +@SharePointPnPPowerShell.Get-PnPOffice365ServiceMessage |Gets the service messages regarding services in Office 365 from the Office 365 Management API|SharePoint Online +@SharePointPnPPowerShell.Get-PnPOffice365Services |Gets the services available in Office 365 from the Office 365 Management API|SharePoint Online +@SharePointPnPPowerShell.Get-PnPOfficeManagementApiAccessToken |Gets an access token for the Microsoft Office 365 Management API from the current connection|SharePoint Online +@SharePointPnPPowerShell.Get-PnPUnifiedAuditLog |Gets unified audit logs from the Office 365 Management API. Requires the Azure Active Directory application permission 'ActivityFeed.Read'.|SharePoint Online + + +### Microsoft Graph +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Get-PnPAADUser |Retrieves users from Azure Active Directory|SharePoint Online +@SharePointPnPPowerShell.Get-PnPAccessToken |Returns the current OAuth Access token|SharePoint Online +@SharePointPnPPowerShell.Get-PnPDeletedMicrosoft365Group |Gets one deleted Microsoft 365 Group or a list of deleted Microsoft 365 Groups|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPDeletedMicrosoft365Group |Permanently removes one deleted Microsoft 365 Group|SharePoint Online +@SharePointPnPPowerShell.Restore-PnPDeletedMicrosoft365Group |Restores one deleted Microsoft 365 Group|SharePoint Online +@SharePointPnPPowerShell.Get-PnPGraphSubscription |Gets subscriptions from Microsoft Graph. Requires the Azure Active Directory application permission 'Subscription.Read.All'.|SharePoint Online +@SharePointPnPPowerShell.New-PnPGraphSubscription |Creates a new Microsof Graph Subscription which allows your webhook API to be called when a change occurs in Microsoft Graph|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPGraphSubscription |Removes an existing Microsoft Graph subscription. Required Azure Active Directory application permission depends on the resource the subscription exists on, see https://docs.microsoft.com/graph/api/subscription-delete#permissions.|SharePoint Online +@SharePointPnPPowerShell.Set-PnPGraphSubscription |Updates an existing Microsoft Graph subscription. Required Azure Active Directory application permission depends on the resource the subscription exists on, see https://docs.microsoft.com/graph/api/subscription-delete#permissions.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPMicrosoft365Group |Gets one Microsoft 365 Group or a list of Microsoft 365 Groups|SharePoint Online +@SharePointPnPPowerShell.New-PnPMicrosoft365Group |Creates a new Microsoft 365 Group|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPMicrosoft365Group |Removes one Microsoft 365 Group|SharePoint Online +@SharePointPnPPowerShell.Set-PnPMicrosoft365Group |Sets Microsoft 365 Group properties|SharePoint Online +@SharePointPnPPowerShell.Reset-PnPMicrosoft365GroupExpiration |Renews the Microsoft 365 Group by extending its expiration with the number of days defined in the group expiration policy set on the Azure Active Directory|SharePoint Online +@SharePointPnPPowerShell.Add-PnPMicrosoft365GroupMember |Adds members to a particular Microsoft 365 Group|SharePoint Online +@SharePointPnPPowerShell.Clear-PnPMicrosoft365GroupMember |Removes all current members from a particular Microsoft 365 Group|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPMicrosoft365GroupMember |Removes members from a particular Microsoft 365 Group|SharePoint Online +@SharePointPnPPowerShell.Get-PnPMicrosoft365GroupMembers |Gets members of a particular Microsoft 365 Group (aka Unified Group). Requires the Azure Active Directory application permissions 'Group.Read.All' and 'User.Read.All'.|SharePoint Online +@SharePointPnPPowerShell.Clear-PnPMicrosoft365GroupOwner |Removes all current owners from a particular Microsoft 365 Group (aka Unified Group)|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPMicrosoft365GroupOwner |Removes owners from a particular Microsoft 365 Group|SharePoint Online +@SharePointPnPPowerShell.Get-PnPMicrosoft365GroupOwners |Gets owners of a particular Microsoft 365 Group|SharePoint Online +@SharePointPnPPowerShell.Add-PnPSiteClassification |Adds one ore more site classification values to the list of possible values|SharePoint Online +@SharePointPnPPowerShell.Disable-PnPSiteClassification |Disables Site Classifications for the tenant|SharePoint Online +@SharePointPnPPowerShell.Enable-PnPSiteClassification |Enables Site Classifications for the tenant|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteClassification |Returns the defined Site Classifications for the tenant|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPSiteClassification |Removes one or more existing site classification values from the list of available values|SharePoint Online +@SharePointPnPPowerShell.Update-PnPSiteClassification |Updates Site Classifications for the tenant|SharePoint Online + + +### Microsoft Teams +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Get-PnPTeamsApp |Gets one Microsoft Teams App or a list of all apps.|SharePoint Online +@SharePointPnPPowerShell.New-PnPTeamsApp |Adds an app to the Teams App Catalog.|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPTeamsApp |Removes an app from the Teams AppCatalog.|SharePoint Online +@SharePointPnPPowerShell.Update-PnPTeamsApp |Updates an existing app in the Teams App Catalog.|SharePoint Online +@SharePointPnPPowerShell.Add-PnPTeamsChannel |Adds a channel to an existing Microsoft Teams instance.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTeamsChannel |Gets the channels for a specified Team.|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPTeamsChannel |Removes a channel from a Microsoft Teams instance.|SharePoint Online +@SharePointPnPPowerShell.Set-PnPTeamsChannel |Updates an existing Teams Channel|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTeamsChannelMessage |Sends a message to a Microsoft Teams Channel.|SharePoint Online +@SharePointPnPPowerShell.Submit-PnPTeamsChannelMessage |Sends a message to a Microsoft Teams Channel.|SharePoint Online +@SharePointPnPPowerShell.Add-PnPTeamsTab |Adds a tab to an existing Channel|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTeamsTab |Gets one or all tabs in a channel.|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPTeamsTab |Removes a Microsoft Teams tab in a channel.|SharePoint Online +@SharePointPnPPowerShell.Set-PnPTeamsTab |Updates Teams Tab settings|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTeamsTeam |Gets one Microsoft Teams Team or a list of Teams.|SharePoint Online +@SharePointPnPPowerShell.New-PnPTeamsTeam |Creates a new Team in Microsoft Teams. The cmdlet will create a Microsoft 365 group and then add a team to the group.|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPTeamsTeam |Removes a Microsoft Teams Team instance|SharePoint Online +@SharePointPnPPowerShell.Set-PnPTeamsTeam |Updates an existing Team.|SharePoint Online +@SharePointPnPPowerShell.Set-PnPTeamsTeamArchivedState |Sets the archived state of a team.|SharePoint Online +@SharePointPnPPowerShell.Set-PnPTeamsTeamPicture |Sets the picture of an existing team.|SharePoint Online +@SharePointPnPPowerShell.Add-PnPTeamsUser |Adds a channel to an existing Microsoft Teams instance.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTeamsUser |Returns owners, members or guests from a team.|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPTeamsUser |Removes users from a team.|SharePoint Online + + +### Provisioning +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Export-PnPClientSidePage |Exports a Client Side Page to a PnP Provisioning Template|SharePoint Online +@SharePointPnPPowerShell.Add-PnPDataRowsToProvisioningTemplate |Adds datarows to a list inside a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPFileFromProvisioningTemplate |Removes a file from a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPFileToProvisioningTemplate |Adds a file to a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Convert-PnPFolderToProvisioningTemplate |Creates a pnp package file of an existing template xml, and includes all files in the current folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPListFoldersToProvisioningTemplate |Adds folders to a list in a PnP Provisioning Template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Export-PnPListToProvisioningTemplate |Exports one or more lists to provisioning template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPProvisioningTemplate |Adds a PnP Provisioning Template object to a tenant template|SharePoint Online +@SharePointPnPPowerShell.Apply-PnPProvisioningTemplate |Applies a site template to a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Convert-PnPProvisioningTemplate |Converts a provisioning template to an other schema version|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPProvisioningTemplate |Generates a provisioning site template from a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPProvisioningTemplate |Creates a new provisioning template object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Read-PnPProvisioningTemplate |Loads/Reads a PnP file from the file system or a string|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Save-PnPProvisioningTemplate |Saves a PnP site template to the file system|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPProvisioningTemplateFromFolder |Generates a provisioning template from a given folder, including only files that are present in that folder|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPProvisioningTemplateMetadata |Sets metadata of a provisioning template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPTenantSequence |Adds a tenant sequence object to a tenant template|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantSequence |Returns one ore more provisioning sequence object(s) from a tenant template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPTenantSequence |Creates a new tenant sequence object|SharePoint Online +@SharePointPnPPowerShell.New-PnPTenantSequenceCommunicationSite |Creates a communication site object|SharePoint Online +@SharePointPnPPowerShell.Add-PnPTenantSequenceSite |Adds a existing tenant sequence site object to a tenant template|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantSequenceSite |Returns one ore more sites from a tenant template|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPTenantSequenceSubSite |Adds a tenant sequence sub site object to a tenant sequence site object|SharePoint Online +@SharePointPnPPowerShell.New-PnPTenantSequenceTeamNoGroupSite |Creates a new team site without a Microsoft 365 group in-memory object|SharePoint Online +@SharePointPnPPowerShell.New-PnPTenantSequenceTeamNoGroupSubSite |Creates a team site subsite with no Microsoft 365 group object|SharePoint Online +@SharePointPnPPowerShell.New-PnPTenantSequenceTeamSite |Creates a team site object|SharePoint Online +@SharePointPnPPowerShell.Apply-PnPTenantTemplate |Applies a tenant template to the current tenant. You must have the Office 365 Global Admin role to run this cmdlet successfully.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantTemplate |Generates a provisioning tenant template from a site. If the site is a hubsite any connected site will be included.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPTenantTemplate |Creates a new tenant template object|SharePoint Online +@SharePointPnPPowerShell.Read-PnPTenantTemplate |Loads/Reads a PnP tenant template from the file system and returns an in-memory instance of this template.|SharePoint Online +@SharePointPnPPowerShell.Save-PnPTenantTemplate |Saves a PnP provisioning hierarchy to the file system|SharePoint Online +@SharePointPnPPowerShell.Test-PnPTenantTemplate |Tests a tenant template for invalid references|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Publishing +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Set-PnPAvailablePageLayouts |Sets the available page layouts for the current site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPDefaultPageLayout |Sets a specific page layout to be the default page layout for a publishing site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPHtmlPublishingPageLayout |Adds a HTML based publishing page layout|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPMasterPage |Adds a Masterpage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPPublishingImageRendition |Adds an Image Rendition if the Name of the Image Rendition does not already exist. This prevents creating two Image Renditions that share the same name.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPPublishingImageRendition |Returns all image renditions or if Identity is specified a specific one|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPPublishingImageRendition |Removes an existing image rendition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPPublishingPage |Adds a publishing page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPPublishingPageLayout |Adds a publishing page layout|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPWikiPage |Adds a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPWikiPage |Removes a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPWikiPageContent |Gets the contents/source of a wiki page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPWikiPageContent |Sets the contents of a wikipage|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Records Management +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Get-PnPInPlaceRecordsManagement |Returns if the place records management feature is enabled.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPInPlaceRecordsManagement |Activates or deactivates in the place records management feature.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Disable-PnPInPlaceRecordsManagementForSite |Disables in place records management for a site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Enable-PnPInPlaceRecordsManagementForSite |Enables in place records management for a site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Clear-PnPListItemAsRecord |Undeclares a list item as a record|SharePoint Online +@SharePointPnPPowerShell.Set-PnPListItemAsRecord |Declares a list item as a record, for more information, see https://docs.microsoft.com/sharepoint/governance/records-management-in-sharepoint-server|SharePoint Online +@SharePointPnPPowerShell.Test-PnPListItemIsRecord |Checks if a list item is a record|SharePoint Online +@SharePointPnPPowerShell.Get-PnPListRecordDeclaration |Returns the manual record declaration settings for a list|SharePoint Online +@SharePointPnPPowerShell.Set-PnPListRecordDeclaration |The RecordDeclaration parameter supports 4 values: AlwaysAllowManualDeclaration NeverAllowManualDeclaration UseSiteCollectionDefaults |SharePoint Online + + +### Search +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Get-PnPSearchConfiguration |Returns the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPSearchConfiguration |Remove the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPSearchConfiguration |Sets the search configuration|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPSearchCrawlLog |Returns entries from the SharePoint search crawl log. Make sure you are granted access to the crawl log via the SharePoint search admin center at https://-admin.sharepoint.com/_layouts/15/searchadmin/crawllogreadpermission.aspx in order to run this cmdlet.|SharePoint Online +@SharePointPnPPowerShell.Submit-PnPSearchQuery |Executes an arbitrary search query against the SharePoint search index|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPSearchSettings |Retrieves search settings for a site|SharePoint Online +@SharePointPnPPowerShell.Set-PnPSearchSettings |Sets search settings for a site|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteSearchQueryResults |Executes a search query to retrieve indexed site collections|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### SharePoint Recycle Bin +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Clear-PnPRecycleBinItem |Permanently deletes all or a specific recycle bin item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPRecycleBinItem |Returns the items in the recycle bin from the context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Move-PnPRecycleBinItem |Moves all items or a specific item in the first stage recycle bin of the current site collection to the second stage recycle bin|SharePoint Online +@SharePointPnPPowerShell.Restore-PnPRecycleBinItem |Restores the provided recycle bin item to its original location|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantRecycleBinItem |Returns all modern and classic site collections in the tenant scoped recycle bin|SharePoint Online + + +### SharePoint WebHooks +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Add-PnPWebhookSubscription |Adds a new Webhook subscription|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPWebhookSubscription |Removes a Webhook subscription from the resource|SharePoint Online +@SharePointPnPPowerShell.Set-PnPWebhookSubscription |Updates a Webhook subscription|SharePoint Online +@SharePointPnPPowerShell.Get-PnPWebhookSubscriptions |Gets all the Webhook subscriptions of the resource|SharePoint Online + + +### Sites +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Set-PnPAppSideLoading |Enables the App SideLoading Feature on a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPAuditing |Get the Auditing setting of a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPAuditing |Set Auditing setting for a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Enable-PnPCommSite |Enables the modern communication site experience on a classic team site.|SharePoint Online +@SharePointPnPPowerShell.Test-PnPOffice365GroupAliasIsUsed |Tests if a given alias is already used used|SharePoint Online +@SharePointPnPPowerShell.Add-PnPRoleDefinition |Adds a Role Defintion (Permission Level) to the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPRoleDefinition |Retrieves a Role Definitions of a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPRoleDefinition |Remove a Role Definition from a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Disable-PnPSharingForNonOwnersOfSite |Configures the site to only allow sharing of the site and items in the site by owners|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSharingForNonOwnersOfSite |Returns $false if sharing of the site and items in the site is restricted only to owners or $true if members and owners are allowed to share|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSite |Returns the current site collection from the context.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPSite |Sets Site Collection properties.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPSiteCollectionAdmin |Adds one or more users as site collection administrators to the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteCollectionAdmin |Returns the current site collection administrators of the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPSiteCollectionAdmin |Removes one or more users as site collection administrators from the site collection in the current context|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Install-PnPSolution |Installs a sandboxed solution to a site collection. WARNING! This method can delete your composed look gallery due to the method used to activate the solution. We recommend you to only to use this cmdlet if you are okay with that.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Uninstall-PnPSolution |Uninstalls a sandboxed solution from a site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPTeamsTeam |Adds a Teams team to an existing, group connected, site collection|SharePoint Online + + +### Taxonomy +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Get-PnPSiteCollectionTermStore |Returns the site collection term store|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Export-PnPTaxonomy |Exports a taxonomy to either the output or to a file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Import-PnPTaxonomy |Imports a taxonomy from either a string array or a file|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPTaxonomyFieldValue |Sets a taxonomy term value in a listitem field|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPTaxonomyItem |Returns a taxonomy item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPTaxonomyItem |Removes a taxonomy item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPTaxonomySession |Returns a taxonomy session|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPTerm |Returns a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPTerm |Creates a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPTermGroup |Returns a taxonomy term group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPTermGroup |Creates a taxonomy term group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPTermGroup |Removes a taxonomy term group and all its containing termsets|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Import-PnPTermGroupFromXml |Imports a taxonomy TermGroup from either the input or from an XML file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Export-PnPTermGroupToXml |Exports a taxonomy TermGroup to either the output or to an XML file.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPTermLabel |Creates a localized label for a taxonomy term|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPTermSet |Returns a taxonomy term set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Import-PnPTermSet |Imports a taxonomy term set from a file in the standard format.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPTermSet |Creates a taxonomy term set|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Tenant Administration +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Register-PnPAppCatalogSite |Creates a new App Catalog Site and sets this site as the Tenant App Catalog|SharePoint Online +@SharePointPnPPowerShell.Get-PnPGraphAccessToken |Returns the current OAuth Access token for the Microsoft Graph API|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPHideDefaultThemes |Returns if the default / OOTB themes should be visible to users or not.|SharePoint Online +@SharePointPnPPowerShell.Set-PnPHideDefaultThemes |Defines if the default / OOTB themes should be visible to users or not.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPHomeSite |Returns the home site url for your tenant|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPHomeSite |Removes the currently set site as the home site|SharePoint Online +@SharePointPnPPowerShell.Set-PnPHomeSite |Sets the home site for your tenant|SharePoint Online +@SharePointPnPPowerShell.Get-PnPHubSite |Retrieve all or a specific hubsite.|SharePoint Online +@SharePointPnPPowerShell.Register-PnPHubSite |Registers a site as a hubsite|SharePoint Online +@SharePointPnPPowerShell.Set-PnPHubSite |Sets hub site properties|SharePoint Online +@SharePointPnPPowerShell.Unregister-PnPHubSite |Unregisters a site as a hubsite|SharePoint Online +@SharePointPnPPowerShell.Add-PnPHubSiteAssociation |Connects a site to a hubsite.|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPHubSiteAssociation |Disconnects a site from a hubsite.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPHubSiteChild |Retrieves all sites linked to a specific hub site|SharePoint Online +@SharePointPnPPowerShell.Grant-PnPHubSiteRights |Grant additional permissions to the permissions already in place to associate sites to Hub Sites for one or more specific users|SharePoint Online +@SharePointPnPPowerShell.Revoke-PnPHubSiteRights |Revoke permissions to the permissions already in place to associate sites to Hub Sites for one or more specific users|SharePoint Online +@SharePointPnPPowerShell.Get-PnPIsSiteAliasAvailable |Validates if a certain alias is still available to be used to create a new site collection for. If it is not, it will propose an alternative alias and URL which is still available.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPKnowledgeHubSite |Gets the Knowledge Hub Site URL for your tenant|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPKnowledgeHubSite |Removes the Knowledge Hub Site setting for your tenant|SharePoint Online +@SharePointPnPPowerShell.Set-PnPKnowledgeHubSite |Sets the Knowledge Hub Site for your tenant|SharePoint Online +@SharePointPnPPowerShell.Add-PnPMicrosoft365GroupToSite |Groupifies a classic team site by creating a Microsoft 365 group for it and connecting the site with the newly created group|SharePoint Online +@SharePointPnPPowerShell.Add-PnPOrgAssetsLibrary |Adds a given document library as a organizational asset source|SharePoint Online +@SharePointPnPPowerShell.Get-PnPOrgAssetsLibrary |Returns the list of all the configured organizational asset libraries|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPOrgAssetsLibrary |Removes a given document library as a organizational asset source|SharePoint Online +@SharePointPnPPowerShell.Add-PnPOrgNewsSite |Adds the site as an organization news source in your tenant|SharePoint Online +@SharePointPnPPowerShell.Get-PnPOrgNewsSite |Returns the list of all the configured organizational news sites.|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPOrgNewsSite |Removes a given site from the list of organizational news sites.|SharePoint Online +@SharePointPnPPowerShell.Initialize-PnPPowerShellAuthentication |Initializes a Azure AD App and optionally creates a new self-signed certificate to use with the application registration.|SharePoint Online +@SharePointPnPPowerShell.Disable-PnPPowerShellTelemetry |Disables PnP PowerShell telemetry tracking|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Enable-PnPPowerShellTelemetry |Enables PnP PowerShell telemetry tracking.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPPowerShellTelemetryEnabled |Returns true if the PnP PowerShell Telemetry has been enabled.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPSite |Creates either a communication site or a Microsoft 365 group-connected team site|SharePoint Online +@SharePointPnPPowerShell.Add-PnPSiteCollectionAppCatalog |Adds a Site Collection scoped App Catalog to a site|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPSiteCollectionAppCatalog |Removes a Site Collection scoped App Catalog from a site|SharePoint Online +@SharePointPnPPowerShell.Add-PnPSiteDesign |Creates a new Site Design on the current tenant.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteDesign |Retrieve Site Designs that have been registered on the current tenant.|SharePoint Online +@SharePointPnPPowerShell.Invoke-PnPSiteDesign |Apply a Site Design to an existing site. * Requires Tenant Administration Rights *|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPSiteDesign |Removes a Site Design|SharePoint Online +@SharePointPnPPowerShell.Set-PnPSiteDesign |Updates a Site Design on the current tenant.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteDesignRights |Returns the principals with design rights on a specific Site Design|SharePoint Online +@SharePointPnPPowerShell.Grant-PnPSiteDesignRights |Grants the specified principals rights to use the site design.|SharePoint Online +@SharePointPnPPowerShell.Revoke-PnPSiteDesignRights |Revokes the specified principals rights to use the site design.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteDesignRun |Retrieves a list of site designs applied to a specified site collection. If the WebUrl parameter is not specified we show the list of designs applied to the current site. The returned output includes the ID of the scheduled job, the web and site IDs, and the site design ID, version, and title.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteDesignRunStatus |Retrieves and displays a list of all site script actions executed for a specified site design applied to a site.|SharePoint Online +@SharePointPnPPowerShell.Add-PnPSiteDesignTask |This command is used to apply a published site design to a specified site collection target. It schedules the operation, allowing for the application of larger site scripts (Invoke-PnPSiteDesign is limited to 30 actions and subactions). This command is intended to replace Invoke-PnPSiteDesign and is useful when you need to apply a large number of actions or multiple site scripts.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteDesignTask |Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design task and the URL for the site where the site design is scheduled to be applied.|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPSiteDesignTask |Removes a Site Design Task. If the execution of the associated site script has already started the execution will not be terminated.|SharePoint Online +@SharePointPnPPowerShell.Add-PnPSiteScript |Creates a new Site Script on the current tenant.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteScript |Retrieve Site Scripts that have been registered on the current tenant.|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPSiteScript |Removes a Site Script|SharePoint Online +@SharePointPnPPowerShell.Set-PnPSiteScript |Updates an existing Site Script on the current tenant.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteScriptFromList |Generates a Site Script from an existing list|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSiteScriptFromWeb |Generates a Site Script from an existing site|SharePoint Online +@SharePointPnPPowerShell.Get-PnPStorageEntity |Retrieve Storage Entities / Farm Properties from either the Tenant App Catalog or from the current site if it has a site scope app catalog.|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPStorageEntity |Remove Storage Entities / Farm Properties from either the tenant scoped app catalog or the current site collection if the site has a site collection scoped app catalog|SharePoint Online +@SharePointPnPPowerShell.Set-PnPStorageEntity |Set Storage Entities / Farm Properties in either the tenant scoped app catalog or the site collection app catalog.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenant |Returns organization-level site collection properties|SharePoint Online +@SharePointPnPPowerShell.Set-PnPTenant |Sets organization-level site collection properties|SharePoint Online +@SharePointPnPPowerShell.Clear-PnPTenantAppCatalogUrl |Removes the url of the tenant scoped app catalog. It will not delete the site collection itself.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantAppCatalogUrl |Retrieves the url of the tenant scoped app catalog|SharePoint Online +@SharePointPnPPowerShell.Set-PnPTenantAppCatalogUrl |Sets the url of the tenant scoped app catalog|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantCdnEnabled |Retrieves if the Office 365 Content Delivery Network has been enabled.|SharePoint Online +@SharePointPnPPowerShell.Set-PnPTenantCdnEnabled |Enables or disabled the public or private Office 365 Content Delivery Network (CDN).|SharePoint Online +@SharePointPnPPowerShell.Add-PnPTenantCdnOrigin |Adds a new origin to the public or private content delivery network (CDN).|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantCdnOrigin |Returns the current registered origins from the public or private content delivery network (CDN).|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPTenantCdnOrigin |Removes an origin from the Public or Private content delivery network (CDN).|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantCdnPolicies |Returns the CDN Policies for the specified CDN (Public | Private).|SharePoint Online +@SharePointPnPPowerShell.Set-PnPTenantCdnPolicy |Sets the CDN Policies for the specified CDN (Public | Private).|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantId |Returns the Tenant ID|SharePoint Online +@SharePointPnPPowerShell.Clear-PnPTenantRecycleBinItem |Permanently deletes a site collection from the tenant scoped recycle bin|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Restore-PnPTenantRecycleBinItem |Restores a site collection from the tenant scoped recycle bin|SharePoint Online +@SharePointPnPPowerShell.Disable-PnPTenantServicePrincipal |Enables the current tenant's "SharePoint Online Client" service principal.|SharePoint Online +@SharePointPnPPowerShell.Enable-PnPTenantServicePrincipal |Enables the current tenant's "SharePoint Online Client" service principal.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantServicePrincipal |Returns the current tenant's "SharePoint Online Client" service principal.|SharePoint Online +@SharePointPnPPowerShell.Revoke-PnPTenantServicePrincipalPermission |Revokes a permission that was previously granted to the "SharePoint Online Client" service principal.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantServicePrincipalPermissionGrants |Gets the collection of permission grants for the "SharePoint Online Client" service principal|SharePoint Online +@SharePointPnPPowerShell.Approve-PnPTenantServicePrincipalPermissionRequest |Approves a permission request for the current tenant's "SharePoint Online Client" service principal|SharePoint Online +@SharePointPnPPowerShell.Deny-PnPTenantServicePrincipalPermissionRequest |Denies a permission request for the current tenant's "SharePoint Online Client" service principal|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantServicePrincipalPermissionRequests |Gets the collection of permission requests for the "SharePoint Online Client" service principal|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantSite |Retrieve site information.|SharePoint Online, SharePoint 2016, SharePoint 2019 +@SharePointPnPPowerShell.New-PnPTenantSite |Creates a new (classic) site collection for the current tenant|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPTenantSite |Removes a site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPTenantSite |Updates settings of a site collection|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantSyncClientRestriction |Returns organization-level OneDrive synchronization restriction settings|SharePoint Online +@SharePointPnPPowerShell.Set-PnPTenantSyncClientRestriction |Sets organization-level sync client restriction properties|SharePoint Online +@SharePointPnPPowerShell.Add-PnPTenantTheme |Adds or updates a theme to the tenant.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTenantTheme |Returns all or a specific theme|SharePoint Online +@SharePointPnPPowerShell.Remove-PnPTenantTheme |Removes a theme|SharePoint Online +@SharePointPnPPowerShell.Get-PnPTimeZoneId |Returns a time zone ID|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPWebTemplates |Returns the available classic web templates|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### User and group management +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Add-PnPAlert |Adds an alert for a user to a list|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Get-PnPAlert |Returns registered alerts for a user.|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Remove-PnPAlert |Removes an alert for a user|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Get-PnPGroup |Returns a specific SharePoint group or all SharePoint groups in site.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPGroup |Adds group to the Site Groups List and returns a group object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPGroup |Removes a group from a web.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPGroup |Updates a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPGroupMembers |Retrieves all members of a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPGroupPermissions |Returns the permissions for a specific SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPGroupPermissions |Adds and/or removes permissions of a specific SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPUser |Returns site users of current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPUser |Adds a user to the built-in Site User Info List and returns a user object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPUser |Removes a specific user from the site collection User Information List|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPUserFromGroup |Removes a user from a group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPUserToGroup |Adds a user to a SharePoint group|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### User Profiles +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.New-PnPPersonalSite |Office365 only: Creates a personal / OneDrive For Business site|SharePoint Online +@SharePointPnPPowerShell.New-PnPUPABulkImportJob |Submit up a new user profile bulk import job.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPUPABulkImportStatus |Get user profile bulk import status.|SharePoint Online +@SharePointPnPPowerShell.Get-PnPUserOneDriveQuota |Retrieves the current quota set on the OneDrive for Business site for a specific user|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPUserOneDriveQuota |Sets the quota on the OneDrive for Business site for a specific user|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Reset-PnPUserOneDriveQuotaToDefault |Resets the current quota set on the OneDrive for Business site for a specific user to the tenant default|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPUserProfileProperty |You must connect to the tenant admin website (https://:-admin.sharepoint.com) with Connect-PnPOnline in order to use this cmdlet. |SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPUserProfileProperty |Office365 only: Uses the tenant API to retrieve site information. You must connect to the tenant admin website (https://:-admin.sharepoint.com) with Connect-PnPOnline in order to use this command.|SharePoint Online + + +### Utilities +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Send-PnPMail |Sends an email using the Office 365 SMTP Service or SharePoint, depending on the parameters specified. See detailed help for more information.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Web Parts +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Get-PnPClientSideComponent |Retrieve one or more Client-Side components from a site page|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Remove-PnPClientSideComponent |Removes a Client-Side component from a page|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Set-PnPClientSideText |Set Client-Side Text Component properties|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Set-PnPClientSideWebPart |Set Client-Side Web Part properties|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Get-PnPWebPart |Returns a web part definition object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPWebPart |Removes a web part from a page|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPWebPartProperty |Returns a web part property|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPWebPartProperty |Sets a web part property|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPWebPartToWebPartPage |Adds a web part to a web part page in a specified zone|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPWebPartToWikiPage |Adds a web part to a wiki page in a specified table row and column|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPWebPartXml |Returns the web part XML of a web part registered on a site|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Webs +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Get-PnPAvailableLanguage |Returns the available languages on the current web|SharePoint Online, SharePoint 2019 +@SharePointPnPPowerShell.Set-PnPIndexedProperties |Marks values of the propertybag to be indexed by search. Notice that this will overwrite the existing flags, i.e. only the properties you define with the cmdlet will be indexed.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPIndexedProperty |Marks the value of the propertybag key specified to be indexed by search.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPIndexedProperty |Removes a key from propertybag to be indexed by search. The key and it's value remain in the propertybag, however it will not be indexed anymore.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPIndexedPropertyKeys |Returns the keys of the property bag values that have been marked for indexing by search|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPPropertyBag |Returns the property bag values.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPPropertyBagValue |Removes a value from the property bag|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPPropertyBagValue |Sets a property bag value|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Request-PnPReIndexWeb |Marks the web for full indexing during the next incremental crawl|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPRequestAccessEmails |Returns the request access e-mail addresses|SharePoint Online +@SharePointPnPPowerShell.Set-PnPRequestAccessEmails |Sets Request Access Email on a web|SharePoint Online +@SharePointPnPPowerShell.Get-PnPSubWebs |Returns the subwebs of the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPWeb |Returns the current web object|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.New-PnPWeb |Creates a new subweb under the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPWeb |Removes a subweb in the current web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPWeb |Sets properties on a web|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Invoke-PnPWebAction |Executes operations on web, lists and list items.|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Set-PnPWebPermission |Set permissions|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + + +### Workflows +Cmdlet|Description|Platform +:-----|:----------|:------- +@SharePointPnPPowerShell.Add-PnPWorkflowDefinition |Adds a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPWorkflowDefinition |Returns a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPWorkflowDefinition |Removes a workflow definition|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPWorkflowInstance |Gets SharePoint 2010/2013 workflow instances|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Resume-PnPWorkflowInstance |Resume a workflow|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Start-PnPWorkflowInstance |Starts a SharePoint 2010/2013 workflow instance on a list item|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Stop-PnPWorkflowInstance |Stops a workflow instance|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Add-PnPWorkflowSubscription |Adds a workflow subscription to a list|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Get-PnPWorkflowSubscription |Return a workflow subscription|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online +@SharePointPnPPowerShell.Remove-PnPWorkflowSubscription |Removes a SharePoint 2010/2013 workflow subscription|SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019, SharePoint Online + ## Additional resources -- [SharePoint PnP PowerShell on GitHub](https://github.com/pnp/PnP-PowerShell) +- [SharePoint PnP PowerShell on GitHub](https://github.com/pnp/PnP-PowerShell) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md index e0031c8cea..89f87c3e35 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md @@ -47,8 +47,12 @@ Get the cross users that have been moved out the current SPO site ## PARAMETERS ### -Direction +Used to specify move direction. -PARAMVALUE: String +Possible values + +- MoveIn +- MoveOut ```yaml Type: String diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md index 39ee6d7c53..c4b584b682 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md @@ -56,7 +56,10 @@ Returns a single user from SharePoint Online in a multi-geo tenant and validates ### -ValidDataLocation -PARAMVALUE: $true | $false +Use this parameter to validate the location of the data. The acceptable values for this parameter are: + +- $False +- $True ```yaml Type: Boolean diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataEncryptionPolicy.md index f09d6a9629..b6afee8a68 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataEncryptionPolicy.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataEncryptionPolicy.md @@ -19,7 +19,7 @@ ms.reviewer: ## SYNTAX ```powershell -Get-SPODataEncryptionPolicy [-Identity] [] +Get-SPODataEncryptionPolicy ``` ## DESCRIPTION @@ -33,7 +33,7 @@ For more information, see [Controlling your data in Office 365 using Customer Ke ### Example 1 ```powershell -Get-SPODataEncryptionPolicy -Identity https://contoso-admin.sharepoint.com +Get-SPODataEncryptionPolicy ``` The output from this cmdlet includes: @@ -54,22 +54,6 @@ The output from this cmdlet includes: ## PARAMETERS -### -Identity - -Specifies the URL of the admin site collection. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCrossCompatibilityStatus.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCrossCompatibilityStatus.md index 7f73c785e0..cb86034781 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCrossCompatibilityStatus.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCrossCompatibilityStatus.md @@ -36,10 +36,21 @@ Get-SPOGeoMoveCrossCompatibilityStatus Get the compatibility status for all locations. +## PARAMETERS + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + ## RELATED LINKS [Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md index 3598bb28a3..cc9fae668f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md @@ -50,7 +50,7 @@ Get the storage size quota of the current location. ### -AllLocations -PARAMVALUE: SwitchParameter +Use this parameter to retrieve the storage size quota of all locations. ```yaml Type: SwitchParameter diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md index dab89d4f5a..18f6a5306d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md @@ -138,7 +138,7 @@ Accept wildcard characters: False ### -EncryptionParameters -PARAMVALUE: EncryptionParameters +An EncryptionParameters object. See New-SPOMigrationEncryptionParameters https://docs.microsoft.com/powershell/module/sharepoint-online/new-spomigrationencryptionparameters for more information. ```yaml Type: EncryptionParameters diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md index f8845f3061..5f716b6468 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md @@ -57,7 +57,11 @@ You need to be a SharePoint Online administrator or Global Administrator and be For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). > [!NOTE] -> If Site Collection Storage Management is enabled for the tenant, you will not be able to set quota and will have a generic error returned. To workaround this issue, set the site collection storage management to "manual" temporarily, set your quotas and then set the site collection storage management setting back to its original setting. +> If Site Collection Storage Management is enabled for the tenant, you will not be able to set quota and will have a generic error returned. To workaround this issue, set the site collection storage management to "manual" temporarily, set your quotas and then set the site collection storage management setting back to its original setting. + +> [!NOTE] +> If the Limit parameter is provided then the following site collection properties will not be populated and may contain a default value: +> AllowDownloadingNonWebViewableFiles, AllowEditing, AllowSelfServiceUpgrade, AnonymousLinkExpirationInDays, ConditionalAccessPolicy, DefaultLinkPermission, DefaultLinkToExistingAccess, DefaultSharingLinkType, DenyAddAndCustomizePages, DisableCompanyWideSharingLinks, ExternalUserExpirationInDays, LimitedAccessFileType, OverrideTenantAnonymousLinkExpirationPolicy, OverrideTenantExternalUserExpirationPolicy, PWAEnabled, SandboxedCodeActivationCapability, SensitivityLabel, SharingAllowedDomainList, SharingBlockedDomainList, SharingCapability, SharingDomainRestrictionMode. ## EXAMPLES @@ -125,23 +129,27 @@ Use this parameter to get additional property information on a site collection. The following properties are returned: ---ResourceUsageCurrent +- ResourceUsageCurrent + +- ResourceUsageAverage + +- StorageUsageCurrent ---ResourceUsageAverage +- LockIssue ---StorageUsageCurrent +- WebsCount ---LockIssue +- CompatibilityLevel ---WebsCount +- AllowSelfServiceUpgrade ---CompatibilityLevel +- SiteDefinedSharingCapability ---AllowSelfServiceUpgrade +Returns the stored value of the site policy. ---SiteDefinedSharingCapability-returns the stored value of the site policy. +- SharingCapability ---SharingCapability --returns the effective access level (the site policy and the tenant policy combined. +Returns the effective access level, which is the site policy and the tenant policy combined. ```yaml Type: SwitchParameter @@ -234,7 +242,7 @@ Accept wildcard characters: False ### -Limit -Specifies the maximum number of site collections to return. It can be any number. To retrieve all site collections, use ALL. The default value is 200. +Specifies the maximum number of site collections to return. It can be any number. To retrieve all site collections, use ALL. The default value is 200. If this parameter is provided, then some site collection properties will not be populated and may contain a default value. ```yaml Type: String diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md index be5ec82b4b..f07734d547 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md @@ -57,7 +57,7 @@ Accept wildcard characters: False ### -Identity -PARAMVALUE: String +Identity of the provider. ```yaml Type: String @@ -74,7 +74,7 @@ Accept wildcard characters: False ### -License -PARAMVALUE: String +License key provided by the provider. ```yaml Type: String diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md index e1662cce32..150d6dc760 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md @@ -63,10 +63,7 @@ Example 3 creates a new site collection for the current company with specified s ### -CompatibilityLevel -Specifies the version of templates to use when you are creating a new site collection. This value sets the initial CompatibilityLevel value for the site collection. The values for this parameter can be SharePoint Server. When this parameter is not specified, the CompatibilityLevel will be by default the highest possible version for the Web application. - -> [!NOTE] -> For SharePoint Online Preview, it can only be set to "14" or "15". "14" indicates SharePoint 2010 Products, "15" indicates SharePoint 2013. Other values are not valid and will cause error. +This parameter no longer has any effect and only accepts a value of '15'. ```yaml Type: Int32 @@ -134,7 +131,7 @@ Accept wildcard characters: False ### -ResourceQuota -Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint ( Note that this parameter is now obsolete and has been deprecated. +Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see [Resource Usage Limits on Sandboxed Solutions in SharePoint](https://docs.microsoft.com/previous-versions/office/developer/sharepoint-2010/gg615462(v=office.14)). Note that this parameter is now obsolete and has been deprecated. ```yaml Type: Double diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Register-SPODataEncryptionPolicy.md index 7cb8960352..a12ef2c78f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPODataEncryptionPolicy.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Register-SPODataEncryptionPolicy.md @@ -20,7 +20,7 @@ For more information, see [Controlling your data in Office 365 using Customer Ke ## SYNTAX ```powershell -Register-SPODataEncryptionPolicy [-Identity] -PrimaryKeyVaultName -PrimaryKeyName -PrimaryKeyVersion -SecondaryKeyVaultName -SecondaryKeyName -SecondaryKeyVersion [-WhatIf] [-Confirm] [] +Register-SPODataEncryptionPolicy -PrimaryKeyVaultName -PrimaryKeyName -PrimaryKeyVersion -SecondaryKeyVaultName -SecondaryKeyName -SecondaryKeyVersion [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -33,28 +33,12 @@ For more information, see [Controlling your data in Office 365 using Customer Ke ### Example 1 ```powershell -Register-SPODataEncryptionPolicy -Identity https://contoso.sharepoint.com -PrimaryKeyVaultName 'PKVaultName1' -PrimaryKeyName 'PrimaryKey1' -PrimaryKeyVersion 'f635a23bd4a44b9996ff6aadd88d42ba' -SecondaryKeyVaultName 'SKVaultName1' -SecondaryKeyName 'SecondaryKey2' -SecondaryKeyVersion '2b3e8f1d754f438dacdec1f0945f251a’ +Register-SPODataEncryptionPolicy -PrimaryKeyVaultName 'PKVaultName1' -PrimaryKeyName 'PrimaryKey1' -PrimaryKeyVersion 'f635a23bd4a44b9996ff6aadd88d42ba' -SecondaryKeyVaultName 'SKVaultName1' -SecondaryKeyName 'SecondaryKey2' -SecondaryKeyVersion '2b3e8f1d754f438dacdec1f0945f251a’ ``` This example registers the DEP used with SharePoint Online and OneDrive for Business to start using the given primary key. ## PARAMETERS -### -Identity - -Specifies the URL of the admin site collection. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -PrimaryKeyVaultName The name of the primary key vault diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md index 27d9406d0f..c0653dffb0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md @@ -80,7 +80,7 @@ Accept wildcard characters: False ### -NoWait -Continues without the status being polled. Polling the action can slow it's progress. +Continues without the status being polled. Polling the action can slow its progress. ```yaml Type: SwitchParameter diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOPersonalSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOPersonalSite.md index dd1fa3e21f..c1dda62b74 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOPersonalSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOPersonalSite.md @@ -24,10 +24,12 @@ Request-SPOPersonalSite [-NoWait] -UserEmails [] ## DESCRIPTION -The `Request-SPOPersonalSite` cmdlet requests that the users specified be enqueued so that a Personal Site be created for each. The actual Personal site is created by a Timer Job later. +The `Request-SPOPersonalSite` cmdlet requests that the users specified be enqueued so that a Personal Site be created for each. The actual Personal site is created by a Timer Job later. If the user already has a Personal Site created, the request for creation for the user will be silently ignored. -> [!NOTE] -> • You must specify a string array of user logins that contains one or more valid user email (logins) and cannot contain any empty fields. The command will stop if it encounters any empty strings in the array. A maximum of 200 users can be specified.

• The actor executing this cmdlet must be at least assigned the SharePoint Online administrator role and have been assigned a SharePoint Online license to be able to provision the OneDrive for Business sites. The users who the sites will be provisioned for must also have a SharePoint license assigned.

• This cmdlet is NOT OneDrive Multi-Geo aware. If you need to request Personal Sites for Multi-Geo enabled tenants, you must run this cmdlet for users in the region their data is to be hosted in. To retrieve users with a specific PDL, use the following sample: `Get-MSOLUser | Where {$_.PreferredDataLocation -eq "EUR"}`. +Note: +- You must specify a string array of user logins that contains one or more valid user email (logins) and cannot contain any empty fields. The command will stop if it encounters any empty strings in the array. A maximum of 200 users can be specified. +- The actor executing this cmdlet must be at least assigned the SharePoint Online administrator role and have been assigned a SharePoint Online license to be able to provision the OneDrive for Business sites. The users who the sites will be provisioned for must also have a SharePoint license assigned. +- This cmdlet is NOT OneDrive Multi-Geo aware. If you need to request Personal Sites for Multi-Geo enabled tenants, you must run this cmdlet for users in the region their data is to be hosted in. To retrieve users with a specific PDL, use the following sample: `Get-MSOLUser | Where {$_.PreferredDataLocation -eq "EUR"}`. ## EXAMPLES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md index dd4ffa7ecf..7cc6e372ba 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md @@ -35,7 +35,8 @@ Set-SPOSite [-Identity] [-AllowSelfServiceUpgrade ] [ [-SharingBlockedDomainList ] [-SharingDomainRestrictionMode ] [-ShowPeoplePickerSuggestionsForGuestUsers ] [-StorageQuotaReset] [-DefaultSharingLinkType] [-DefaultLinkPermission] [-DefaultLinkToExistingAccess] - [-ConditionalAccessPolicy ] [-LimitedAccessFileType ] [-AllowEditing ] [-AnonymousLinkExpirationInDays ] [-OverrideTenantAnonymousLinkExpirationPolicy ] [-SensitivityLabel ][] + [-ConditionalAccessPolicy ] [-LimitedAccessFileType ] [-AllowEditing ] [-AnonymousLinkExpirationInDays ] [-OverrideTenantAnonymousLinkExpirationPolicy ] [-SensitivityLabel ] + [-RemoveLabel] [] ``` ### ParamSet2 @@ -70,6 +71,10 @@ You must be a SharePoint Online administrator or Global Administrator and be a s For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For OneDrive for Business site collection, the only valid parameters are Identity, AllowDownloadingNonWebViewableFiles, AllowEditing, ConditionalAccessPolicy, DefaultLinkPermission, DefaultSharingLinkType, DisableCompanyWideSharingLinks, LimitedAccessFileType, LockState, Owner, SharingAllowedDomainList, SharingBlockedDomainList, SharingCapability, SharingDomainRestrictionMode, ShowPeoplePickerSuggestionsForGuestUsers, StorageQuota, and StorageWarningLevel. + +For Groups site collection, the only valid parameters are Identity, AllowSelfServiceUpgrade, DefaultLinkPermission, DefaultSharingLinkType, DenyAddAndCustomizePages, DisableCompanyWideSharingLinks, DisableSharingForNonOwners, LockState, Owner, ResourceQuota, ResourceQuotaWarningLevel, SandboxedCodeActivationCapability, SharingCapability, ShowPeoplePickerSuggestionsForGuestUsers, SocialBarOnSitePagesDisabled, StorageQuota, StorageQuotaReset, and StorageQuotaWarningLevel. + ## EXAMPLES ### -----------------------EXAMPLE 1----------------------------- @@ -550,7 +555,12 @@ Accept wildcard characters: False ### -DisableAppViews -PARAMVALUE: Unknown | Disabled | NotDisabled +Disables the Power Apps button. +Possible values: + +- Disabled +- NotDisabled +- Unknown (not settable) ```yaml Type: AppViewsPolicy @@ -565,8 +575,12 @@ Accept wildcard characters: False ``` ### -DisableCompanyWideSharingLinks +Disables People in your organization links. For more information, see [People in your organization sharing links](https://docs.microsoft.com/microsoft-365/solutions/microsoft-365-limit-sharing#people-in-your-organization-sharing-links). +Possible values -PARAMVALUE: Unknown | Disabled | NotDisabled +- Disabled +- NotDisabled +- Unknown (not settable) ```yaml Type: CompanyWideSharingLinksPolicy @@ -581,8 +595,11 @@ Accept wildcard characters: False ``` ### -DisableFlows +Disables the Power Automate button. +Possible values -PARAMVALUE: Unknown | Disabled | NotDisabled +- Disabled +- NotDisabled ```yaml Type: FlowsPolicy @@ -650,17 +667,14 @@ Accept wildcard characters: False ### -SharingDomainRestrictionMode -Specifies the external sharing mode for domains. - -The following values are: - -None +Specifies the sharing mode for external domains. -AllowList +Possible values are: +- None - Do not restrict sharing by domain +- AllowList - Sharing is allowed only with external users that have account on domains specified within -SharingAllowedDomainList +- BlockList - Sharing is allowed with external users in all domains except in domains specified within -SharingBlockedDomainList -BlockList - -For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business. +For additional information about how to restrict a domain sharing, see [Restrict sharing of SharePoint and OneDrive content by domain](https://docs.microsoft.com/sharepoint/restricted-domains-sharing). ```yaml Type: SharingDomainRestrictionModes @@ -712,10 +726,10 @@ The default link type for the site collection PARAMVALUE: None | AnonymousAccess | Internal | Direct -None - Respect the organization default sharing link type -AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link -Internal - Sets the default sharing link for this site to the "organization" link or company shareable link -Direct - Sets the default sharing link for this site to the "Specific people" link +- None - Respect the organization default sharing link type +- AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link +- Internal - Sets the default sharing link for this site to the "organization" link or company shareable link +- Direct - Sets the default sharing link for this site to the "Specific people" link ```yaml Type: SharingLinkType @@ -755,9 +769,9 @@ The default link permission for the site collection PARAMVALUE: None | View | Edit -None - Respect the organization default link permission -View - Sets the default link permission for the site to "view" permissions -Edit - Sets the default link permission for the site to "edit" permissions +- None - Respect the organization default link permission +- View - Sets the default link permission for the site to "view" permissions +- Edit - Sets the default link permission for the site to "edit" permissions ```yaml Type: SharingPermissionType @@ -777,9 +791,9 @@ Choose whether to override the anonymous or anyone link expiration policy on thi PARAMVALUE: None | False | True -None - Respect the organization-level policy for anonymous or anyone link expiration -False - Respect the organization-level policy for anonymous or anyone link expiration -True - Override the organization-level policy for anonymous or anyone link expiration (can be more or less restrictive) +- None - Respect the organization-level policy for anonymous or anyone link expiration +- False - Respect the organization-level policy for anonymous or anyone link expiration +- True - Override the organization-level policy for anonymous or anyone link expiration (can be more or less restrictive) ```yaml Type: Boolean @@ -893,6 +907,20 @@ Position: Named Default value: None ``` +### -RemoveLabel +This parameter allows you to remove the assigned sensitivity label on a site. + +```yaml +Type: SwitchParameter +Parameter Sets: ParamSet5 +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -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/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md index 60ab559604..ad6cb8ba6c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md @@ -392,7 +392,7 @@ Accept wildcard characters: False ### -MaxCompatibilityLevel -Specifies the upper bound on the compatibility level for new sites. +The only valid value is "15". ```yaml Type: Int32 @@ -408,7 +408,7 @@ Accept wildcard characters: False ### -MinCompatibilityLevel -Specifies the lower bound on the compatibility level for new sites. +The only valid value is "15". ```yaml Type: Int32 diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md index 1045375687..f7e1e2dbec 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md @@ -20,7 +20,7 @@ Starts the ability to move a user closer to their sites. ```powershell Start-SPOUserAndContentMove [-UserPrincipalName] [-DestinationDataLocation] - [[-PreferredMoveBeginDate] ] [[-PreferredMoveEndDate] ] [-OverwriteOdb] + [[-PreferredMoveBeginDate] ] [[-PreferredMoveEndDate] ] [[-Notify] ] [[-Reserved] ] [-ValidationOnly] [] ``` @@ -90,23 +90,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverwriteOdb - -This parameter can be used to overrite a OneDrive in the destination location, if there is one present. This is only recommended in cases where an administrator wants to replace a OneDrive that already exists in the destination location, with the moved OneDrive. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -PreferredMoveBeginDate Specifies what is the preferred date and time to begin the move. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Update-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Update-SPODataEncryptionPolicy.md index f33a519ace..c902ead6fd 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Update-SPODataEncryptionPolicy.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Update-SPODataEncryptionPolicy.md @@ -19,7 +19,7 @@ Updates customer encryption status for a geo tenant. ## SYNTAX ```powershell -Update-SPODataEncryptionPolicy [-Identity] [-KeyVaultName] [-KeyName] [-KeyVersion] [-KeyType] [-WhatIf] [-Confirm] [] +Update-SPODataEncryptionPolicy [-KeyVaultName] [-KeyName] [-KeyVersion] [-KeyType] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,7 +32,7 @@ For more information, see [Controlling your data in Office 365 using Customer Ke ### Example 1 ```powershell -Update-SPODataEncryptionPolicy -Identity https://contoso-admin.sharepoint.com -KeyVaultName -KeyName -KeyVersion -KeyType Primary +Update-SPODataEncryptionPolicy -KeyVaultName -KeyName -KeyVersion -KeyType Primary ``` This example updates the DEP used with SharePoint Online and OneDrive for Business to start using the new key @@ -55,22 +55,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity - -Specifies the URL of the admin site collection. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -KeyName The name of the key diff --git a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataMapping.md b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataMapping.md index 1d2a1137a5..512282d330 100644 --- a/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataMapping.md +++ b/sharepoint/sharepoint-ps/sharepoint-server/New-SPEnterpriseSearchMetadataMapping.md @@ -46,9 +46,7 @@ New-SPEnterpriseSearchMetadataMapping -SearchApplication $ssa -ManagedProperty $ This example maps the created crawled property MyCrawlProp to the managed property UserName for the default search service application. ->![NOTE] ->The VarientType parameter is marked as obsolete but is still required when executing the `New-SPEnterpriseSearchMetadataCrawledProperty` cmdlet. - +The VarientType parameter is marked as obsolete but is still required when executing the `New-SPEnterpriseSearchMetadataCrawledProperty` cmdlet. ## PARAMETERS diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSecureStoreApplication.md b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSecureStoreApplication.md index 04c75e00c0..71b4540ab9 100644 --- a/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSecureStoreApplication.md +++ b/sharepoint/sharepoint-ps/sharepoint-server/Remove-SPSecureStoreApplication.md @@ -33,7 +33,7 @@ For permissions and the most current information about Windows PowerShell for Sh ### -----------------------EXAMPLE----------------------------- ``` -Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApp" | Remove -SPSecureStoreApplication +Get-SPSecureStoreApplication -ServiceContext http://contoso -Name "ContosoTargetApp" | Remove-SPSecureStoreApplication ``` This example removes the specified application and target. diff --git a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkflowConfig.md b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkflowConfig.md index f320663f65..311e481d4a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkflowConfig.md +++ b/sharepoint/sharepoint-ps/sharepoint-server/Set-SPWorkflowConfig.md @@ -172,7 +172,7 @@ Accept wildcard characters: False ``` ### -SingleWorkflowEpisodeTimeout -{{Fill SingleWorkflowEpisodeTimeout Description}} +Amount of time in seconds given to the workflow to run. ```yaml Type: Int32 diff --git a/skype/docs-conceptual/index.md b/skype/docs-conceptual/index.md index 7bff2d7098..c9e9440543 100644 --- a/skype/docs-conceptual/index.md +++ b/skype/docs-conceptual/index.md @@ -1,15 +1,16 @@ --- localization_priority: Normal -title: Skype for Business cmdlet reference +title: Skype for Business cmdlet help reference +description: "Learn about the Skype for Business PowerShell cmdlet help reference." --- -# Skype for Business cmdlet reference +# Skype for Business cmdlet help reference -Welcome to the Skype for Business PowerShell cmdlet help references. The Skype for Business cmdlets provide the command line interface for server and service administration and management. +Welcome to the Skype for Business PowerShell cmdlet **Help** reference. The Skype for Business cmdlets provide the command line interface for server and service administration and management. > [!IMPORTANT] -> As you migrate to Microsoft Teams you will find that some of the cmdlets in the Skype for Business Online module are also used for Microsoft Teams. To learn more about this, see: [Teams PowerShell Overview](https://docs.microsoft.com/MicrosoftTeams/teams-powershell-overview). +> As you migrate to Microsoft Teams, you will find that some of the cmdlets in the Skype for Business Online module are also used for Microsoft Teams. To learn more about this, see: [Teams PowerShell Overview](https://docs.microsoft.com/MicrosoftTeams/teams-powershell-overview). -Here you will find all of the Skype for Business and relevant Microsoft Teams PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. +Here, you will find all of the Skype for Business and relevant Microsoft Teams PowerShell **Help** topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content, go to the source GitHub repo and look through the README. -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. +The repo is located here: and you can find the README displayed at the bottom of the page. diff --git a/skype/skype-ps/skype/Get-CsTeamsFeedbackPolicy.md b/skype/skype-ps/skype/Get-CsTeamsFeedbackPolicy.md new file mode 100644 index 0000000000..a6fe32ae56 --- /dev/null +++ b/skype/skype-ps/skype/Get-CsTeamsFeedbackPolicy.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://docs.microsoft.com/powershell/module/skype/get-csteamsfeedbackpolicy +applicable: Skype for Business Online +title: Get-CsTeamsFeedbackPolicy +schema: 2.0.0 +manager: bulenteg +ms.author: tomkau +author: tomkau +ms.reviewer: +--- + +# Get-CsTeamsFeedbackPolicy + +## SYNOPSIS + +Use this cmdlet to retrieve the current Teams Feedback policies in the organization. + +## SYNTAX + +``` +Get-CsTeamsFeedbackPolicy [-LocalStore] [[-Identity] ] [-Tenant ] [-Filter ] +``` + +## DESCRIPTION +Retrieves the current Teams Feedback policies in the organization. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-CsTeamsFeedbackPolicy +``` + +In this example, we retrieve all the existing Teams feedback policies in the organization. + +## PARAMETERS + +### -Filter +Internal Microsoft use + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The unique identifier of the policy. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalStore +Internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastPolicy.md b/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastPolicy.md index 70c20342e5..58110b7e7d 100644 --- a/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastPolicy.md +++ b/skype/skype-ps/skype/Get-CsTeamsMeetingBroadcastPolicy.md @@ -14,9 +14,7 @@ ms.reviewer: # Get-CsTeamsMeetingBroadcastPolicy ## SYNOPSIS -Get-CsTeamsMeetingBroadcastPolicy \[\[-Identity\] \\] \[-Tenant \\] \[-LocalStore\] \[\\] - -Get-CsTeamsMeetingBroadcastPolicy \[-Tenant \\] \[-Filter \\] \[-LocalStore\] \[\\] +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. ## SYNTAX @@ -36,11 +34,23 @@ User-level policy for tenant admin to configure meeting broadcast behavior for t ## EXAMPLES +### Example 1 +``` +Get-CsTeamsMeetingBroadcastPolicy +``` +Returns all the Teams Meeting Broadcast policies. + +### Example 2 +``` +Get-CsTeamsMeetingBroadcastPolicy -Filter "Education_Teacher" +``` + +In this example, the -Filter parameter is used to return all the policies that match "Education_Teacher". ## PARAMETERS ### -Filter -Enables you to use wildcard characters when specifying the policy (or policies) to be returned. For example, this syntax returns all the policies configured at the per-user scope +Enables you to use wildcard characters when specifying the policy (or policies) to be returned. ```yaml Type: String diff --git a/skype/skype-ps/skype/Get-CsTenantDialPlan.md b/skype/skype-ps/skype/Get-CsTenantDialPlan.md index 472308fc8f..c3eccfe278 100644 --- a/skype/skype-ps/skype/Get-CsTenantDialPlan.md +++ b/skype/skype-ps/skype/Get-CsTenantDialPlan.md @@ -42,7 +42,7 @@ You can use the Get-CsTenantDialPlan cmdlet to retrieve specific information abo Get-CsTenantDialPlan ``` -This example retrieves a tenant dial plan. +This example retrieves all existing tenant dial plans. @@ -51,7 +51,7 @@ This example retrieves a tenant dial plan. Get-CsTenantDialPlan -Identity Vt1TenantDialPlan2 ``` -This example retrieves the tenant dial plan that is within the scope of Vt1TenantDialplan2. +This example retrieves the tenant dial plan that has an identity of Vt1TenantDialplan2. ## PARAMETERS @@ -73,7 +73,7 @@ Accept wildcard characters: False ``` ### -Identity -The Identity parameter is a unique identifier that designates the scope, and for per-user scope a name, which identifies the tenant dial plan to retrieve. +The Identity parameter is a unique identifier that designates the name of the tenant dial plan to retrieve. ```yaml Type: XdsIdentity diff --git a/skype/skype-ps/skype/Grant-CsTeamsFeedbackPolicy.md b/skype/skype-ps/skype/Grant-CsTeamsFeedbackPolicy.md new file mode 100644 index 0000000000..2b0f15cf37 --- /dev/null +++ b/skype/skype-ps/skype/Grant-CsTeamsFeedbackPolicy.md @@ -0,0 +1,170 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://docs.microsoft.com/powershell/module/skype/grant-csteamsfeedbackpolicy +applicable: Skype for Business Online +title: Grant-CsTeamsFeedbackPolicy +schema: 2.0.0 +manager: bulenteg +ms.author: tomkau +author: tomkau +ms.reviewer: +--- + +# Grant-CsTeamsFeedbackPolicy + +## SYNOPSIS + +Use this cmdlet to grant a specific Teams Feedback policy to a user. + +## SYNTAX + +``` +Grant-CsTeamsFeedbackPolicy [-PassThru] [-Confirm] [[-PolicyName] ] [[-Identity] ] [-Global] + [-Tenant ] [-DomainController ] [-WhatIf] +``` + +## DESCRIPTION +Grants a specific Teams Feedback policy to a user. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Grant-CsTeamsFeedbackPolicy -PolicyName "New Hire Feedback Policy" -Identity kenmyer@litwareinc.com +``` + +In this example, the policy "New Hire Feedback Policy" is granted to the user kenmyer@litwareinc.com. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +Internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Global +Use this parameter to make the specified policy in -PolicyName the new effective global policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +Indicates the identity of the user account the policy should be assigned to. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyName +The identity of the policy to be granted. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## INPUTS + +### Microsoft.Rtc.Management.AD.UserIdParameter + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsTeamsVideoInteropServicePolicy.md b/skype/skype-ps/skype/Grant-CsTeamsVideoInteropServicePolicy.md index 9a152f56d7..eeb3a4ef94 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsVideoInteropServicePolicy.md +++ b/skype/skype-ps/skype/Grant-CsTeamsVideoInteropServicePolicy.md @@ -36,21 +36,59 @@ Cloud Video Interop for Teams enables 3rd party VTC devices to be able to join T The Grant-CsTeamsVideoInteropServicePolicy cmdlet allows you to assign a pre-constructed policy across your whole organization or only to specific users. +User needs to be assigned one policy from admin to create a CVI meeting. There could be multiple provides in a tenant, but user can only be assigned only one policy(provide). + +**FAQ**: + +Q: After running `Grant-CsTeamsVideoInteropServicePolicy -PolicyName ` to assign a policy to the whole tenant, the result of `Get-CsOnlineUser -Identity {User Identity} | Format-List TeamsVideoInteropServicePolicy` that checks if the User Policy is empty. + +A: Global/Tenant level Policy Assignment can be checked by running `Get-CsTeamsVideoInteropServicePolicy Global`. + +Q: I assigned CVI policy to a user, but I can't create a VTC meeting with that policy or I made changes to policy assignment, but it didn't reflect on new meetings I created. + +A: The policy is cached for 6 hours. Changes to the policy are updated after the cache expires. Check for your changes after 6 hours. + +**Frequently used commands that can help idenfity the policy assignment**: + +- Command to get full list of user along with their CVI policy: `Get-CsOnlineUser | Format-List UserPrincipalName,TeamsVideoInteropServicePolicy` + +- Command to get the policy assigned to the whole tenant: `Get-CsTeamsVideoInteropServicePolicy Global` + ## EXAMPLES -### Example 1 +### Example 1: The whole tenant has the same provider + ```powershell -PS C:\> Grant-CsTeamsVideoInteropServicePolicy -PolicyName ServiceProviderDisabled +Grant-CsTeamsVideoInteropServicePolicy -PolicyName ``` -In this example, Cloud Video Interop has been disabled for the entire tenant, except for those users that have an explicit policy assigned to them. +Specify the provider for the whole tenant or use the value $null to remove the tenant-level provider and let the whole tenant fall back to the Global policy. + +### Example 2: The tenant has two (or three) interop service providers -### Example 2 ```powershell -PS C:\> Grant-CsTeamsVideoInteropServicePolicy -PolicyName ServiceProviderDisabled -Identity bob@contoso.com +Grant-CsTeamsVideoInteropServicePolicy -PolicyName -Identity ``` -In this example, Cloud Video Interop has been disabled only for one user - Bob - but the default tenant policy has been left on for all other users who do not have an explicit assignment. +Specify each user with the Identity parameter, and use Provider-1 or Provider-2 for the value of the PolicyName parameter. Use the value $null to remove the provider and let the user's provider fallback to Global policy. + +### Example 3: The tenant has a default interop service provider, but specific users (say IT folks) want to pilot another interop provider. + +```powershell +Grant-CsTeamsVideoInteropServicePolicy -PolicyName [-Identity ] +``` + +- To assign Provider-1 as the default interop service provider, don't use the Identity parameter and use the value Provider-1 for the PolicyName parameter. + +- For specific users to try Provider-2, specify each user with the Identity parameter, and use the value Provider-2 for the PolicyName parameter. + +- For specific users who need to disable CVI, specify each user with the Identity parameter and use the value ServiceProviderDisabled for the PolicyName parameter. + +### Example 4: Cloud Video Interop has been disabled for the entire tenant, except for those users that have an explicit policy assigned to them. + +```powershell +Grant-CsTeamsVideoInteropServicePolicy -PolicyName ServiceProviderDisabled +``` ## PARAMETERS @@ -183,7 +221,6 @@ For more information, see about_CommonParameters (https://go.microsoft.com/fwlin ### Microsoft.Rtc.Management.AD.UserIdParameter - ## OUTPUTS ### System.Object diff --git a/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md b/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md index c9fc10a5ca..b89890e710 100644 --- a/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md +++ b/skype/skype-ps/skype/New-CsOnlinePSTNGateway.md @@ -334,7 +334,7 @@ Accept wildcard characters: False ``` ### -GenerateRingingWhileLocatingUser -This parameter is applicableis only for Direct Routing in non-media bypass mode. Sometimes inbound calls from the public switched telephone network (PSTN) to Teams clients can take longer than expected to be established. This can occur for various reasons. When this happens, the caller might not hear anything, the Teams client doesn't ring, and the call might be canceled by some telecommunications providers. This parameter helps to avoid unexpected silences that can occur in this scenario. When enabled for inbound calls from the PSTN to Teams clients, a distinctive audio signal is played to the caller to indicate that Teams is in the process of establishing the call. +This parameter is applicable only for Direct Routing in non-media bypass mode. Sometimes inbound calls from the public switched telephone network (PSTN) to Teams clients can take longer than expected to be established. This can occur for various reasons. When this happens, the caller might not hear anything, the Teams client doesn't ring, and some telecommunications providers might cancel the call. This parameter helps to avoid unexpected silences that can occur in this scenario. When enabled for inbound calls from the PSTN to Teams clients, a distinctive audio signal is played to the caller to indicate that Teams is in the process of establishing the call. ```yaml Type: Boolean diff --git a/skype/skype-ps/skype/New-CsOnlineSession.md b/skype/skype-ps/skype/New-CsOnlineSession.md index 95b0ef8f4e..031d2a7e96 100644 --- a/skype/skype-ps/skype/New-CsOnlineSession.md +++ b/skype/skype-ps/skype/New-CsOnlineSession.md @@ -18,16 +18,7 @@ Creates a persistent connection to Microsoft Skype for Business Online DataCente ### Credential (Default) ``` -New-CsOnlineSession [[-Credential] ] [-OverrideAdminDomain ] - [-OverrideDiscoveryUri ] [-OverridePowerShellUri ] [-OverrideAccessTokenResourceUri ] - [-SessionOption ] [] [-TeamsEnvironmentName ] -``` - -### OAuthAccessToken -``` -New-CsOnlineSession [-OAuthAccessToken ] [-OverrideAdminDomain ] - [-OverrideDiscoveryUri ] [-OverridePowerShellUri ] [-OverrideAccessTokenResourceUri ] - [-SessionOption ] [] [-TeamsEnvironmentName ] +New-CsOnlineSession [[-Credential] ] [-OverrideAdminDomain ] [-OverridePowerShellUri ] [-TeamsEnvironmentName ] [-SessionOption ] [] ``` ## DESCRIPTION @@ -62,28 +53,10 @@ Establishes a Skype for Business Online Remote PowerShell session using multi-fa ## PARAMETERS -### -UserName -Specifies the Skype for Business Online administrator account name to be used when prompting for credentials. -Please Note: UserName has been deprecated and is not available in the Teams Powershell module. Please use the Credential parameter to provide username and password. - -```yaml -Type: String -Parameter Sets: UserName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Credential Specifies a Skype for Business Online administrator, or Syndicated Partner administrator account. +Enter a PSCredential object, such as one returned by the Get-Credential cmdlet. -Type a Skype for Business Online administrator account name, such as "admin@contoso.com", or enter a PSCredential object, such as one returned by the Get-Credential cmdlet. - -When you type an account name, you will be prompted for a password. ```yaml Type: PSCredential @@ -97,23 +70,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OAuthAccessToken -Specifies an access token already acquired by the Skype for Business Online administrator, or Syndicated Partner administrator. - -```yaml -Type: SecureString -Parameter Sets: OAuthAccessToken -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -OverrideAdminDomain -Specifies the domain of the tenant to be managed. This is used when the administrator has permissions to manage more than one tenant. For example, Syndicated Partner administrators commonly manage several tenants. +Specifies the domain of the tenant to be managed. This is used when the administrator has permissions to manage more than one tenant. For example, Syndicated Partner administrators commonly manage several tenants. ```yaml Type: String @@ -127,22 +85,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverrideDiscoveryUri -Specifies Skype for Business Auto Discovery URI. -Optional. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -OverridePowerShellUri Specifies Skype for Business Remote Powershell URI. Optional. @@ -159,22 +101,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverrideAccessTokenResourceUri -Specifies Skype for Business Remote Powershell Authorization Token URI. -Optional. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -TeamsEnvironmentName Use this setting if your organization is in one of the Teams Government Cloud environments. diff --git a/skype/skype-ps/skype/New-CsTeamsFeedbackPolicy.md b/skype/skype-ps/skype/New-CsTeamsFeedbackPolicy.md index 5d52db7584..566988e526 100644 --- a/skype/skype-ps/skype/New-CsTeamsFeedbackPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsFeedbackPolicy.md @@ -19,7 +19,7 @@ Use this cmdlet to control whether users in your organization can send feedback ``` New-CsTeamsFeedbackPolicy [-WhatIf] [-Confirm] [[-Identity] ] [-Tenant ] [-InMemory] - [-UserInitiatedMode ] [-ReceiveSurveysMode ] [-Force] + [-UserInitiatedMode ] [-ReceiveSurveysMode ] [-Force] ``` ## DESCRIPTION @@ -99,14 +99,19 @@ Accept wildcard characters: False ### -ReceiveSurveysMode Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. +Possible values: + - Enabled + - Disabled + - EnabledUserOverride + ```yaml -Type: Object +Type: String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: Enabled Accept pipeline input: False Accept wildcard characters: False ``` @@ -130,14 +135,18 @@ Accept wildcard characters: False 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: Object +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/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md index 34c3eabfab..0a5d41e76e 100644 --- a/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/New-CsTeamsMeetingPolicy.md @@ -18,7 +18,7 @@ ms.reviewer: ``` New-CsTeamsMeetingPolicy [-Tenant ] [-Description ] - [-AllowChannelMeetingScheduling ] [-AllowMeetNow ] [-AllowIPVideo ] [-IPAudioMode ] [-IPVideoMode ] + [-AllowChannelMeetingScheduling ] [-AllowMeetNow ] [-AllowPrivateMeetNow ] [-AllowIPVideo ] [-IPAudioMode ] [-IPVideoMode ] [-AllowAnonymousUsersToDialOut ] [-AllowAnonymousUsersToStartMeeting ] [-AllowPrivateMeetingScheduling ] [-AutoAdmittedUsers ] [-AllowCloudRecording ] [-AllowOutlookAddIn ] [-AllowPowerPointSharing ] @@ -184,7 +184,7 @@ Accept wildcard characters: False ``` ### -AllowMeetNow -Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc meetings. Set this to FALSE to prohibit the user from starting ad-hoc meetings. +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 @@ -193,7 +193,22 @@ Aliases: Required: False Position: Named -Default value: None +Default value: TRUE +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowPrivateMeetNow +Determines whether a user can start ad-hoc meetings. Set this to TRUE to allow a user to start ad-hoc private meetings. Set this to FALSE to prohibit the user from starting ad-hoc private meetings. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: TRUE Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/skype/skype-ps/skype/New-CsTenantDialPlan.md b/skype/skype-ps/skype/New-CsTenantDialPlan.md index 997368e8ac..f58544c588 100644 --- a/skype/skype-ps/skype/New-CsTenantDialPlan.md +++ b/skype/skype-ps/skype/New-CsTenantDialPlan.md @@ -90,7 +90,7 @@ Accept wildcard characters: False ### -Description The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to and any other information that helps to identify the purpose of the tenant dial plan. -Maximum characters: 512. +Maximum characters: 1040. ```yaml Type: String @@ -110,8 +110,7 @@ The ExternalAccessPrefix parameter is a number (or set of numbers) that designat (For example, to tenant-dial an outside line, first press 9.) This prefix is ignored by the normalization rules, although these rules are applied to the remainder of the number. The OptimizeDeviceDialing parameter must be set to True for this value to take effect. -This parameter must match the regular expression \[0-9\]{1,4}: that is, it must be a value 0 through 9 and one to four digits in length. -The default value is 9. +The value of this parameter must be no longer than 4 characters long and can contain only digits, "#" or a "*". ```yaml Type: String @@ -162,13 +161,13 @@ Accept wildcard characters: False ### -NormalizationRules The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. -Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the `New-CsVoiceNormalizationRule` (https://technet.microsoft.com/en-us/library/gg398240.aspx) cmdlet, which creates the rule and assigns it to the specified tenant dial plan. +Although this list and these rules can be created directly by using this cmdlet, we recommend that you create the normalization rules by the [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) cmdlet, which creates the rule and then assign it to the specified tenant dial plan using [Set-CsTenantDialPlan](Set-CsTenantDialPlan.md) cmdlet. 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://technet.microsoft.com/en-us/library/gg398240.aspx) cmdlet. +You can create a new normalization rule by calling the [New-CsVoiceNormalizationRule](New-CsVoiceNormalizationRule.md) cmdlet. ```yaml Type: List @@ -202,18 +201,13 @@ Accept wildcard characters: False ### -SimpleName The SimpleName parameter is a display name for the tenant dial plan. -This name must be unique among all tenant dial plans within the Skype for Business Server deployment. +This name must be unique among all tenant dial plans. This string can be up to 49 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.) and parentheses (()). This parameter must contain a value. -However, if you don't provide a value, a default value will be supplied. -The default value for a Global tenant dial plan is Prefix All. -The default value for a site-level tenant dial plan is the name of the site. -The default value for a service is the name of the service (Registrar or PSTN gateway) followed by an underscore, followed by the service fully qualified domain name (FQDN). -For example: Registrar_pool0.litwareinc.com. -The default value for a per-user tenant dial plan is the Identity of the tenant dial plan. +However, if you don't provide a value, a default value matching the Identity of the tenant dial plan will be supplied. ```yaml Type: String diff --git a/skype/skype-ps/skype/Remove-CsTeamsFeedbackPolicy.md b/skype/skype-ps/skype/Remove-CsTeamsFeedbackPolicy.md new file mode 100644 index 0000000000..1acbd7615e --- /dev/null +++ b/skype/skype-ps/skype/Remove-CsTeamsFeedbackPolicy.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://docs.microsoft.com/powershell/module/skype/remove-csteamsfeedbackpolicy +applicable: Skype for Business Online +title: Remove-CsTeamsFeedbackPolicy +schema: 2.0.0 +manager: bulenteg +ms.author: tomkau +author: tomkau +ms.reviewer: +--- + +# Remove-CsTeamsFeedbackPolicy + +## SYNOPSIS + +Use this cmdlet to remove a Teams Feedback policy from the Tenant. + +## SYNTAX + +``` +Remove-CsTeamsFeedbackPolicy [-WhatIf] [-Confirm] [[-Identity] ] [-Tenant ] [-Force] +``` + +## DESCRIPTION +Removes a Teams Feedback policy from the Tenant. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Remove-CsTeamsFeedbackPolicy -Identity "New Hire Feedback Policy" +``` + +In this example, the policy "New Hire Feedback Policy" is being removed. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The identity of the policy to be removed. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant +Internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## INPUTS + +### Microsoft.Rtc.Management.Xds.XdsIdentity + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md b/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md index 3855d7b45d..97904895f1 100644 --- a/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md +++ b/skype/skype-ps/skype/Set-CsOnlinePSTNGateway.md @@ -303,7 +303,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -GenerateRingingWhileLocatingUser -This parameter is applicableis only for Direct Routing in non-media bypass mode. Sometimes inbound calls from the public switched telephone network (PSTN) to Teams clients can take longer than expected to be established. This can occur for various reasons. When this happens, the caller might not hear anything, the Teams client doesn't ring, and the call might be canceled by some telecommunications providers. This parameter helps to avoid unexpected silences that can occur in this scenario. When enabled for inbound calls from the PSTN to Teams clients, a distinctive audio signal is played to the caller to indicate that Teams is in the process of establishing the call. +This parameter is applicable only for Direct Routing in non-media bypass mode. Sometimes inbound calls from the public switched telephone network (PSTN) to Teams clients can take longer than expected to be established. This can occur for various reasons. When this happens, the caller might not hear anything, the Teams client doesn't ring, and some telecommunications providers might cancel the call. This parameter helps to avoid unexpected silences that can occur in this scenario. When enabled for inbound calls from the PSTN to Teams clients, a distinctive audio signal is played to the caller to indicate that Teams is in the process of establishing the call. ```yaml Type: Boolean diff --git a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md index 233c6ba0e4..6d82e420f6 100644 --- a/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsCallingPolicy.md @@ -20,18 +20,12 @@ Use this cmdlet to update values in existing Teams Calling Policies. ### Identity (Default) ``` -Set-CsTeamsCallingPolicy [-Tenant ] [-AllowWebPSTNCalling ] [-SafeTransferEnabled ] [-AllowCalling ] [-AllowPrivateCalling ] - [-AllowVoicemail ] [-AllowCallGroups ] [-AllowDelegation ] - [-AllowCallForwardingToUser ] [-AllowCallForwardingToPhone ] - [-PreventTollBypass ] [-BusyOnBusyEnabledType ] [-MusicOnHoldEnabledType ][[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] +Set-CsTeamsCallingPolicy [-Tenant ] [-AllowWebPSTNCalling ] [-SafeTransferEnabled ] [-AllowCalling ] [-AllowPrivateCalling ] [-AllowVoicemail ] [-AllowCallGroups ] [-AllowDelegation ] [-AllowCallForwardingToUser ] [-AllowCallForwardingToPhone ] [-AllowCloudRecordingForCalls ] [-PreventTollBypass ] [-BusyOnBusyEnabledType ] [-MusicOnHoldEnabledType ] [-AutoAnswerEnabledType ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Instance ``` -Set-CsTeamsCallingPolicy [-Tenant ] [-AllowCalling ] [-AllowPrivateCalling ] - [-AllowVoicemail ] [-AllowCallGroups ] [-AllowDelegation ] - [-AllowCallForwardingToUser ] [-AllowCallForwardingToPhone ] - [-PreventTollBypass ] [-BusyOnBusyEnabledType ] [-MusicOnHoldEnabledType ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] +Set-CsTeamsCallingPolicy [-Tenant ] [-AllowCalling ] [-AllowPrivateCalling ] [-AllowVoicemail ] [-AllowCallGroups ] [-AllowDelegation ] [-AllowCallForwardingToUser ] [-AllowCallForwardingToPhone ] [-AllowCloudRecordingForCalls ] [-PreventTollBypass ] [-BusyOnBusyEnabledType ] [-MusicOnHoldEnabledType ] [-AutoAnswerEnabledType ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -145,7 +139,7 @@ Accept wildcard characters: False ``` ### -Instance -Use this to pipe a specific calling policy to be set. You can only modify the global policy, so can only pass the global instance of the Calling Policy. +Use this to pipe a specific calling policy to be set. You can only modify the global policy, so can only pass the global instance of the Calling Policy. ```yaml Type: PSObject @@ -251,13 +245,27 @@ Accept wildcard characters: False ``` ### -AllowVoicemail -Enables inbound calls to be routed to voice mail. Valid options are: AlwaysEnabled, AlwaysDisabled, UserOverride. +Enables inbound calls to be routed to voice mail. Valid options are: AlwaysEnabled, AlwaysDisabled, UserOverride. ```yaml Type: String Parameter Sets: (All) Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -AllowCloudRecordingForCalls +Determines whether cloud recording is allowed in a user's 1:1 call. 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: + Required: False Position: Named Default value: None @@ -317,7 +325,7 @@ Possible values - Disabled - UserOverride -[!NOTE] This parameter is not available for use. +**Note**: This parameter is not available for use. ```yaml Type: Object @@ -331,6 +339,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AutoAnswerEnabledType +Setting this parameter allows you to enable or disable auto answer for incoming meeting invites. It is turned off by default. Valid options are Enabled and Disabled. This setting applies only to incoming meeting invites and does not include support for other call types. + +```yaml +Type: Enum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Disabled +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingApplication.md b/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingApplication.md index b4f6b6d3cb..9b5a80d9ed 100644 --- a/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingApplication.md +++ b/skype/skype-ps/skype/Set-CsTeamsComplianceRecordingApplication.md @@ -228,7 +228,7 @@ Accept wildcard characters: False ``` ### -ConcurrentInvitationCount -Determines the number of invites to send out to the application instance of the policy-based recording application. +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. diff --git a/skype/skype-ps/skype/Set-CsTeamsFeedbackPolicy.md b/skype/skype-ps/skype/Set-CsTeamsFeedbackPolicy.md new file mode 100644 index 0000000000..41e0ef8fa0 --- /dev/null +++ b/skype/skype-ps/skype/Set-CsTeamsFeedbackPolicy.md @@ -0,0 +1,179 @@ +--- +external help file: Microsoft.Rtc.Management.dll-help.xml +online version: https://docs.microsoft.com/powershell/module/skype/set-csteamsfeedbackpolicy +applicable: Skype for Business Online +title: Set-CsTeamsFeedbackPolicy +schema: 2.0.0 +manager: bulenteg +ms.author: tomkau +author: tomkau +ms.reviewer: +--- + +# Set-CsTeamsFeedbackPolicy + +## SYNOPSIS + +Use this cmdlet to modify a Teams feedback policy. + +## SYNTAX + +``` +Set-CsTeamsFeedbackPolicy [-WhatIf] [-Confirm] [[-Identity] ] [-Tenant ] + [-ReceiveSurveysMode ] [-UserInitiatedMode ] [-Force] [-Instance ] +``` + +## DESCRIPTION +Modifies a Teams feedback policy. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-CsTeamsFeedbackPolicy -identity "New Hire Feedback Policy" -userInitiatedMode enabled -receiveSurveysMode disabled +``` + +In this example, the policy "New Hire Feedback Policy" is modified, sets the userInitiatedMode parameter to enabled and the receiveSurveysMode parameter to disabled. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The unique identifier of the policy. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance +Internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReceiveSurveysMode +Set the receiveSurveysMode parameter to enabled to allow users who are assigned the policy to receive the survey. + +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 +``` + +### -Tenant +Internal Microsoft use. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserInitiatedMode + Set the userInitiatedMode parameter to enabled to allow users who are assigned the policy to give feedback. + Setting the parameter to disabled turns off the feature and users who are assigned the policy don't have the option to give feedback. + +Possible values: + - Enabled + - Disabled + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +## INPUTS + +### System.Management.Automation.PSObject + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md b/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md index cfd9da473e..045521764c 100644 --- a/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md +++ b/skype/skype-ps/skype/Set-CsTeamsGuestMessagingConfiguration.md @@ -20,7 +20,7 @@ TeamsGuestMessagingConfiguration determines the messaging settings for the guest ### Identity (Default) ``` Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage ] - [-AllowUserDeleteMessage ] [-AllowUserChat ] [-AllowGiphy ] + [-AllowImmersiveReader ] [-AllowUserDeleteMessage ] [-AllowUserChat ] [-AllowGiphy ] [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [[-Identity] ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -28,7 +28,7 @@ Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage < ### Instance ``` Set-CsTeamsGuestMessagingConfiguration [-Tenant ] [-AllowUserEditMessage ] - [-AllowUserDeleteMessage ] [-AllowUserChat ] [-AllowGiphy ] + [-AllowImmersiveReader ] [-AllowUserDeleteMessage ] [-AllowUserChat ] [-AllowGiphy ] [-GiphyRatingType ] [-AllowMemes ] [-AllowStickers ] [-Instance ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -181,6 +181,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 +``` + ### -Identity ```yaml diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastPolicy.md index 4be4113701..b352124ded 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingBroadcastPolicy.md @@ -14,9 +14,7 @@ ms.reviewer: ## SYNOPSIS -Set-CsTeamsMeetingBroadcastPolicy \[\[-Identity\] \\] \[-Tenant \\] \[-Description \\] \[-AllowBroadcastScheduling \\] \[-AllowBroadcastTranscription \\] \[-BroadcastAttendeeVisibilityMode \\] \[-BroadcastRecordingMode \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] - -Set-CsTeamsMeetingBroadcastPolicy \[-Tenant \\] \[-Description \\] \[-AllowBroadcastScheduling \\] \[-AllowBroadcastTranscription \\] \[-BroadcastAttendeeVisibilityMode \\] \[-BroadcastRecordingMode \\] \[-Instance \\] \[-Force\] \[-WhatIf\] \[-Confirm\] \[\\] +User-level policy for tenant admin to configure meeting broadcast behavior for the broadcast event organizer. ## SYNTAX @@ -87,6 +85,13 @@ Accept wildcard characters: False ### -BroadcastAttendeeVisibilityMode Specifies the attendee visibility mode of the broadcast events created by this user. This setting controls who can watch the broadcast event - e.g. anyone can watch this event including anonymous users or only authenticated users in my company can watch the event. Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. +Possible values: +- Everyone +- EveryoneInCompany +- InvitedUsersInCompany +- EveryoneInCompanyAndExternal +- InvitedUsersInCompanyAndExternal + ```yaml Type: String Parameter Sets: (All) @@ -100,7 +105,12 @@ Accept wildcard characters: False ``` ### -BroadcastRecordingMode -Specifies whether broadcast events created by this user are always recorded, never recorded or user can choose whether to record or not. Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. +Specifies whether broadcast events created by this user are always recorded (AlwaysEnabled), never recorded (AlwaysDisabled) or user can choose whether to record or not (UserOverride). Note: this setting is applicable to broadcast events that use Teams Meeting production only and does not apply when external encoder is used as production method. + +Possible values: +- AlwaysEnabled +- AlwaysDisabled +- UserOverride ```yaml Type: String diff --git a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md index 90e9549c0a..97a5844357 100644 --- a/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md +++ b/skype/skype-ps/skype/Set-CsTeamsMeetingPolicy.md @@ -27,12 +27,12 @@ Set-CsTeamsMeetingPolicy [-Tenant ] [-Description ] [-AllowOutlookAddIn ] [-AllowPowerPointSharing ] [-AllowParticipantGiveRequestControl ] [-AllowExternalParticipantGiveRequestControl ] [-AllowSharedNotes ] [-AllowWhiteboard ] [-AllowTranscription ] - [-MediaBitRateKb ] [-RecordingStorageMode ] [-ScreenSharingMode ] [-AllowPSTNUsersToBypassLobby ] + [-MediaBitRateKb ] [-RecordingStorageMode ] [-ScreenSharingMode ] [-AllowPSTNUsersToBypassLobby ] [-AllowRecordingStorageOutsideRegion ] [-PreferredMeetingProviderForIslandsMode ] [[-Identity] ] [-VideoFiltersMode ] [-AllowEngagementReport ] [-AllowNDIStreaming ] [-DesignatedPresenterRoleMode ] [-AllowIPAudio ] [-AllowOrganizersToOverrideLobbySettings ] [-AllowUserToJoinExternalMeeting ] [-EnrollUserOverride ] [-StreamingAttendeeMode ] [-AllowMeetingReactions ] [-Force] [-WhatIf] [-Confirm] [] +[-AllowBreakoutRooms ] [-TeamsCameraFarEndPTZMode ] [-AllowMeetingReactions ] [-Force] [-WhatIf] [-Confirm] [] ``` ### Instance @@ -45,12 +45,12 @@ Set-CsTeamsMeetingPolicy [-Tenant ] [-Description ] [-AllowOutlookAddIn ] [-AllowPowerPointSharing ] [-AllowParticipantGiveRequestControl ] [-AllowExternalParticipantGiveRequestControl ] [-AllowSharedNotes ] [-AllowWhiteboard ] [-AllowTranscription ] - [-MediaBitRateKb ] [-RecordingStorageMode ] [-ScreenSharingMode ] [-AllowPSTNUsersToBypassLobby ] + [-MediaBitRateKb ] [-RecordingStorageMode ] [-ScreenSharingMode ] [-AllowPSTNUsersToBypassLobby ] [-AllowRecordingStorageOutsideRegion ] [-PreferredMeetingProviderForIslandsMode ] [-Instance ] [-VideoFiltersMode ] [-AllowEngagementReport ] [-AllowNDIStreaming ] [-DesignatedPresenterRoleMode ] [-AllowIPAudio ] [-AllowOrganizersToOverrideLobbySettings ] [-AllowUserToJoinExternalMeeting ] [-EnrollUserOverride ] [-StreamingAttendeeMode ] [-AllowMeetingReactions ] [-Force] [-WhatIf] [-Confirm] [] +[-AllowBreakoutRooms ] [-TeamsCameraFarEndPTZMode ] [-AllowMeetingReactions ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -536,7 +536,7 @@ 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. +Note: This parameter is temporarily disabled. ```yaml Type: Boolean diff --git a/skype/skype-ps/skype/Set-CsTenantDialPlan.md b/skype/skype-ps/skype/Set-CsTenantDialPlan.md index f2bd8c8c8f..c2c9c5b268 100644 --- a/skype/skype-ps/skype/Set-CsTenantDialPlan.md +++ b/skype/skype-ps/skype/Set-CsTenantDialPlan.md @@ -51,12 +51,12 @@ This example updates the vt1tenantDialPlan9 tenant dial plan to use an external ### -------------------------- Example 2 -------------------------- ``` -$nr2 = Get-CsVoiceNormalizationRule -Identity Global/NR2 +$nr2 = Get-CsVoiceNormalizationRule -Identity "US/US Long Distance" Set-CsTenantDialPlan -ExternalAccessPrefix "123" -Identity vt1tenantDialPlan9 -NormalizationRules @{Add=$nr2} ``` -This example updates the vt1tenantDialPlan9 tenant dial plan to have an external access prefix of 123 and use the Global/NR2 normalization rules. +This example updates the vt1tenantDialPlan9 tenant dial plan to have an external access prefix of 123 and use the US/US Long Distance normalization rules. ## PARAMETERS @@ -79,7 +79,7 @@ Accept wildcard characters: False ### -Description The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to or any other information that helps to identify the purpose of the tenant dial plan. -Maximum characters is 512. +Maximum characters is 1040. ```yaml Type: String @@ -99,8 +99,7 @@ The ExternalAccessPrefix parameter is a number (or set of numbers) that designat (For example, to tenant-dial an outside line, first dial 9). This prefix is ignored by the normalization rules, although these rules will be applied to the rest of the number. The OptimizeDeviceDialing parameter must be set to True for this value to take effect. -The value of this parameter must match the regular expression \[0-9\]{1,4}. -This means it must be a value one to four digits in length, with each digit being a number 0 through 9. +The value of this parameter must be no longer than 4 characters long and can contain only digits, "#" or a "*". ```yaml Type: String @@ -134,10 +133,7 @@ Accept wildcard characters: False ``` ### -Identity -The Identity parameter is a unique identifier that designates the scope, or for per-user plans a name, to identify the tenant dial plan to modify. -For example, a site Identity is in the format site:\, where sitename is the name of the site. -A tenant dial plan at the service scope is a Registrar or PSTN gateway service, where the Identity value is formatted in this way: Registrar:Redmond.litwareinc.com. -A per-user Identity is a unique string value. +The Identity parameter is a unique identifier that designates the name of the tenant dial plan to modify. ```yaml Type: XdsIdentity @@ -207,9 +203,9 @@ Accept wildcard characters: False ### -SimpleName The SimpleName parameter is a display name for the tenant dial plan. -This name must be unique among all tenant dial plans within the Skype for Business Server deployment. +This name must be unique among all tenant dial plans. -This string can be up to 256 characters long. +This string can be up to 49 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.) and parentheses (()). ```yaml diff --git a/spmt/docs-conceptual/index.md b/spmt/docs-conceptual/index.md index d670842917..95cd6817d6 100644 --- a/spmt/docs-conceptual/index.md +++ b/spmt/docs-conceptual/index.md @@ -1,12 +1,13 @@ --- localization_priority: Normal -title: Microsoft SharePoint Migration Tool cmdlet reference +title: Microsoft SharePoint Migration Tool cmdlet help reference +description: "Learn about the Microsoft SharePoint Migration Tool PowerShell cmdlet help reference." --- -# Microsoft SharePoint Migration Tool cmdlet reference +# Microsoft SharePoint Migration Tool cmdlet help reference -Welcome to the Microsoft SharePoint Migration Tool PowerShell cmdlet help references. The Microsoft SharePoint Migration Tool cmdlets provide the command line interface for service administration and management. +Welcome to the Microsoft SharePoint Migration Tool PowerShell cmdlet **Help** reference. The Microsoft SharePoint Migration Tool cmdlets provide the command line interface for service administration and management. -Here you will find all of the Microsoft SharePoint Migration Tool PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. +Here, you will find all of the Microsoft SharePoint Migration Tool PowerShell **Help** topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content, go to the source GitHub repo and look through the README. -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. \ No newline at end of file +The repo is located here: and you can find the README displayed at the bottom of the page. diff --git a/staffhub/docs-conceptual/index.md b/staffhub/docs-conceptual/index.md index 5f8e698ed3..c6b00b20ca 100644 --- a/staffhub/docs-conceptual/index.md +++ b/staffhub/docs-conceptual/index.md @@ -1,15 +1,16 @@ --- -title: Microsoft StaffHub cmdlet reference +title: Microsoft StaffHub cmdlet help reference +description: "Learn about the Microsoft StaffHub PowerShell cmdlet help reference." --- -# Microsoft StaffHub cmdlet reference +# Microsoft StaffHub cmdlet help reference -Welcome to the Microsoft StaffHub cmdlet help references. The Microsoft StaffHub cmdlets provide the command line interface for service administration and management. +Welcome to the Microsoft StaffHub cmdlet **Help** reference. The Microsoft StaffHub cmdlets provide the command line interface for service administration and management. -Here you will find all of the Microsoft StaffHub PowerShell help topics. The reference documentation can be found here: https://docs.microsoft.com/powershell/module/staffhub/?view=staffhub-ps +Here, you will find all of the Microsoft StaffHub PowerShell **Help** topics. The reference documentation can be found here: -Instructions on installing the StaffHub cmdlet module can be found here: https://www.powershellgallery.com/packages/MicrosoftStaffHub/1.0.0-alpha +Instructions on installing the StaffHub cmdlet module can be found here: . -These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. +These **Help** topics are 'open source' and open for contributions. If you are interested in contributing to this content, go to the source GitHub repo and look through the README. -The repo is located here: https://github.com/MicrosoftDocs/office-docs-powershell and you can find the README displayed at the bottom of the page. +The repo is located here: and you can find the README displayed at the bottom of the page. diff --git a/teams/docs-conceptual/index.md b/teams/docs-conceptual/index.md index 7e37d40427..a2db3f509b 100644 --- a/teams/docs-conceptual/index.md +++ b/teams/docs-conceptual/index.md @@ -1,14 +1,15 @@ --- localization_priority: Normal -title: Microsoft Teams cmdlet reference +title: Microsoft Teams cmdlet help reference +description: "Learn about the Microsoft Teams PowerShell cmdlet help reference." --- -# Microsoft Teams cmdlet reference +# Microsoft Teams cmdlet help reference -Welcome to the Microsoft Teams PowerShell cmdlet help references. Cmdlets for managing Microsoft Teams service are split between two powershell modules: the Skype for Business Online module and the Microsoft Teams module. +Welcome to the Microsoft Teams PowerShell cmdlet **Help** reference. Cmdlets for managing Microsoft Teams service are split between two powershell modules: the Skype for Business Online and the Microsoft Teams. -This powershell module is used for provisioning and management of teams and their backing groups themselves. The module can be installed here: https://www.powershellgallery.com/packages/MicrosoftTeams/ . To manage the policies and configurations that apply to the Microsoft Teams service, please see the reference docs for the Skype for Business module: https://docs.microsoft.com/powershell/module/skype/?view=skype-ps +This PowerShell module is used for provisioning and management of teams and their backing groups themselves. The module can be installed here: . To manage the policies and configurations that apply to the Microsoft Teams service, please see the reference documents for the Skype for Business module: . -Here you will find all of the Microsoft Teams PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README. +Here, you will find all of the Microsoft Teams PowerShell **Help** topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content, go to the source GitHub repo and look through the README. -The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page. +The repo is located here: and you can find the README displayed at the bottom of the page. diff --git a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md index 2358fc0850..cd0e9b35ad 100644 --- a/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/teams/Get-CsBatchPolicyAssignmentOperation.md @@ -16,8 +16,18 @@ This cmdlet is used to retrieve the status of batch policy assignment operations ## SYNTAX +### Get (Default) ``` -Get-CsBatchPolicyAssignmentOperation [-OperationId ] +Get-CsBatchPolicyAssignmentOperation [-Status ] [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] +``` + +### Get1 +``` +Get-CsBatchPolicyAssignmentOperation -Identity [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [] ``` ## DESCRIPTION @@ -25,12 +35,12 @@ This cmdlets returns the status of all batch policy assignment operations for th ## EXAMPLES -### Example 1 -In this example, the status of all batch assignment operations is returned. - -``` +### EXAMPLE 1 +```powershell Get-CsBatchPolicyAssignmentOperation +``` +```output OperationId OperationName OverallStatus CreatedTime CreatedBy ----------- ------------- ------------- ----------- --------- e640a5c9-c74f-4df7-b62e-4b01ae878bdc Assigning Kiosk mtg Completed 1/30/2020 3:21:07 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 @@ -38,12 +48,14 @@ e640a5c9-c74f-4df7-b62e-4b01ae878bdc Assigning Kiosk mtg Completed 1/30/ 47bbc636-365d-4441-af34-9e0eceb05ef1 Completed 1/30/2020 4:14:22 PM aeb7c0e7-2f6d-43ef-bf33-bfbcb93fdc64 ``` -### Example 2 -In this example, the details of a specific operation are returned. +In this example, the status of all batch assignment operations is returned. -``` +### EXAMPLE 2 +```powershell Get-CsBatchPolicyAssignmentOperation -OperationId 01b9b2b7-5dbb-487c-b4ea-887c7c66559c | fl +``` +```output OperationId : 01b9b2b7-5dbb-487c-b4ea-887c7c66559c OperationName : Assigning allow calling OverallStatus : Completed @@ -58,12 +70,14 @@ UserState : {f0d9c148-27c1-46f5-9685-544d20170ea1, cc05e18d-5fc0-4096-8461 bcff5b7e-8d3c-4721-b34a-63552a6a53f9} ``` -### Example 3 -In this example, the UserState property is expanded to see the status of each user in the batch. In this example, one of the users was not found. +In this example, the details of a specific operation are returned. -``` +### EXAMPLE 3 +```powershell Get-CsBatchPolicyAssignmentOperation -OperationId 001141c3-1daa-4da1-88e9-66cc01c511e1 | Select -ExpandProperty UserState +``` +```output Id Result State -- ------ ----- f0d9c148-27c1-46f5-9685-544d20170ea1 Success Completed @@ -71,14 +85,106 @@ cc05e18d-5fc0-4096-8461-ded64d7356e0 Success Completed bcff5b7e-8d3c-4721-b34a-63552a6a53f9 User not found Completed ``` +In this example, the UserState property is expanded to see the status of each user in the batch. In this example, one of the users was not found. + ## PARAMETERS -### -OperationId +### -Identity The ID of a batch policy assignment operation. ```yaml Type: String -Parameter Sets: +Parameter Sets: Get1 +Aliases: OperationId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Option filter + +```yaml +Type: String +Parameter Sets: Get +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) Aliases: Required: False @@ -87,6 +193,22 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md b/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md index 1575676cf4..252c7b15d1 100644 --- a/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md +++ b/teams/teams-ps/teams/Get-CsUserPolicyAssignment.md @@ -12,8 +12,6 @@ ms.reviewer: ## SYNOPSIS -**Note:** This cmdlet is currently in public preview. - This cmdlet is used to return the policy assignments for a user, both directly assigned and inherited from a group. ## SYNTAX diff --git a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md b/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md index 2493c130e5..9e53a4165c 100644 --- a/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md +++ b/teams/teams-ps/teams/New-CsBatchPolicyAssignmentOperation.md @@ -17,7 +17,10 @@ This cmdlet is used to assign or unassign a policy to a batch of users. ## SYNTAX ``` -New-CsBatchPolicyAssignmentOperation -PolicyType -PolicyName -Identity [-OperationName ] +New-CsBatchPolicyAssignmentOperation [-OperationName ] -Identity -PolicyType + [-AdditionalParameters ] [-PolicyName ] [-Break] [-HttpPipelineAppend ] + [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] + [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -34,39 +37,39 @@ CallingLineIdentity, ExternalAccessPolicy, OnlineVoiceRoutingPolicy, TeamsAppSet ## EXAMPLES -### Example 1 -In this example, the batch of users is specified as an array of user SIP addresses. - +### EXAMPLE 1 ``` $users_ids = @("psmith@contoso.com","tsanchez@contoso.com","bharvest@contoso.com") New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users_ids -OperationName "Batch assign Kiosk" ``` -### Example 2 -In this example, a policy is removed from a batch of users by passing $null as the policy name. +In this example, the batch of users is specified as an array of user SIP addresses. +### EXAMPLE 2 ``` $users_ids = @("2bdb15a9-2cf1-4b27-b2d5-fcc1d13eebc9", "d928e0fc-c957-4685-991b-c9e55a3534c7", "967cc9e4-4139-4057-9b84-1af80f4856fc") New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName $null -Identity $users_ids -OperationName "Batch unassign meeting policy" ``` -### Example 3 -In this example, the batch of users is read from a text file containing user object IDs (guids). +In this example, a policy is removed from a batch of users by passing $null as the policy name. +### EXAMPLE 3 ``` $users_ids = Get-Content .\users_ids.txt New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users_ids -OperationName "Batch assign Kiosk" ``` -### Example 4 -In this example, the batch of users is obtained by connecting to Azure AD and retrieving a collection of users and then referencing the SipProxyAddress property. +In this example, the batch of users is read from a text file containing user object IDs (guids). +### EXAMPLE 4 ``` Connect-AzureAD $users = Get-AzureADUser New-CsBatchPolicyAssignmentOperation -PolicyType TeamsMeetingPolicy -PolicyName Kiosk -Identity $users.SipProxyAddress -OperationName "batch assign kiosk" ``` +In this example, the batch of users is obtained by connecting to Azure AD and retrieving a collection of users and then referencing the SipProxyAddress property. + ## PARAMETERS ### -Identity @@ -129,6 +132,111 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AdditionalParameters +. + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Break +Wait for .NET debugger to attach + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelineAppend +SendAsync Pipeline Steps to be appended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HttpPipelinePrepend +SendAsync Pipeline Steps to be prepended to the front of the pipeline + +```yaml +Type: SendAsyncStep[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Proxy +The URI for the proxy server to use + +```yaml +Type: Uri +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyCredential +Credentials for a proxy server to use for the remote call + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProxyUseDefaultCredentials +Use the default credentials for the proxy + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md b/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md index fc42a43a5c..91d5ea05a0 100644 --- a/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md +++ b/teams/teams-ps/teams/New-CsGroupPolicyAssignment.md @@ -27,12 +27,12 @@ The group policy assignment rank is set at the time a policy is being assigned t It's helpful to think of rank as determining the position of each policy assignment in an ordered list, from highest rank to lowest rank. In fact, rank can be specified as any number, but these are converted into sequential values 1, 2, 3, etc. with 1 being the highest rank. When assigning a policy to a group, set the rank to be the position in the list where you want the new group policy assignment to be. If a rank is not specified, the policy assignment will be given the lowest rank, corresponding to the end of the list. -Group policy assignment allows you to easily manage policies across different subsets of users within your organization. Group policy assignment is recommended for groups of up to 50000 users, but it will also work with larger groups. +Group policy assignment allows you to easily manage policies across different subsets of users within your organization. Group policy assignment is recommended for groups of up to 50000 users, but it will also work with larger groups up to 100000 users. Segment your users into smaller groups, or make use of default policies for the majority of users with the most common policies and only use groups for those users that require other policies. Group policy assignments are only propagated to users that are direct members of the group; the assignments are not propagated to members of nested groups. Group policy assignment is currently limited to the following policy types: -CallingLineIdentity (Caller ID policies), OnlineVoiceRoutingPolicy (Voice Routing policies), TeamsAppSetupPolicy (App Setup policies), TeamsCallingPolicy (Calling policies), TeamsCallParkPolicy (Call park policies), TeamsChannelsPolicy, TeamsComplianceRecordingPolicy, TenantDialPlan, TeamsEducationAssignmentsAppPolicy, TeamsMeetingBroadcastPolicy (Live Events policies), TeamsMeetingPolicy (Meeting policies), TeamsMessagingPolicy (Messaging policies), TeamsShiftsPolicy, TeamsUpdateManagementPolicy. +CallingLineIdentity (Caller ID policies), TeamsAppSetupPolicy (App Setup policies), TeamsCallingPolicy (Calling policies), TeamsCallParkPolicy (Call park policies), TeamsChannelsPolicy, TeamsComplianceRecordingPolicy, TenantDialPlan, TeamsEducationAssignmentsAppPolicy, TeamsMeetingBroadcastPolicy (Live Events policies), TeamsMeetingPolicy (Meeting policies), TeamsMessagingPolicy (Messaging policies), TeamsShiftsPolicy, TeamsUpdateManagementPolicy. ## EXAMPLES @@ -104,6 +104,20 @@ Accept wildcard characters: False ### -PolicyType The type of the policy to be assigned. +Possible values: +- CallingLineIdentity +- TeamsAppSetupPolicy +- TeamsCallingPolicy +- TeamsCallParkPolicy +- TeamsChannelsPolicy +- TeamsComplianceRecordingPolicy +- TenantDialPlan +- TeamsEducationAssignmentsAppPolicy +- TeamsMeetingBroadcastPolicy +- TeamsMeetingPolicy +- TeamsMessagingPolicy +- TeamsShiftsPolicy +- TeamsUpdateManagementPolicy ```yaml Type: String diff --git a/teams/teams-ps/teams/teams.md b/teams/teams-ps/teams/teams.md index e9ac209432..a3f14a2b16 100644 --- a/teams/teams-ps/teams/teams.md +++ b/teams/teams-ps/teams/teams.md @@ -59,6 +59,9 @@ The following cmdlet references are for Microsoft Teams. ### [Grant-TeamsShiftsPolicy](Grant-TeamsShiftsPolicy.md) {{Manually Enter Grant-TeamsShiftsPolicy Description Here}} +### [New-CsOnlineSession](https://docs.microsoft.com/powershell/module/skype/new-csonlinesession?view=skype-ps) +{{Manually Enter New-Team Description Here}} + ### [New-Team](New-Team.md) {{Manually Enter New-Team Description Here}}