Compartilhar via

Get-MsolGroup

  • Referência
Módulo:
MSOnline

Obtém grupos do Azure Active Directory.

Sintaxe

Get-MsolGroup
   [-UserObjectId <Guid>]
   [-IsAgentRole]
   [-UserPrincipalName <String>]
   [-GroupType <GroupType>]
   [-HasErrorsOnly]
   [-HasLicenseErrorsOnly <Boolean>]
   [-SearchString <String>]
   [-MaxResults <Int32>]
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolGroup
   -ObjectId <Guid>
   [-TenantId <Guid>]
   [<CommonParameters>]
Get-MsolGroup
   [-UserObjectId <Guid>]
   [-IsAgentRole]
   [-UserPrincipalName <String>]
   [-GroupType <GroupType>]
   [-HasErrorsOnly]
   [-HasLicenseErrorsOnly <Boolean>]
   [-SearchString <String>]
   [-All]
   [-TenantId <Guid>]
   [<CommonParameters>]

Description

O cmdlet Get-MsolGroup obtém grupos do Azure Active Directory. Esse cmdlet pode ser usado para retornar um único grupo, se você especificar o parâmetro ObjectId ou pesquisar em todos os grupos.

Exemplos

Exemplo 1: Obter um grupo usando uma ID

PS C:\> Get-MsolGroup -ObjectId af407072-7ae1-4b07-a0ca-6634b7396054

Esse comando retorna o objeto de grupo que tem a ID especificada.

Exemplo 2: Obter todos os grupos

PS C:\> Get-MsolGroup

Esse comando retorna todo o conjunto de grupos para o locatário até os 250 resultados padrão.

Exemplo 3: Obter um grupo usando um nome de entidade de usuário

PS C:\> Get-MsolGroup -isAgentRole -UserPrincipalName "pattifuller@contoso.com"

Este comando retorna os grupos de agente dos que o usuário é um membro. Isto se aplica apenas para empresas que tenham privilégios de parceiro.

Parâmetros

-All

Indica que esse cmdlet retorna todos os resultados encontrados. Não especifique esse parâmetro e o parâmetro MaxResults .

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-GroupType

Especifica o tipo de grupos a serem obtidos. Os valores válidos são Security, MailEnabledSecurity e DistributionList.

Tipo:GroupType
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-HasErrorsOnly

Indica que esse cmdlet retorna apenas grupos que têm erros de validação.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-HasLicenseErrorsOnly

Especifica se esse cmdlet retorna apenas grupos de segurança que têm erros de licença.

Tipo:Boolean
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-IsAgentRole

Especifica que esse cmdlet retorna apenas grupos de agentes. Esse valor se aplica somente a usuários parceiros.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-MaxResults

Especifica o número máximo de resultados que esse cmdlet retorna. O valor padrão é 250.

Tipo:Int32
Cargo:Named
Valor padrão:250
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ObjectId

Especifica a ID de objeto exclusiva do grupo a ser obtido.

Tipo:Guid
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-SearchString

Especifica uma cadeia de caracteres. Esse cmdlet retorna grupos de segurança que têm um nome de exibição que começa com essa cadeia de caracteres.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-TenantId

Especifica a ID exclusiva do locatário no qual executar a operação. O valor padrão é o locatário do usuário atual. Esse parâmetro se aplica somente a usuários parceiros.

Tipo:Guid
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-UserObjectId

Especifica a ID exclusiva de um usuário. Esse cmdlet retorna grupos de segurança aos quais este usuário pertence. Esse parâmetro deve ser usado junto com o parâmetro IsAgentRole .

Tipo:Guid
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-UserPrincipalName

Especifica o nome da entidade de usuário de um usuário. Esse cmdlet retorna grupos de segurança aos quais este usuário pertence. Esse parâmetro deve ser usado junto com o parâmetro IsAgentRole .

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Saídas

Microsoft.Online.Administration.Group

Esse cmdlet retorna uma lista de grupos, que incluem as seguintes informações:

  • Commonname. O nome comum do grupo.

  • Descrição. Uma descrição do grupo.

  • DisplayName. O nome de exibição do grupo.

  • Emailaddress. O endereço de email do grupo. Este não é retornado para os grupos de segurança.

  • Erros. Uma lista de erros para o grupo.

  • GroupType. O tipo do grupo. Os tipos podem ser SecurityGroup, DistributionList ou MailEnabledSecurityGroup.

  • Issystem. Se esse grupo é ou não um grupo do sistema (criado pelo Azure Active Directory). Estes grupos não podem ser atualizados nem removidos.

  • LastDirSyncTime. A data e a hora da última sincronização do grupo.

  • Managedby. O proprietário do grupo.

  • Objectid. O ID de objeto exclusivo do grupo.

  • Endereços proxy. Os endereços proxy associados a esse grupo (somente para grupos habilitados para email).

  • ValidationStatus. Se o grupo tem ou não algum erro.