Edit

Share via

Get-SPWebApplicationAppDomain

  • Reference
Module:
SharePointServer
Applies to:
SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Returns all app domains for a specific web application.

Syntax

Get-SPWebApplicationAppDomain
   [[-Identity] <SPAppDomainPipeBind>]
   -AppDomain <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Zone <SPUrlZone>]
   [<CommonParameters>]
Get-SPWebApplicationAppDomain
   [[-Identity] <SPAppDomainPipeBind>]
   -WebApplication <SPWebApplicationPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Zone <SPUrlZone>]
   [<CommonParameters>]

Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.

Use the Get-SPWebApplicationAppDoman cmdlet to return all app domains for a specific web application or for all web applications. If you do not specify parameters, the default zone is used.

Examples

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

Get-SPWebApplicationAppDomain

Returns a list of SPAppDomain objects, one for each of the app domains for all web applications in the farm.

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

Get-SPWebApplicationAppDomain -Zone Default

Returns a list of SPAppDomain objects, one for each of the app domains for the Default zone for all web applications in the farm.

-----------EXAMPLE 3---------

Get-SPWebApplicationAppDomain -WebApplication https://www.contoso.com

Returns a list of SPAppDomain objects, one for each of all the app domains for the specified web application for all zones.

-----------EXAMPLE 4---------

Get-SPWebApplicationAppDomain -AppDomain contosoapps.com

Returns a list of SPAppDomain objects, one for each web application and zone pair that shares the specified app domain.

Parameters

-AppDomain

Specifies the URI of the app domain.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Identity

Specifies the string of a domain name (that is, contoso.com) or a SPAppDomain object.

Type:SPAppDomainPipeBind
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-WebApplication

Specifies the GUID, URI, or name of the web application for which the app domain is being configured.

Type:SPWebApplicationPipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Zone

Specifies the security zone to which the app domain will be assigned.

  • Default

  • Intranet

  • Internet

  • Extranet

  • Custom

If no value is specified, Default is applied.

Type:SPUrlZone
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Inputs

Microsoft.SharePoint.Administration.SPAppCmdlets.SPAppDomainPipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object