Set-ClientAccessRule

Модуль:
Exchange PowerShell

Примечание.

В сентябре 2025 года правила клиентского доступа были исключены из рекомендаций для всех организаций Exchange Online. Дополнительные сведения см. в статье Обновление устаревания правил клиентского доступа в Exchange Online.

Этот командлет работает только в Exchange Server 2019 или более поздней версии.

Командлет Set-ClientAccessRule используется для изменения существующих правил клиентского доступа. Правила клиентского доступа помогают управлять доступом к организации на основе свойств подключения.

Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.

Синтаксис

Default (По умолчанию) 

Set-ClientAccessRule
    [-Identity] <ClientAccessRuleIdParameter>
    [-Action <ClientAccessRulesAction>]
    [-AnyOfAuthenticationTypes <MultiValuedProperty>]
    [-AnyOfClientIPAddressesOrRanges <MultiValuedProperty>]
    [-AnyOfProtocols <MultiValuedProperty>]
    [-AnyOfSourceTcpPortNumbers <MultiValuedProperty>]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-Enabled <Boolean>]
    [-ExceptAnyOfAuthenticationTypes <MultiValuedProperty>]
    [-ExceptAnyOfClientIPAddressesOrRanges <MultiValuedProperty>]
    [-ExceptAnyOfProtocols <MultiValuedProperty>]
    [-ExceptAnyOfSourceTcpPortNumbers <MultiValuedProperty>]
    [-ExceptUserIsMemberOf <MultiValuedProperty>]
    [-ExceptUsernameMatchesAnyOfPatterns <MultiValuedProperty>]
    [-Name <String>]
    [-Priority <Int32>]
    [-Scope <ClientAccessRulesScope>]
    [-UserIsMemberOf <MultiValuedProperty>]
    [-UsernameMatchesAnyOfPatterns <MultiValuedProperty>]
    [-UserRecipientFilter <String>]
    [-WhatIf]
    [<CommonParameters>]

Описание

Правила клиентского доступа похожи на правила потока обработки почты (также известные как правила транспорта) для клиентских подключений к вашей организации. Вы используете условия и исключения для идентификации соединений на основе их свойств и действий, которые разрешают или блокируют подключения.

Примечание. Не все протоколы поддерживают фильтры типов проверки подлинности, и даже протоколы, поддерживающие фильтры типов проверки подлинности, поддерживают не все типы проверки подлинности. Поддерживаемые комбинации описаны в следующих списках. Соблюдайте осторожность при объединении протоколов и типов проверки подлинности в одном правиле.

Протоколы, поддерживающие фильтры типов проверки подлинности:

  • ExchangeActiveSync: BasicAuthentication, OAuthAuthentication и CertificateBasedAuthentication.
  • ExchangeAdminCenter: BasicAuthentication и AdfsAuthentication.
  • IMAP4: BasicAuthentication и OAuthAuthentication.
  • OutlookWebApp: BasicAuthentication и AdfsAuthentication.
  • POP3: BasicAuthentication и OAuthAuthentication.
  • RemotePowerShell: BasicAuthentication и NonBasicAuthentication.

Протоколы, не поддерживающие фильтры типов проверки подлинности:

  • ExchangeWebServices
  • OfflineAddressBook
  • OutlookAnywhere
  • PowerShellWebServices
  • REST
  • UniversalOutlook

Для его запуска необходимо получить соответствующие разрешения. Хотя в этой статье перечислены все параметры командлета, у вас может не быть доступа к некоторым параметрам, если они не включены в назначенные вам разрешения. Сведения о необходимых разрешениях для запуска командлетов и использования параметров в организации см. в статье Find the permissions required to run any Exchange cmdlet.

Примеры

Пример 1

Set-ClientAccessRule "Allow IMAP4" -AnyOfClientIPAddressesOrRanges @{Add="172.17.17.27/16"}

В этом примере к существующему правилу клиентского доступа с именем "Allow IMAP4" добавляется диапазон IP-адресов 172.17.17.27/16, при этом существующие значения IP-адресов остаются без изменений.

Параметры

-Action

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр Action указывает действие для правила клиентского доступа. Допустимые значения этого параметра — AllowAccess и DenyAccess.

Свойства параметров

Тип:ClientAccessRulesAction
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-AnyOfAuthenticationTypes

Применимо: Exchange Server 2013 и Exchange Server 2016

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-AnyOfClientIPAddressesOrRanges

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр AnyOfClientIPAddressesOrRanges определяет условие для правила доступа клиента, основанное на IPv4 или IPv6-адресе клиента. Допустимые значения:

  • Один IP-адрес: например, 192.168.1.1 или 2001:DB8::2AA:FF:C0A8:640A.
  • Диапазон IP-адресов: например, 192.168.0.1-192.168.0.254 или 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414.
  • Диапазон IP-адресов CIDR: например, 192.168.3.1/24 или 2001:DB8::2AA:FF:C0A8:640A/64.

