Get GAOrgUnit

Get-GAOrgUnit

SYNOPSIS

Retrieve Organization Unit

SYNTAX

One (Default)

Get-GAOrgUnit [[-CustomerId] <String>] [[-OrgUnitPath] <String>]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

List

Get-GAOrgUnit [[-OrgUnitPath] <String>] [-All] [[-Type] <TypeEnum>]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Retrieve Organization Unit

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> Get-GAOrgUnit -CustomerId $SomeCustomerIdString -OrgUnitPath @("some","strings")

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

---------- EXAMPLE 2 ----------

PS C:\> Get-GAOrgUnit -CustomerId $SomeCustomerIdString -All

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-CustomerId

Immutable id of the Google Apps account

Type: String
Parameter Sets: One
Aliases: 

Required: False
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OrgUnitPath

Full path of the organization unit or its Id

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-All

A switch to list all results.

Type: SwitchParameter
Parameter Sets: List
Aliases: 

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Type

Whether to return all sub-organizations or just immediate children

Possible values: All, Children

Type: TypeEnum
Parameter Sets: List
Aliases: 
Accepted values: All, Children

Required: False
Position: 4
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-GAuthId

The GAuthId representing the gShell auth credentials this cmdlet should use to run.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

System.String

Immutable id of the Google Apps account

System.String

Full path of the organization unit or its Id

Google.Apis.admin.Directory.directory_v1.OrgunitsResource+ListRequest+TypeEnum

Whether to return all sub-organizations or just immediate children

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Directory API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]