Get-SecurityPrincipal

Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и настройки могут отличаться в зависимости от среды.

Командлет Get-SecurityPrincipal возвращает список участников безопасности. Участники безопасности — это объекты, такие как пользователи или группы безопасности, которым могут быть назначены разрешения и права пользователей.

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

Синтаксис

Get-SecurityPrincipal
   [[-Identity] <ExtendedSecurityPrincipalIdParameter>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IncludeDomainLocalFrom <SmtpDomain>]
   [-OrganizationalUnit <ExtendedOrganizationalUnitIdParameter>]
   [-ResultSize <Unlimited>]
   [-RoleGroupAssignable]
   [-Types <MultiValuedProperty>]
   [<CommonParameters>]

Описание

Командлет Get-SecurityPrincipal используется Центром администрирования Exchange для заполнения полей, отображающих сведения о получателе.

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

Примеры

Пример 1

Get-SecurityPrincipal -OrganizationalUnit OU=People,DC=Contoso,DC=com

В этом примере возвращается список субъектов безопасности из подразделения People.

Пример 2

Get-SecurityPrincipal -Filter "Department -eq 'Legal'"

В этом примере показано, как извлечь участников безопасности из юридического отдела с помощью параметра Filter. Извлекаются только участники безопасности, соответствующие условиям фильтра.

Пример 3

Get-SecurityPrincipal -Identity Administrator

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

Пример 4

Get-SecurityPrincipal -Types WellKnownSecurityPrincipal | Format-Table Name,SID -AutoSize

В этом примере возвращается список известных субъектов безопасности, при этом в результатах отображаются только свойства Name и SID.

Параметры

-DomainController

Этот параметр доступен только в локальной среде Exchange.

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

Type:Fqdn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Filter

Параметр Filter использует синтаксис OPATH для фильтрации результатов по указанным свойствам и значениям. Для критериев поиска используется следующий синтаксис: "Property -ComparisonOperator 'Value'".

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

Можно связать несколько условий поиска вместе с помощью логических операторов -and и -or. Например, "Criteria1 -and Criteria2" или "(Criteria1 -and Criteria2) -or Criteria3".

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-Identity

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

Type:ExtendedSecurityPrincipalIdParameter
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-IncludeDomainLocalFrom

Этот параметр доступен только в локальной среде Exchange.

Параметр IncludeDomainLocalFrom указывает, следует ли возвращать локальные группы домена из полного доменного имени указанного домена Active Directory (например, contoso.com) в результатах.

Этот параметр не следует использовать с параметром Filter или Identity.

Type:SmtpDomain
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-OrganizationalUnit

Параметр OrganizationalUnit фильтрует результаты по расположению объекта в Active Directory. Возвращаются только те объекты, которые существуют в указанном расположении. Допустимые значения для этого параметра — подразделение или домен, которые возвращаются с помощью командлета Get-OrganizationalUnit. Вы можете использовать любое значение, уникальным образом определяющее подразделение или домен. Пример:

  • Имя
  • Имя
  • различающееся имя (DN);
  • GUID
Type:ExtendedOrganizationalUnitIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-ResultSize

Параметр ResultSize указывает максимальное число возвращаемых результатов. Если требуется возвратить все результаты, отвечающие условиям запроса, используйте для этого параметра значение unlimited. Значение по умолчанию — 1000.

Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-RoleGroupAssignable

Параметр RoleGroupAssignable фильтрует субъектов безопасности, возвращая только те объекты, которые можно назначить группе ролей RBAC. Указывать значение для этого параметра необязательно.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-Types

Параметр Types фильтрует результаты по типам объектов. Допустимые значения:

  • Компьютер
  • GlobalSecurityGroup
  • Группа
  • UniversalSecurityGroup
  • User
  • WellknownSecurityPrincipal

Вы можете указать несколько значений, разделив их запятыми.

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

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

Input types

Сведения о типах входных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип ввода для командлета пустое, командлет не принимает входные данные.

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

Output types

Сведения о типах возвращаемых данных, которые также называются типами выходных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип вывода пусто, командлет не возвращает данные.