Get-CsAdPrincipal

Skype for Business Server 2015
 

Дата изменения раздела:2017-03-15

Возвращает сведения о субъектах Active Directory. В число этих субъектов входят такие объекты Active Directory, как пользователи, группы, контакты, контейнеры и подразделения. Данный командлет впервые появился в Lync Server 2013.

Get-CsAdPrincipal [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LDAPFilter <String>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>]

Команда, показанная в примере 1, возвращает все субъекты Active Directory в организации.

Get-CsAdPrincipal

В примере 2 возвращаются сведения для одного субъекта Active Directory, который имеет SIP-адрес "sip:RedmondMeetingRoom@litwareinc.com". Это делается путем использования параметра Filter и значения фильтра для поиска субъектов, свойство SipAddress которых имеет значение (-eq) "sip:RedmondMeetingRoom@litwareinc.com".

Get-CsAdPrincipal -Filter {SipAddress -eq "sip:RedmondMeetingRoom@litwareinc.com"}

В предыдущем примере извлекаются сведения для всех объектов Active Directory. Для выполнения этой задачи команда сначала вызывает командлет Get-CsAdPrincipal без параметров; этот командлет возвращает коллекцию всех субъектов Active Directory. Затем эта коллекция передается в командлет Where-Object , который выбирает только те субъекты, свойство ObjectClass которых содержит строку "contact".

Get-CsAdPrincipal | Where-Object {$_.ObjectClass -contains "contact"}

Командлет Get-CsAdPrincipa возвращает коллекцию субъектов Active Directory, которые можно использовать при создании списков членов сохраняемого чата (дополнительные сведения см. в справке по параметрам AllowedMembers и DeniedMembers командлета Set-CsPersistentChatCategory ). Командлет Get-CsAdPrincipal возвращает следующие сведения об объектах Active Directory:

  • Пользователи (object class = {top, person, organizationalPerson, user})

  • Группы (object class = {top, group})

  • Контакты (object class = {top, person, organizationalPerson, contact})

  • Контейнеры (object class = {top, container})

  • Подразделения (object class = {top, organizationalUnit})

  • Домены (object class = {top, domain, domainDNS})

Это означает, что с помощью командлета Get-CsAdPrincipal (и свойства objectClass) можно быстро получить сведения об объектах Active Directory, например группах или подразделениях. Например, следующая команда возвращает названия всех подразделений Active Directory:

Get-CsAdPrincipal | Where-Object {$_.ObjectClass -match "organizationalUnit"} | Select-Object Name

Панель Панель управления Skype для бизнеса Server: функции, выполняемые командлетом Get-CsAdPrincipal, недоступны в панели Панель управления Skype для бизнеса Server.

 

Параметр Обязательный? Тип Описание

Credential

Необязательный

System.Management.Automation.PSCredential

Позволяет запустить командлет Get-CsAdPrincipal с другими учетными данными. Это может потребоваться, если у учетной записи, под которой был выполнен вход в Windows, нет необходимых прав для работы с объектами пользователей.

Чтобы использовать параметр Credential, необходимо сначала создать объект PSCredential с помощью командлета Get-Credential . Дополнительные сведения см. в разделе справки, посвященном командлету Get-Credential .

DomainController

Необязательный

Microsoft.Rtc.Management.Deploy.Fqdn

Позволяет подключиться к указанному контроллеру домена, чтобы извлечь сведения о субъекте Active Directory. Чтобы подключиться к определенному контроллеру, укажите параметр DomainController, за которым следует имя компьютера (например, atl-dc-001) или полное доменное имя (например, atl-dc-001.litwareinc.com).

Filter

Необязательный

System.String

Позволяет ограничить возвращаемые данные, фильтруя их по атрибутам, связанным с Skype для бизнеса Server 2015.

