New-ClientAccessRule

The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess.

This parameter is functional only in the cloud-based service.

The AnyOfAuthenticationTypes parameter specifies a condition for the client access rule that's based on the client's authentication type.

Valid values for this parameter are:

• AdfsAuthentication
• BasicAuthentication
• CertificateBasedAuthentication
• NonBasicAuthentication
• OAuthAuthentication

You can enter multiple values separated by commas. Don't use quotation marks.

Note: Refer to the Description section to see which authentication types can be used with what protocols.

The AnyOfClientIPAddressesOrRanges parameter specifies a condition for the client access rule that's based on the client's IPv4 or IPv6 address. Valid values are:

• Single IP address: For example, 192.168.1.1 or 2001:DB8::2AA:FF:C0A8:640A.
• IP address range: For example, 192.168.0.1-192.168.0.254 or 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414.
• Classless Inter-Domain Routing (CIDR) IP address range: For example, 192.168.3.1/24 or 2001:DB8::2AA:FF:C0A8:640A/64.

You can enter multiple values separated by commas.

For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: IPv6 address basics.

The AnyOfProtocols parameter specifies a condition for the client access rule that's based on the client's protocol.

Valid values for this parameter are:

• ExchangeActiveSync
• ExchangeAdminCenter
• ExchangeWebServices
• IMAP4
• OfflineAddressBook
• OutlookAnywhere
• OutlookWebApp
• POP3
• PowerShellWebServices
• RemotePowerShell
• REST
• UniversalOutlook (Mail and Calendar app)

Note: In Exchange 2019, the only supported values are ExchangeAdminCenter and RemotePowerShell.

You can enter multiple values separated by commas. Don't use quotation marks.

This parameter is reserved for internal Microsoft use.

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

• Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
• Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

This cmdlet has a built-in pause, so use -Confirm:$false to skip the confirmation.

This parameter is available only in on-premises Exchange.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

The Enabled parameter specifies whether the client access rule is enabled or disabled. Valid values for this parameter are $true or $false. The default value is $true.

This parameter is functional only in the cloud-based service.

The ExceptAnyOfAuthenticationTypes parameter specifies an exception for the client access rule that's based on the client's authentication type.

Valid values for this parameter are:

• AdfsAuthentication
• BasicAuthentication
• CertificateBasedAuthentication
• NonBasicAuthentication
• OAuthAuthentication

You can enter multiple values separated by commas. Don't use quotation marks.

Note: Refer to the Description section to see which authentication types can be used with what protocols.

The ExceptAnyOfClientIPAddressesOrRanges parameter specifies an exception for the client access rule that's based on the client's IPv4 or IPv6 address. Valid values are:

• Single IP address: For example, 192.168.1.1 or 2001:DB8::2AA:FF:C0A8:640A.
• IP address range: For example, 192.168.0.1-192.168.0.254 or 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414.
• Classless Inter-Domain Routing (CIDR) IP address range: For example, 192.168.3.1/24 or 2001:DB8::2AA:FF:C0A8:640A/64.

You can enter multiple values separated by commas.

For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: IPv6 address basics.

This parameter is functional only in the cloud-based service.

The ExceptAnyOfProtocols parameter specifies an exception for the client access rule that's based on the client's protocol.

Valid values for this parameter are:

• ExchangeActiveSync
• ExchangeAdminCenter
• ExchangeWebServices
• IMAP4
• OfflineAddressBook
• OutlookAnywhere
• OutlookWebApp
• POP3
• PowerShellWebServices
• RemotePowerShell
• REST
• UniversalOutlook (Mail and Calendar app)

You can enter multiple values separated by commas. Don't use quotation marks.

This parameter is reserved for internal Microsoft use.

This parameter is reserved for internal Microsoft use.

This parameter is functional only in the cloud-based service.

The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that's based on the user's account name in the format <Domain>\<UserName> (for example, contoso.com\jeff). This parameter accepts text and the wildcard character (*) (for example, *jeff*, but not jeff*). Non-alphanumeric characters don't require an escape character.

You can enter multiple values separated by commas.

The Name parameter specifies a unique name for the client access rule.

The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value.

Valid values and the default value for this parameter depend on the number of existing rules. For example, if there are 8 existing rules:

• Valid priority values for the existing 8 rules are from 0 through 7.
• Valid priority values for a new rule (the 9th rule) are from 0 through 8.
• The default value for a new rule (the 9th rule) is 8.

If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1.

The Scope parameter specifies the scope of the client access rule. Valid values are:

• Users: The rule only applies to end-user connections.
• All: The rule applies to all connections (end-users and middle-tier apps).

This parameter is reserved for internal Microsoft use.

This parameter is functional only in the cloud-based service.

The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that's based on the user's account name in the format <Domain>\<UserName> (for example, contoso.com\jeff). This parameter accepts text and the wildcard character (*) (for example, *jeff*, but not jeff*). Non-alphanumeric characters don't require an escape character. This parameter does not work with the -AnyOfProtocols UniversalOutlook parameter.

You can enter multiple values separated by commas.

This parameter is functional only in the cloud-based service.

The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPATH filter syntax to identify the user based on a limited set of recipient properties. Client Access Rules don't support the full list of available recipient properties.

You can use the following properties with this parameter:

• City
• Company
• CountryOrRegion (ISO 3166-1 alpha-2 country code.)
• CustomAttribute1 to CustomAttribute15
• Department
• Office
• PostalCode
• StateOrProvince
• StreetAddress

The basic syntax for this parameter is "Property -ComparisonOperator 'Value'":

• Property is one of the filterable properties in the list above (for example City or CustomAttribute1).
• ComparisonOperator is an OPATH comparison operator (for example -eq for equals and -like for string comparison). For more information about comparison operators, see about_Comparison_Operators.
• Value is the property value to search for. Enclose text values and variables in single quotation marks ('Value' or '$Variable'). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of '$User', use '$($User -Replace "'","''")'. Don't enclose integers or system values in quotation marks (for example, use 500, $true, $false, or $null instead).
• Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, $true, $false, or $null), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.

For example:

• "City -eq 'Redmond'"
• "CountryOrRegion -eq 'SG'".

You can chain multiple search criteria together using the logical operators -and and -or. For example:

• "CustomAttribute1 -eq 'AllowOWA' -and CountryOrRegion -eq AU'"
• "(CountryOrRegion -eq 'US' -and Department -eq 'Sales') -or Department -eq 'Research'".

For detailed information about OPATH filter syntax in Exchange, see Additional OPATH syntax information.

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.