Get-AzContainerAppAuthConfig

  • Reference
Module:
Az.App

Get a AuthConfig of a Container App.

Syntax

Get-AzContainerAppAuthConfig
   -ContainerAppName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzContainerAppAuthConfig
   -ContainerAppName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzContainerAppAuthConfig
   -Name <String>
   -ContainerAppInputObject <IAppIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzContainerAppAuthConfig
   -InputObject <IAppIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get a AuthConfig of a Container App.

Examples

Example 1: List AuthConfig of a Container App.

Get-AzContainerAppAuthConfig -ContainerAppName azps-containerapp-2 -ResourceGroupName azps_test_group_app

Name    PlatformEnabled ResourceGroupName
----    --------------- -----------------
current True            azps_test_group_app

List AuthConfig of a Container App.

Example 2: Get a AuthConfig of a Container App.

Get-AzContainerAppAuthConfig -ContainerAppName azps-containerapp-2 -ResourceGroupName azps_test_group_app -Name current

Name    PlatformEnabled ResourceGroupName
----    --------------- -----------------
current True            azps_test_group_app

Get a AuthConfig of a Container App.

Example 3: Get a AuthConfig of a Container App.

$containerapp = Get-AzContainerApp -Name azps-containerapp-2 -ResourceGroupName azps_test_group_app
Get-AzContainerAppAuthConfig -ContainerAppInputObject $containerapp -Name current

Name    PlatformEnabled ResourceGroupName
----    --------------- -----------------
current True            azps_test_group_app

Get a AuthConfig of a Container App.

Parameters

-ContainerAppInputObject

Identity Parameter To construct, see NOTES section for CONTAINERAPPINPUTOBJECT properties and create a hash table.

Type:IAppIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ContainerAppName

Name of the Container App.

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

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IAppIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Name of the Container App AuthConfig.

Type:String
Aliases:AuthConfigName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

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

-SubscriptionId

The ID of the target subscription.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IAppIdentity

Outputs

IAuthConfig