Get-AzApiManagementAuthorizationServer
Gets an API Management authorization server.
Syntax
ContextParameterSet (Default)
Get-AzApiManagementAuthorizationServer
-Context <PsApiManagementContext>
[-ServerId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ResourceIdParameterSet
Get-AzApiManagementAuthorizationServer
-ResourceId <String>
[-ServerId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzApiManagementAuthorizationServer cmdlet gets all Azure API Management authorization servers or specified authorization server. ClientSecret will not be included into result details. To get client secret, use Get-AzApiManagementAuthorizationServerClientSecret.
Examples
Example 1: Get all authorization servers
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementAuthorizationServer -Context $ApiMgmtContext
This command gets all API Management authorization servers.
Example 2: Get a specified authorization server
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementAuthorizationServer -Context $ApiMgmtContext -ServerId "0123456789"
This command gets the specified authorization server.
Parameters
-Context
The Get-AzApiManagementAuthorizationServer cmdlet gets all Azure API Management authorization servers or specified authorization server. ClientSecret will not be included into result details. To get client secret, use Get-AzApiManagementAuthorizationServerClientSecret.
Parameter properties
| Type: | PsApiManagementContext |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ContextParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceId
Arm Resource Identifier of the authorization server. If specified will try to find authorization server by the identifier. This parameter is required.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ResourceIdParameterSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ServerId
The Get-AzApiManagementAuthorizationServer cmdlet gets all Azure API Management authorization servers or specified authorization server. ClientSecret will not be included into result details. To get client secret, use Get-AzApiManagementAuthorizationServerClientSecret.
Parameter properties
| Type: | String |
| 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: | True |
| 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.