Чтобы ввести несколько значений и перезаписать существующие записи, используйте следующий синтаксис: Value1,Value2,...ValueN. Если значения содержат пробелы или по каким-либо другим причинам требуют применения кавычек, используйте следующий синтаксис: "Value1","Value2",..."ValueN".

Чтобы добавлять или удалять значения, не затрагивая имеющиеся записи, используйте следующий синтаксис: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

Дополнительные сведения об IPv6-адресах и их синтаксисе см. в статье Exchange 2013: IPv6-адреса.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-AnyOfProtocols

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр AnyOfProtocols указывает условие для правила клиентского доступа, основанное на протоколе клиента.

Параметр PasswordQuality указывает минимальную оценку качества для паролей устройства. Качество пароля — это числовая шкала, указывающая уровень безопасности и сложности пароля. Более высокое качество означает более надежный пароль.

  • ExchangeActiveSync
  • ExchangeAdminCenter
  • ExchangeWebServices
  • IMAP4
  • OfflineAddressBook
  • OutlookAnywhere
  • OutlookWebApp
  • POP3
  • PowerShellWebServices
  • RemotePowerShell
  • REST
  • UniversalOutlook (почта и приложение Calendar)

Примечание. В Exchange 2019 поддерживаются только ExchangeAdminCenter и RemotePowerShell.

Чтобы ввести несколько значений и перезаписать существующие записи, используйте следующий синтаксис: Value1,Value2,...ValueN. Если значения содержат пробелы или по каким-либо другим причинам требуют применения кавычек, используйте следующий синтаксис: "Value1","Value2",..."ValueN".

Чтобы добавлять или удалять значения, не затрагивая имеющиеся записи, используйте следующий синтаксис: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-AnyOfSourceTcpPortNumbers

Применимо: Exchange Server 2013

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Confirm

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Переключатель подтверждения указывает, показывать или скрывать запрос подтверждения. То, как этот переключатель влияет на командлет, зависит от того, требует ли командлет подтверждения перед продолжением.

  • Деструктивные командлеты (например, командлеты Remove-) имеют встроенную паузу, которая заставляет вас подтвердить команду перед продолжением. Можно пропускать запросы на подтверждение этих командлетов, используя следующий синтаксис: -Confirm:$false.
  • Большинство других командлетов (например, командлеты New- и Set-) не имеют встроенной паузы. Для этих командлетов указание параметра Confirm без значения приводит к паузе, которая вынуждает вас подтвердить команду перед продолжением.

Этот командлет имеет встроенную паузу, поэтому используйте -Confirm:$false его, чтобы пропустить подтверждение.

Свойства параметров

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:cf

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DomainController

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, dc01.contoso.com.

Свойства параметров

Тип:Fqdn
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Enabled

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр Enabled показывает, включено или нет правило клиентского доступа. Для этого параметра допускаются значения $true и $false.

Свойства параметров

Тип:Boolean
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ExceptAnyOfAuthenticationTypes

Применимо: Exchange Server 2013 и Exchange Server 2016

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ExceptAnyOfClientIPAddressesOrRanges

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр ExceptAnyOfClientIPAddressesOrRanges указывает исключение для правила доступа клиента, основанное на IPv4 или IPv6-адресе клиента. Допустимые значения:

  • Один IP-адрес: например, 192.168.1.1 или 2001:DB8::2AA:FF:C0A8:640A.
  • Диапазон IP-адресов: например, 192.168.0.1-192.168.0.254 или 2001:DB8::2AA:FF:C0A8:640A-2001:DB8::2AA:FF:C0A8:6414.
  • Диапазон IP-адресов CIDR: например, 192.168.3.1/24 или 2001:DB8::2AA:FF:C0A8:640A/64.

Чтобы ввести несколько значений и перезаписать существующие записи, используйте следующий синтаксис: Value1,Value2,...ValueN. Если значения содержат пробелы или по каким-либо другим причинам требуют применения кавычек, используйте следующий синтаксис: "Value1","Value2",..."ValueN".

Чтобы добавлять или удалять значения, не затрагивая имеющиеся записи, используйте следующий синтаксис: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

Дополнительные сведения об IPv6-адресах и их синтаксисе см. в статье Exchange 2013: IPv6-адреса.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ExceptAnyOfProtocols

Применимо: Exchange Server 2013 и Exchange Server 2016

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ExceptAnyOfSourceTcpPortNumbers

Применимо: Exchange Server 2013

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ExceptUserIsMemberOf

Применимо: Exchange Server 2013

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ExceptUsernameMatchesAnyOfPatterns

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр ExceptUsernameMatchesAnyOfPatterns указывает исключение для правила клиентского доступа, основанное на имени учетной записи пользователя в формате <Domain>\<UserName> (например, contoso.com\jeff). Этот параметр принимает текст и подстановочный знак (*) (например, *jeff*, но не jeff*). Escape-символы требуются только для последовательностей букв и цифр.

Чтобы ввести несколько значений и перезаписать существующие записи, используйте следующий синтаксис: Value1,Value2,...ValueN. Если значения содержат пробелы или по каким-либо другим причинам требуют применения кавычек, используйте следующий синтаксис: "Value1","Value2",..."ValueN".

