Edit

Share via

Get-EntraBetaPrivateAccessApplication

  • Reference
Module:
Microsoft.Entra.Beta

Retrieves a list of all Private Access applications, or if specified, details of a specific application.

Syntax

Get-EntraBetaPrivateAccessApplication
   [-ApplicationId <String>]
   [<CommonParameters>]
Get-EntraBetaPrivateAccessApplication
   [-ApplicationName <String>]
   [<CommonParameters>]

Description

The Get-EntraBetaPrivateAccessApplication cmdlet retrieves a list of all Private Access applications, or if specified, details of a specific application.

Examples

Example 1: Retrieve all Private Access applications

Connect-Entra -Scopes 'NetworkAccessPolicy.ReadWrite.All', 'Application.ReadWrite.All', 'NetworkAccess.ReadWrite.All'
Get-EntraBetaPrivateAccessApplication

displayName     : testApp1
appId           : aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
id              : bbbbbbbb-1111-2222-3333-cccccccccccc
tags            : {IsAccessibleViaZTNAClient, HideApp, PrivateAccessNonWebApplication}
createdDateTime : 14/06/2024 12:38:50 AM

displayName     : QuickAccess
appId           : dddddddd-3333-4444-5555-eeeeeeeeeeee
id              : eeeeeeee-4444-5555-6666-ffffffffffff
tags            : {HideApp, NetworkAccessQuickAccessApplication}
createdDateTime : 4/07/2023 4:00:07 AM

This command retrieves all Private Access applications, including Quick Access.

Example 2: Retrieve a specific Private Access application by object Id

Connect-Entra -Scopes 'NetworkAccessPolicy.ReadWrite.All', 'Application.ReadWrite.All', 'NetworkAccess.ReadWrite.All'
$application = Get-EntraBetaPrivateAccessApplication | Where-Object {$_.displayName -eq 'Finance team file share'}
Get-EntraBetaPrivateAccessApplication -ApplicationId $application.Id

displayName     : QuickAccess
appId           : aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
id              : bbbbbbbb-1111-2222-3333-cccccccccccc
tags            : {HideApp, NetworkAccessQuickAccessApplication}
createdDateTime : 4/07/2023 4:00:07 AM

This example demonstrates how to retrieve information for a specific Private Access application by object id.

Example 3: Retrieve a specific Private Access application by name

Connect-Entra -Scopes 'NetworkAccessPolicy.ReadWrite.All', 'Application.ReadWrite.All', 'NetworkAccess.ReadWrite.All'
Get-EntraBetaPrivateAccessApplication -ApplicationName 'Finance team file share'

displayName     : Finance team file share
appId           : aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
id              : bbbbbbbb-1111-2222-3333-cccccccccccc
tags            : {IsAccessibleViaZTNAClient, HideApp, PrivateAccessNonWebApplication}
createdDateTime : 14/06/2024 12:38:50 AM

This example demonstrates how to retrieve information for a specific Private Access application by application name.

Parameters

-ApplicationId

The Object ID of a Private Access application object.

Type:System.String
Aliases:ObjectId
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ApplicationName

Specifies a specific application name to retrieve.

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

Inputs

System.String

System.Nullable`1[[System. Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Outputs

System.Object