Get-AdfsWebApiApplication.md

description	external help file	Module Name	ms.date	online version	schema	title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.	Microsoft.IdentityServer.Management.dll-Help.xml	ADFS	12/20/2016	https://learn.microsoft.com/powershell/module/adfs/get-adfswebapiapplication?view=windowsserver2022-ps&wt.mc_id=ps-gethelp	2.0.0	Get-AdfsWebApiApplication

Get-AdfsWebApiApplication

SYNOPSIS

Gets Web API application roles in AD FS.

SYNTAX

Identifier (Default)

Get-AdfsWebApiApplication [[-Identifier] <String[]>] [<CommonParameters>]

Name

Get-AdfsWebApiApplication [-Name] <String[]> [<CommonParameters>]

PrefixIdentifier

Get-AdfsWebApiApplication [-PrefixIdentifier] <String> [<CommonParameters>]

ApplicationObject

Get-AdfsWebApiApplication [-Application] <WebApiApplication> [<CommonParameters>]

ApplicationGroupIdentifier

Get-AdfsWebApiApplication [-ApplicationGroupIdentifier] <String> [<CommonParameters>]

ApplicationGroupObject

Get-AdfsWebApiApplication [-ApplicationGroup] <ApplicationGroup> [<CommonParameters>]

DESCRIPTION

The Get-AdfsWebApiApplication cmdlet gets Web API application roles in Active Directory Federation Services (AD FS).

EXAMPLES

PARAMETERS

-Application

Specifies a Web API application to get.

Type: WebApiApplication
Parameter Sets: ApplicationObject
Aliases:

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

-ApplicationGroup

Specifies an application group for which to get Web API applications.

Type: ApplicationGroup
Parameter Sets: ApplicationGroupObject
Aliases:

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

-ApplicationGroupIdentifier

Specifies the ID of an application group for which to get Web API applications.

Type: String
Parameter Sets: ApplicationGroupIdentifier
Aliases:

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

-Identifier

Specifies an ID of a Web API application to get.

Type: String[]
Parameter Sets: Identifier
Aliases:

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

-Name

Specifies an array of names of Web API applications to get.

Type: String[]
Parameter Sets: Name
Aliases:

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

-PrefixIdentifier

Specifies the prefix identifier of Web API applications to get.

Type: String
Parameter Sets: PrefixIdentifier
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

Microsoft.IdentityServer.Management.Resources.WebApiApplication

WebApiApplication objects are received by the Application parameter.

Microsoft.IdentityServer.Management.Resources.ApplicationGroup

ApplicationGroup objects are received by the ApplicationGroup parameter.

System.String

String objects are received by the ApplicationGroupIdentifier, Identifier, and Name parameters.

OUTPUTS

Microsoft.IdentityServer.Management.Resources.WebApiApplication

Returns one or more WebApiApplication objects that represent the web API applications of the Federation Service.

NOTES

RELATED LINKS

Add-AdfsWebApiApplication

Remove-AdfsWebApiApplication

Set-AdfsWebApiApplication