Чтобы добавлять или удалять значения, не затрагивая имеющиеся записи, используйте следующий синтаксис: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Identity

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр Identity указывает на изменяемое правило клиентского доступа. Можно использовать любое значение, уникальным образом идентифицирующее правило клиентского доступа. Например:

  • имя;
  • различающееся имя (DN);
  • GUID

Свойства параметров

Тип:ClientAccessRuleIdParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:1
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-Name

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр Name указывает уникальное имя для правила клиентского доступа.

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Priority

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр Priority указывает приоритет для правила клиентского доступа. Меньшее целочисленное значение означает более высокий приоритет, а правило с высоким приоритетом имеет преимущество над правилом с меньшим приоритетом. Значение по умолчанию равно 1.

Свойства параметров

Тип:Int32
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Scope

Применимо: Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр Scope определяет область действия правила клиентского доступа. Допустимые значения:

  • Users. Правило применяется только к подключениям пользователей.
  • All. Правило применяется ко всем подключениям (как от пользователей, так и от приложений среднего уровня).

Свойства параметров

Тип:ClientAccessRulesScope
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-UserIsMemberOf

Применимо: Exchange Server 2013

Этот параметр зарезервирован для внутреннего использования корпорацией Майкрософт.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-UsernameMatchesAnyOfPatterns

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр UsernameMatchesAnyOfPatterns задает условие для правила доступа клиентов, основанное на имени учетной записи пользователя в формате <Domain>\<UserName> (например, contoso.com\jeff). Этот параметр принимает текст и подстановочный знак (*) (например, *jeff*, но не jeff*). Escape-символы требуются только для последовательностей букв и цифр.

Чтобы ввести несколько значений и перезаписать существующие записи, используйте следующий синтаксис: Value1,Value2,...ValueN. Если значения содержат пробелы или по каким-либо другим причинам требуют применения кавычек, используйте следующий синтаксис: "Value1","Value2",..."ValueN".

Чтобы добавлять или удалять значения, не затрагивая имеющиеся записи, используйте следующий синтаксис: @{Add="Value1","Value2"...; Remove="Value3","Value4"...}.

Свойства параметров

Тип:MultiValuedProperty
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-UserRecipientFilter

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Параметр UserRecipientFilter задает условие для правила доступа к клиенту, использующего синтаксис фильтра OPATH для идентификации пользователя на основе ограниченного набора свойств получателя. Правила клиентского доступа не поддерживают полный список доступных свойств получателей.

С этим параметром можно использовать следующие свойства:

  • Город
  • Company
  • CountryOrRegion (Код страны по ISO 3166-1 alpha-2.)
  • CustomAttribute1–CustomAttribute15
  • Отдел
  • Кабинет
  • PostalCode
  • StateOrProvince
  • StreetAddress

Основной синтаксис этого параметра выглядит следующим образом "Property -ComparisonOperator 'Value'":

  • Свойство — это одно из фильтруемых свойств в списке выше (например, City или CustomAttribute1).
  • ComparisonOperator — это оператор сравнения OPATH (например -eq , для равенства и -like для строкового сравнения). Подробнее об операторах сравнения см. в статье about_Comparison_Operators.
  • Value — это значение свойства для поиска. Заключите текстовые значения и переменные в одиночные кавычки ('Value' или '$Variable'). Если значение переменной содержит одиночные кавычки, необходимо определить (избежать) одиночные кавычки, чтобы правильно развернуть переменную. Например, вместо '$User' используйте '$($User -Replace "'","''")'. Не заключайте целые числа или системные значения в кавычки (например, используйте 500, $true, $false, или $null вместо них).
  • Заключите весь фильтр OPATH в двойные кавычки " ". Если фильтр содержит системные значения (например, $true, $false или $null), используйте одиночные кавычки ' '. Хотя этот параметр является строкой (а не системным блоком), вы также можете использовать фигурные скобки { }, но только если фильтр не содержит переменные.

Например, вы можете:

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

Вы можете объединить несколько условий поиска в цепочку с помощью логических операторов -and и -or. Например, вы можете:

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

Подробные сведения о синтаксисе фильтра OPATH в Exchange см. в разделе "Дополнительные сведения о синтаксисе OPATH".

Свойства параметров

Тип:String
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-WhatIf

Применимо: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Переключатель WhatIf показывает, что команда делает без каких-либо изменений. С этим параметром не нужно указывать значение.

Свойства параметров

Тип:SwitchParameter
Значение по умолчанию:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:wi

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в статье about_CommonParameters.

Входные данные

Input types

Чтобы просмотреть типы входных данных, которые принимает этот командлет, см. Типы входных и выходных данных командлета. Если поле "Типы входных данных" для командлета пусто, командлет не принимает входные данные.

Выходные данные

Output types

Чтобы просмотреть типы возвращаемых данных, также называемые типами вывода, которые принимает этот командлет, см. раздел Типы ввода и вывода командлета. Если поле "Типы выходных данных" пусто, командлет не возвращает данные.