Edit

Share via


Get-SPWebApplicationAppDomain

Returns all app domains for a specific web application.

Syntax

ResourceName

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

WebApplication

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

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the URI of the app ___domain.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ResourceName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AssignmentCollection

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Type:SPAssignmentCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Type:SPAppDomainPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-WebApplication

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Type:SPWebApplicationPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

WebApplication
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Zone

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Type:SPUrlZone
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.SharePoint.Administration.SPAppCmdlets.SPAppDomainPipeBind

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object