Skip to content
Spencer Varney edited this page Dec 27, 2016 · 3 revisions

Get-GADomainAlias

SYNOPSIS

Retrieves a domain alias of the customer.

SYNTAX

One (Default)

Get-GADomainAlias [[-Customer] <String>] [-DomainAliasName] <String>
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

List

Get-GADomainAlias [[-Customer] <String>] [-All] [[-ParentDomainName] <String>]
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Retrieves a domain alias of the customer.

EXAMPLES

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

PS C:\> Get-GADomainAlias -Customer $SomeCustomerString -DomainAliasName $SomeDomainAliasNameString

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-GADomainAlias -Customer $SomeCustomerString

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

-Customer

Immutable id of the Google Apps account.

Type: String
Parameter Sets: (All)
Aliases: 

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

-DomainAliasName

Name of domain alias to be retrieved.

Type: String
Parameter Sets: One
Aliases: 

Required: True
Position: 1
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: True
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ParentDomainName

Name of the parent domain for which domain aliases are to be fetched.

Type: String
Parameter Sets: List
Aliases: 

Required: False
Position: 2
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

Name of domain alias to be retrieved.

System.String

Name of the parent domain for which domain aliases are to be fetched.

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]

Clone this wiki locally