Set-EntraGroup

Define as propriedades de um grupo de Microsoft Entra ID existente.

Sintaxe

Default (Default)

Set-EntraGroup

    -GroupId <String>
    [-DisplayName <String>]
    [-GroupTypes <System.Collections.Generic.List`1[System.String]>]
    [-SecurityEnabled <Boolean>]
    [-Description <String>]
    [-MailEnabled <Boolean>]
    [-MailNickname <String>]
    [-Visibility <String>]
    [-IsAssignableToRole <Boolean>]
    [<CommonParameters>]

Description

O Set-EntraGroup cmdlet define as propriedades de um grupo de Microsoft Entra ID existente. Especifique o GroupId parâmetro para definir as propriedades de um grupo de Microsoft Entra ID existente.

Exemplos

Exemplo 1: atualizar um nome de exibição de grupo

Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "displayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -DisplayName 'Global HelpDesk Team Leaders'

Esse comando atualiza o nome de exibição de um grupo especificado no Microsoft Entra ID.

Exemplo 2: atualizar uma descrição de grupo

Connect-Entra -Scopes 'Group.ReadWrite.All'
Get-EntraGroup -Filter "displayName eq 'HelpDesk Team Leaders'" | Set-EntraGroup -Description 'HelpDesk Team Leaders Global'

Este exemplo demonstra como atualizar uma descrição de grupo.

Exemplo 3: atualizar um apelido de email de grupo

Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -MailNickName 'newnickname'

Esse comando atualiza o apelido de email de um grupo especificado em Microsoft Entra ID.

Exemplo 4: atualizar uma segurança de grupo habilitada

Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -SecurityEnabled $True

Esse comando atualiza a segurança habilitada de um grupo especificado no Microsoft Entra ID.

Exemplo 5: atualizar um email de grupo habilitado

Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -MailEnabled $False

Este exemplo demonstra como atualizar um grupo principal habilitado.

Exemplo 6: atualizar uma propriedade para um grupo

Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -Visibility 'Private' -GroupTypes 'DynamicMembership' -IsAssignableToRole $True

Este exemplo demonstra como atualizar uma propriedade para um grupo de Microsoft Entra ID existente.

Parâmetros

-Description

Especifica uma descrição para o grupo.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DisplayName

Especifica um nome de exibição para o grupo.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-GroupId

Especifica a ID do objeto de um grupo.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:ID

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-GroupTypes

Especifica que o grupo é um grupo dinâmico. Para criar um grupo dinâmico, especifique um valor de DynamicMembership.

Propriedades do parâmetro

Tipo:

System.Collections.Generic.List`1[System.String]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-IsAssignableToRole

Essa propriedade só pode ser definida no momento da criação do grupo e não pode ser modificada em um grupo existente.

Propriedades do parâmetro

Tipo:System.Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-MailEnabled

Indica se esse grupo está habilitado para email.

Propriedades do parâmetro

Tipo:System.Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-MailNickname

Especifica uma alcunha de correio para o grupo.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SecurityEnabled

Indica se o grupo está habilitado para segurança.

Propriedades do parâmetro

Tipo:System.Boolean
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Visibility

Especifica a visibilidade do conteúdo do grupo e da lista de membros. Esse parâmetro pode ter um dos seguintes valores:

  • "Público": qualquer pessoa pode exibir o conteúdo do grupo.
  • "Privado": somente os membros podem exibir o conteúdo do grupo.
  • "HiddenMembership": somente os membros podem exibir o conteúdo do grupo e somente membros, proprietários, Administrador global/da empresa, administrador de usuários e administradores de assistência técnica podem exibir a lista de membros do grupo.

Se nenhum valor for fornecido, o valor padrão será "Public".

Notes:

  • Esse parâmetro só é válido para grupos que têm o groupType definido como "Unificado".
  • Se um grupo tiver esse atributo definido como "HiddenMembership", ele não poderá ser alterado mais tarde.
  • Qualquer pessoa pode ingressar em um grupo que tenha esse atributo definido como "Público". Se o atributo estiver definido como Private ou HiddenMembership, somente o proprietário poderá adicionar novos membros ao grupo e as solicitações para ingressar no grupo precisarão de aprovação do proprietário.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

System.String

Saídas

System.Object