Get-CsAdContact
Tópico modificado em: 2012-03-23
Em uma topologia de diversas florestas, retorna informações sobre contas de usuários de florestas diferentes da floresta inicial. Esses usuários são os que foram replicados como objetos de contato pelo Microsoft Forefront Identity Manager 2010 (ou uma versão anterior do produto). Get-CsAdContact retorna qualquer usuário que possua um valor configurado para o atributo msRTCSIP-OriginatorSid.
Sintaxe
Get-CsAdContact [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LDAPFilter <String>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>]
Descrição Detalhada
Em uma topologia de várias florestas, os usuários de outras florestas são representados como contatos. Esses contatos não são equivalentes aos contatos do Active Directory; se você estiver usando Usuários e Computadores do Active Directory para criar um novo contato, esse usuário não será retornado pelo cmdlet Get-CsAdContact. Em vez disso, Get-CsAdContact retornará somente informações sobre usuários de florestas que não sejam suas florestas iniciais. Se você não possui uma topologia de várias florestas, não será necessário chamar Get-CsAdContact.
Quem pode executar esse cmdlet: Por padrão, membros dos seguintes grupos são autorizados a executar o cmdlet Get-CsAdContact localmente: RTCUniversalUserAdmins, RTCUniversalServerAdmins e RTCUniversalReadOnlyAdmins. Para retornar uma lista de todas as funções do controle de acesso baseado em função (RBAC) que receberam a atribuição desse cmdlet (incluindo qualquer função RBAC personalizada criada por você), execute o seguinte comando do prompt Windows PowerShell:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsAdContact"}
Parâmetros
| Parâmetro | Obrigatório | Digite | Descrição |
|---|---|---|---|
Identity |
Opcional |
Parâmetro UserID |
Indica a Identidade do contato a ser retornado. As identidades do contato podem ser especificadas usando um dos três seguintes formatos: 1) o endereço SIP do contato, 2) o nome diferenciado do contato no Active Directory e 3) o nome de exibição do contato no Active Directory (por exemplo: Ken Myer). É possível utilizar o caractere curinga asterisco (*) ao se utilizar o Nome de exibição como Identidade do contato. Por exemplo, a Identidade "* Smith" retornará todos os contatos com um nome de exibição que termine com o valor de cadeia de caracteres "Smith". |
Credential |
Opcional |
Objeto PSCredential |
Permite executar o cmdlet Get-CsAdContact com credenciais alternativas; isto pode ser necessário se a conta que você usou para fazer logon no Windows não tiver os privilégios necessários para trabalhar com objetos de contato. Para usar o parâmetro Credencial, é necessário criar primeiro um objeto PSCredential, usando o cmdlet Get-Credential. Para obter mais detalhes, consulte o tópico da Ajuda relativo a Get-Credential. |
DomainController |
Opcional |
Cadeia de caracteres |
Permite que você se conecte a um controlador de domínio especificado, para recuperar as informações de contato. Para se conectar a um determinado controlador de domínio, inclua o parâmetro DomainController seguido do nome de domínio totalmente qualificado (atl-cs-001.litwareinc.com, por exemplo). |
Filter |
Opcional |
Cadeia de caracteres |
Permite que você limite os dados retornados, filtrando atributos específicos a Microsoft Lync Server 2010. O parâmetro Filtro usa o mesmo filtro de sintaxe Windows PowerShell usado pelo cmdlet Where-Object. Por exemplo: um filtro que retorna apenas os contatos que possuírem um endereço SIP que termine com "fabrikam.com" teria a seguinte aparência: {SipAddress -like "*@fabrikam.com"}, onde SipAddress representa o atributo do Active Directory, -like representa o operador de comparação e "*@fabrikam.com" representa o valor de filtro. |
LdapFilter |
Opcional |
Cadeia de caracteres |
Permite limitar os dados retornados, filtrando-se atributos genéricos do Active Directory. Por exemplo, você pode limitar dados retornados a contatos que trabalham em um departamento específico ou contatos que têm um gerente ou cargo específico. Ao criar filtros, o parâmetro LdapFilter usa a linguagem de consulta LDAP. Por exemplo: um filtro que retorna o contato que possuir o número de telefone 1-425-555-1298 teria a seguinte aparência: "telephoneNumber=1-425-555-1298", onde "telephoneNumber" representa o atributo do Active Directory, "=", o operador de comparação (igual a) e "1-425-555-1298", o valor do filtro. |
OU |
Opcional |
Nome distinto |
Permite que você limite a informação recuperada de uma unidade organizacional do Active Directory específica (OU) ou de um contêiner. Este parâmetro retorna dados do OU específico e de qualquer um dos seus OUs filhos. Por exemplo, se o OU Financeiro possuir dois OUs filhos: AccountsPayable e AccountsReceivables: serão retornados contatos de cada um desses três OUs. Especificando um OU, use o nome diferenciado daquele contêiner; por exemplo: OU=Finance,dc=litwareinc,dc=com. |
ResultSize |
Opcional |
Inteiro |
Permite limitar o número de registros retornados por um cmdlet. Por exemplo: para retornar sete contatos (independentemente de quantos contatos houver na floresta), inclua o parâmetro ResultSize e defina o valor de parâmetro como 7. Observe que não há nenhum modo de garantir quais sete usuários serão retornados. O tamanho do resultado pode ser definido por qualquer número inteiro entre 0 e 2147483647, inclusive. Se o número for definido como 0, o comando será executado, mas nenhum dado será retornado. Se você estabelecer o ResultSize como 7, mas só houver três contatos na floresta, o comando retornará os três contatos e, em seguida, concluirá sem erro. |
Tipos de Entrada
Cadeia de caracteres. Get-CsAdContact aceita um valor canalizado de cadeia de caracteres, que representa a Identidade de uma conta de usuário.
Tipos de Retorno
Get-CsAdContact retorna instâncias do objeto Microsoft.Rtc.Management.ADConnect.Schema.ADContact.
Exemplo
-------------------------- Exemplo 1 ------------------------
Get-CsAdContact
O comando exibido no Exemplo 1 retorna uma coleção de todos os contatos de várias florestas encontrados no Serviços de Domínio Active Directory (AD DS). O ato de chamar Get-CsAdContact sem nenhum parâmetro adicional retornará todos os valores de propriedade correspondentes a todos os contatos do Active Directory.
-------------------------- Exemplo 2 ------------------------
Get-CsAdContact | Select-Object DisplayName, SipAddress
O Exemplo 2 também retornará uma coleção de todos os contatos do Active Directory. No entanto, nesse caso, essa coleção será canalizada para o cmdlet Select-Object, que especifica os dois únicos atributos que serão exibidos na tela: DisplayName e SipAddress.
-------------------------- Exemplo 3 ------------------------
Get-CsAdContact -Identity "Ken Myer"
O comando precedente retorna informações sobre um único contato do Active Directory: o contato com a identidade "Ken Myer".
-------------------------- Exemplo 4 ------------------------
Get-CsAdContact -LdapFilter "Organization=Fabrikam"
No Exemplo 4, o comando retorna todos os contatos do Active Directory que trabalham para Fabrikam. Para fazer isso, chama-se Get-CsAdContact, juntamente com o parâmetro LdapFilter. Nesse exemplo, limita os dados retornados a contatos que possuírem o atributo Organization definido como "Fabrikam".
-------------------------- Exemplo 5 ------------------------
$x = Get-Credential -Credential "litwareinc\administrator"
Get-CsAdContact -Credential $x
Os dois comandos exibidos no Exemplo 5 ilustram o uso do parâmetro Credencial, que permite executar Get-CsAdContact com credenciais alternativas. No primeiro comando, o cmdlet Get-Credential será chamado para criar um objeto PSCredential para a conta litwareinc\administrador. Esse comando exibe uma caixa de diálogo de Solicitação de credencial correspondente ao usuário litwareinc\administrator. Depois que a senha para essa conta for fornecida, essas informações de credencial serão armazenadas na variável $x. No segundo comando, Get-CsAdContact será chamado juntamente com o parâmetro Credential. O valor de parâmetro $x indica que Get-CsAdContact deve ser executado na conta litwareinc\administrator.