Параметр Filter использует в основном тот же синтаксис фильтрации Windows PowerShell, что и командлет Where-Object . Например, фильтр, возвращающий только субъекты, для которых не включен Skype для бизнеса Server 2015, мог бы выглядеть следующим образом:

-Filter {Enabled -ne $True}

В этом примере Enabled представляет атрибут Active Directory, -ne представляет оператор сравнения (не равно), а $True (встроенная переменная Windows PowerShell) представляет значение True.

Identity

Необязательный

Microsoft.Rtc.Management.AD.UserIdParameter

Указывает удостоверение учетной записи извлекаемого субъекта. Удостоверения обычно задаются в одном из четырех форматов: 1) SIP-адрес пользователя; 2) имя участника-пользователя (UPN); 3) доменное имя пользователя и его имя для входа в формате "домен\имя_для_входа" (например, litwareinc\kenmyer); 4) отображаемое имя пользователя в Active Directory (например, Ken Myer).

Можно также ссылаться на учетную запись пользователя с помощью различающегося имени пользователя Active Directory.

При использовании отображаемого имени в качестве удостоверения можно использовать звездочку (*). Например, при указании удостоверения "* Иванов" будут возвращены все пользователи, отображаемое имя которых заканчивается строковым значением " Иванов".

LDAPFilter

Необязательный

System.String

Позволяет ограничить извлекаемые данные путем фильтрации по универсальным атрибутам Active Directory (т.е. атрибутам, которые не относятся исключительно к Skype для бизнеса Server 2015). Например, можно ограничить извлекаемые данные субъектами, которые относятся к конкретному отделу, или которые имеют определенного руководителя, или которые имеют определенную должность.

Параметр LdapFilter использует при создании фильтров язык запросов LDAP. Например, фильтр, возвращающий только субъектов, расположенных в городе Redmond, может выглядеть следующим образом:

-LdapFilter "l=Redmond"

В этом примере "l" (строчная L) представляет атрибут Active Directory (locality); "=" представляет оператор сравнения (равно); "Redmond" представляет значение фильтра.

OU

Необязательный

Microsoft.Rtc.Management.AD.OUIdParameter

Позволяет получить сведения о субъектах в определенном подразделении или контейнере. Параметр OU возвращает данные из указанного подразделения и из всех его дочерних подразделений. Например, если финансовый отдел (Finance) имеет два дочерних подразделения, AccountsPayable и AccountsReceivable, то будут извлечены субъекты из всех этих трех подразделений.

При указании подразделения, используйте различающееся имя контейнера, например:

-OU "OU=Finance,dc=litwareinc,dc=com"

Чтобы извлечь субъекты из контейнера Users, используйте следующий синтаксис:

-OU "cn=Users,dc=litwareinc,dc=com"

ResultSize

Необязательный

Microsoft.Rtc.Management.ADConnect.Core.Unlimited

Позволяет ограничить число записей, возвращаемых командлетом. Например, чтобы получить 7 субъектов (независимо от числа субъектов в лесу), включите параметр ResultSize и укажите для него значение 7. Следует отметить, что нельзя предсказать, какие именно семь субъектов будут извлечены.

В качестве размера результатов может быть указано любое целое число в диапазоне от 0 до 2147483647 включительно. При задании значения "0" команда будет выполняться, но данные возвращаться не будут. Если для параметра ResultSize указано значение 7, но в лесу всего три субъекта, то команда извлечет этих трех субъектов и завершится без ошибки.

Строковое значение или объект, представляющий пользователя, группу, контакт, контейнер или подразделение Active Directory. Например, следующий синтаксис возвращает сведения о субъектах Active Directory для подразделений Redmond и Dublin:

"OU=Redmond,DC=litwareinc,DC=com", "OU=Dublin,DC=litwareinc,DC=com" | Get-CsAdPrincipal

Командлет Get-CsAdPrincipal возвращает экземпляры объекта Microsoft.Rtc.Management.ADConnect.Schema.OCSADPrincipal.

 
Показ: