Get-AzADGroup

Referência

Módulo:: Az.Resources

Lista entidades de grupos ou obter entidade de grupos por chave

Sintaxe

Get-AzADGroup
   [-Count]
   [-Expand <String[]>]
   [-Select <String[]>]
   [-Filter <String>]
   [-Orderby <String[]>]
   [-Search <String>]
   [-ConsistencyLevel <String>]
   [-First <UInt64>]
   [-Skip <UInt64>]
   [-AppendSelected]
   [-DefaultProfile <PSObject>]
   [-CountVariable <String>]
   [<CommonParameters>]

Get-AzADGroup
   [-Expand <String[]>]
   [-Select <String[]>]
   [-ConsistencyLevel <String>]
   [-First <UInt64>]
   [-Skip <UInt64>]
   [-AppendSelected]
   -DisplayName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzADGroup
   [-Expand <String[]>]
   [-Select <String[]>]
   [-ConsistencyLevel <String>]
   [-First <UInt64>]
   [-Skip <UInt64>]
   [-AppendSelected]
   -DisplayNameStartsWith <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzADGroup
   [-Expand <String[]>]
   [-Select <String[]>]
   [-ConsistencyLevel <String>]
   [-AppendSelected]
   -ObjectId <Guid>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Lista entidades de grupos ou obter entidade de grupos por chave

Exemplos

Exemplo 1: Obter grupo por nome de exibição

Get-AzADGroup -DisplayName $gname

Obter grupo por nome de exibição

Exemplo 2: Listar grupos

Get-AzADGroup -First 10

Listar os primeiros 10 grupos

Exemplo 3: Obter grupo por id de objeto

Get-AzADGroup -ObjectId $id -Select groupTypes -AppendSelected

Obter grupo por id de objeto e acrescentar propriedade 'groupTypes' após as propriedades padrão: 'DisplayName', 'Id', 'DeletedDateTime', 'SecurityEnabled', 'MailEnabled', 'MailNickname', 'Description'

Exemplo 4: Obter grupo com filtro

Get-AzADGroup -Filter "startsWith(DisplayName,'some-name')"

Obter grupo com filtro

Exemplo 5: Atribuir OdataCount a uma variável

Get-AzADGroup -First 10 -ConsistencyLevel eventual -Count -CountVariable 'result'
$result

Atribuir OdataCount a uma variável

Parâmetros

-AppendSelected

Acrescentar propriedades selecionadas com propriedades padrão quando essa opção estiver ativada, só funciona com o parâmetro '-Select'.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ConsistencyLevel

Indica o nível de consistência solicitado. URL da documentação: https://developer.microsoft.com/en-us/office/blogs/microsoft-graph-advanced-queries-for-directory-objects-are-now-generally-available/

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Count

Incluir contagem de itens

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-CountVariable

Especifica uma contagem do número total de itens em uma coleção. Por padrão, essa variável será definida no escopo global.

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:	PSObject
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-DisplayName

O nome a apresentar do grupo.

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-DisplayNameStartsWith

Usado para localizar grupos que começam com a cadeia de caracteres fornecida.

Tipo:	String
Aliases:	SearchString
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Expand

Expandir entidades relacionadas

Tipo:	String[]
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Filter

Filtrar itens por valores de propriedade, para obter mais detalhes sobre a consulta de filtro, consulte: https://learn.microsoft.com/en-us/graph/filter-query-parameter

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-First

Obtém apenas os primeiros 'n' objetos.

Tipo:	UInt64
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ObjectId

Chave: ID do grupo

Tipo:	Guid
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Orderby

Ordenar itens por valores de propriedade

Tipo:	String[]
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Search

Pesquisar itens por frases de pesquisa

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Select

Selecionar propriedades a serem retornadas

Tipo:	String[]
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Skip

Ignora os primeiros 'n' objetos e, em seguida, obtém os objetos restantes.

Tipo:	UInt64
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

Saídas

IMicrosoftGraphGroup

Partilhar via