Get-AzApiManagementOpenIdConnectProvider
Gets OpenID Connect providers.
Syntax
GetAllOpenIdConnectProviders (Default)
Get-AzApiManagementOpenIdConnectProvider
-Context <PsApiManagementContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByOpenIdConnectProviderId
Get-AzApiManagementOpenIdConnectProvider
-Context <PsApiManagementContext>
[-OpenIdConnectProviderId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByName
Get-AzApiManagementOpenIdConnectProvider
-Context <PsApiManagementContext>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzApiManagementOpenIdConnectProvider cmdlet gets OpenID Connect providers in Azure API Management. ClientSecret will not be included into result details. To get client secret, use Get-AzApiManagementOpenIdConnectProviderClientSecret.
Examples
Example 1: Get all providers
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementOpenIdConnectProvider -Context $apimContext
This command gets all OpenID Connect providers for the specified context.
Example 2: Get a provider by using an ID
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvider01"
This command gets the provider that has the ID OICProvider01.
Example 3: Get a provider by using a name
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementOpenIdConnectProvider -Context $apimContext -Name "Contoso OpenID Connect Provider"
This command gets the provider named Contoso OpenID Connect Provider.
Parameters
-Context
Specifies a PsApiManagementContext object.
Parameter properties
| Type: | PsApiManagementContext |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| 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 |
-Name
Specifies a friendly name of a provider. If you specify a name, this cmdlet gets that provider.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByName
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-OpenIdConnectProviderId
Specifies an ID of the provider that this cmdlet removes. If you specify an ID, this cmdlet gets that provider.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByOpenIdConnectProviderId
| 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.
