Get-SecurityPrincipal
Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и параметры могут быть эксклюзивными для одной или другой среды.
Командлет Get-SecurityPrincipal возвращает список участников безопасности. Участники безопасности — это объекты, такие как пользователи или группы безопасности, которым могут быть назначены разрешения и права пользователей.
Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.
Синтаксис
Default (По умолчанию)
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 Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Этот параметр доступен только в локальной среде Exchange.
Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, dc01.contoso.com.
Свойства параметров
| Тип: | Fqdn |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Filter
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, соответствие требованиям безопасности &, встроенная безопасность надстройка для локальных почтовых ящиков
Параметр 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.
Свойства параметров
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Identity
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, соответствие требованиям безопасности &, встроенная безопасность надстройка для локальных почтовых ящиков
Параметр Identity определяет субъекта безопасности. Если участник безопасности указан явным образом с помощью этого параметра, дополнительные участники безопасности не возвращаются.
Внимание! Значение $null или несуществующее значение для параметра Identity возвращает все объекты, как если бы вы выполнили команду Get- без параметра Identity. Убедитесь, что все списки значений для параметра Identity являются точными и не содержат несуществующих $null значений.
Свойства параметров
| Тип: | ExtendedSecurityPrincipalIdParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 1 |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-IncludeDomainLocalFrom
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE
Этот параметр доступен только в локальной среде Exchange.
Параметр IncludeDomainLocalFrom указывает, следует ли возвращать локальные группы домена из полного доменного имени указанного домена Active Directory (например, contoso.com) в результатах.
Этот параметр не следует использовать с параметром Filter или Identity.
Свойства параметров
| Тип: | SmtpDomain |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-OrganizationalUnit
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, соответствие требованиям безопасности &, встроенная безопасность надстройка для локальных почтовых ящиков
Параметр OrganizationalUnit фильтрует результаты по расположению объекта в Active Directory. Возвращаются только те объекты, которые существуют в указанном расположении. Допустимые значения для этого параметра — подразделение или домен, которые возвращаются с помощью командлета Get-OrganizationalUnit. Вы можете использовать любое значение, уникальным образом определяющее подразделение или домен. Пример:
- Имя
- Имя
- различающееся имя (DN);
- GUID
Свойства параметров
| Тип: | ExtendedOrganizationalUnitIdParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ResultSize
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, соответствие требованиям безопасности &, встроенная безопасность надстройка для локальных почтовых ящиков
Параметр ResultSize указывает максимальное число возвращаемых результатов. Если требуется возвратить все результаты, отвечающие условиям запроса, используйте для этого параметра значение unlimited. Значение по умолчанию — 1000.
Свойства параметров
| Тип: | Unlimited |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-RoleGroupAssignable
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, соответствие требованиям безопасности &, встроенная безопасность надстройка для локальных почтовых ящиков
Параметр RoleGroupAssignable фильтрует субъектов безопасности, возвращая только те объекты, которые можно назначить группе ролей RBAC. С этим параметром не нужно указывать значение.
Свойства параметров
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Types
Применимо: Exchange Server 2010 г., Exchange Server 2013 г., Exchange Server 2016 г., Exchange Server 2019 г., Exchange Server SE, Exchange Online, соответствие требованиям безопасности &, встроенная безопасность надстройка для локальных почтовых ящиков
Параметр Types фильтрует результаты по типам объектов. Допустимые значения:
- Компьютер
- GlobalSecurityGroup
- Группа
- UniversalSecurityGroup
- Пользователь
- WellknownSecurityPrincipal
Вы можете указать несколько значений, разделив их запятыми.
Свойства параметров
| Тип: | MultiValuedProperty |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(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
Чтобы просмотреть типы возвращаемых данных, также называемые типами вывода, которые принимает этот командлет, см. раздел Типы ввода и вывода командлета. Если поле "Типы выходных данных" пусто, командлет не возвращает данные.