Get-CMAADApplication

  • Reference
Module:
ConfigurationManager

Get the Microsoft Entra app object from the site.

Syntax

Get-CMAADApplication
   [-AppName <String>]
   [-AppType <CloudApplicationType>]
   [-ClientId <String>]
   [-TenantId <String>]
   [-TenantName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

Use this cmdlet to get the Microsoft Entra app object from the site. It's commonly used with the New-CMCloudManagementAzureService cmdlet.

For more information about Microsoft Entra apps in Configuration Manager, see Configure Azure services.

Note

While some of the new cmdlets might work with other Azure services, they're only tested with the Cloud management connection to support the cloud management gateway (CMG).

Examples

Example 1: Get Microsoft Entra client apps by tenant name

This example returns all client apps in the specified tenant.

Get-CMAADApplication -TenantName "Contoso" -AppType ClientApplication

Example 2: Get Microsoft Entra server apps by tenant ID

This example returns all server apps in the specified tenant.

Get-CMAADApplication -TenantId "05a349fa-298a-4427-8771-9efcdb73431e" -AppType ServerApplication

Example 3: Get a Microsoft Entra app by its name

Get-CMAADApplication -AppName "CmgServerApp"

Parameters

-AppName

Specify the name of the app in Microsoft Entra ID.

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

-AppType

Specify whether to target the server or client app.

In Microsoft Entra ID, the server app is known as a web app registration, and the client app is known as a native app registration.

Type:CloudApplicationType
Aliases:ApplicationType
Accepted values:ServerApplication, ClientApplication
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ClientId

Specify the Application (client) ID value of the app registration in Microsoft Entra ID. The format is a standard GUID.

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

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

-TenantId

Specify the GUID of your Microsoft Entra tenant.

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

-TenantName

Specify the name of your Microsoft Entra tenant.

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

Inputs

None

Outputs

IResultObject