Get-AdfsWebApiApplication
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).
Parameters
-Application
Specifies a Web API application to get.
Parameter properties
| Type: | WebApiApplication |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ApplicationObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ApplicationGroup
Specifies an application group for which to get Web API applications.
Parameter properties
| Type: | ApplicationGroup |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ApplicationGroupObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ApplicationGroupIdentifier
Specifies the ID of an application group for which to get Web API applications.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ApplicationGroupIdentifier
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Identifier
Specifies an ID of a Web API application to get.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identifier
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
Specifies an array of names of Web API applications to get.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Name
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-PrefixIdentifier
Specifies the prefix identifier of Web API applications to get.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PrefixIdentifier
| Position: | 0 |
| Mandatory: | True |
| 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
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.