Get-AzADGroup

Módulo:

Az.Resources Module

Lista entidades de grupos ou obter entidade de grupos por chave

Sintaxe

EmptyParameterSet (Predefinição)

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>]

DisplayNameParameterSet

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

SearchStringParameterSet

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

ObjectIdParameterSet

Get-AzADGroup
    -ObjectId <Guid>
    [-Expand <String[]>]
    [-Select <String[]>]
    [-ConsistencyLevel <String>]
    [-AppendSelected]
    [-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'.

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-ConsistencyLevel

Indica o nível de consistência solicitado. URL da documentação:

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Count

Incluir contagem de itens

Propriedades dos parâmetros

Tipo:	SwitchParameter
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

EmptyParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	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.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

EmptyParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-DefaultProfile

As credenciais, conta, inquilino e subscrição usados para comunicação com o Azure.

Propriedades dos parâmetros

Tipo:	PSObject
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-DisplayName

O nome para exibição do grupo.

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

DisplayNameParameterSet

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-DisplayNameStartsWith

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

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False
Aliases:	SearchString

Conjuntos de parâmetros

SearchStringParameterSet

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Expand

Expandir entidades relacionadas

Propriedades dos parâmetros

Tipo:	String[]
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Filter

Filtrar itens por valores de propriedade, para obter mais detalhes sobre a consulta de filtro, consulte:

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

EmptyParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-First

Obtém apenas os primeiros 'n' objetos.

Propriedades dos parâmetros

Tipo:	UInt64
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

EmptyParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

DisplayNameParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

SearchStringParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-ObjectId

Chave: ID do grupo

Propriedades dos parâmetros

Tipo:	Guid
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

ObjectIdParameterSet

Position:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Orderby

Ordenar itens por valores de propriedade

Propriedades dos parâmetros

Tipo:	String[]
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

EmptyParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Search

Pesquisar itens por frases de pesquisa

Propriedades dos parâmetros

Tipo:	String
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

EmptyParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Select

Selecionar propriedades a serem retornadas

Propriedades dos parâmetros

Tipo:	String[]
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

(All)

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

-Skip

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

Propriedades dos parâmetros

Tipo:	UInt64
Default value:	None
Suporta carateres universais:	False
NãoMostrar:	False

Conjuntos de parâmetros

EmptyParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

DisplayNameParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	False

SearchStringParameterSet

Position:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline por nome de propriedade:	False
Valor dos restantes argumentos:	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.

Saídas

IMicrosoftGraphGroup