Edit

Share via

Get-AdfsWebApiApplication

  • Reference
Module:
ADFS

Gets Web API application roles in AD FS.

Syntax

PowerShell 
Get-AdfsWebApiApplication
   [[-Identifier] <String[]>]
   [<CommonParameters>]
PowerShell 
Get-AdfsWebApiApplication
   [-Name] <String[]>
   [<CommonParameters>]
PowerShell 
Get-AdfsWebApiApplication
   [-PrefixIdentifier] <String>
   [<CommonParameters>]
PowerShell 
Get-AdfsWebApiApplication
   [-Application] <WebApiApplication>
   [<CommonParameters>]
PowerShell 
Get-AdfsWebApiApplication
   [-ApplicationGroupIdentifier] <String>
   [<CommonParameters>]
PowerShell 
Get-AdfsWebApiApplication
   [-ApplicationGroup] <ApplicationGroup>
   [<CommonParameters>]

Description

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

Parameters

-Application

Specifies a Web API application to get.

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

-ApplicationGroup

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

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

-ApplicationGroupIdentifier

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

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

-Identifier

Specifies an ID of a Web API application to get.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

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

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PrefixIdentifier

Specifies the prefix identifier of Web API applications to get.

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

Inputs

WebApiApplication

WebApiApplication objects are received by the Application parameter.

ApplicationGroup

ApplicationGroup objects are received by the ApplicationGroup parameter.

String

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

Outputs

WebApiApplication

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