Microsoft.Entra.Beta.Applications-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-EntraBetaApplicationOwner</command:name> <command:verb>Add</command:verb> <command:noun>EntraBetaApplicationOwner</command:noun> <maml:description> <maml:para>Adds an owner to an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-EntraBetaApplicationOwner` cmdlet adds an owner to a Microsoft Entra ID application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EntraBetaApplicationOwner</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the Microsoft Entra ID object to assign as owner/manager/member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the Microsoft Entra ID object to assign as owner/manager/member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Add a user as an owner to an application -----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Helpdesk Application'" $user = Get-EntraBetaUser -UserId 'SawyerM@contoso.com' Add-EntraBetaApplicationOwner -ApplicationId $application.Id -RefObjectId $user.Id</dev:code> <dev:remarks> <maml:para>This example demonstrates how to add an owner to an application in Microsoft Entra ID.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the ID of an application.</maml:para> <maml:para>- `-RefObjectId` parameter specifies the ID of a user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Add-EntraBetaApplicationOwner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-EntraBetaApplicationPolicy</command:name> <command:verb>Add</command:verb> <command:noun>EntraBetaApplicationPolicy</command:noun> <maml:description> <maml:para>Adds an application policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-EntraBetaApplicationPolicy` cmdlet adds a Microsoft Entra ID application policy. Specify `Id` and `RefObjectId` parameters to add an application policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EntraBetaApplicationPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the application for which you need to set the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the application for which you need to set the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Add an application policy -------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All, Policy.ReadWrite.ApplicationConfiguration' $params = @{ Id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' RefObjectId = 'bbbbbbbb-1111-2222-3333-cccccccccccc' } Add-EntraBetaApplicationPolicy @params</dev:code> <dev:remarks> <maml:para>This example demonstrates how to add an application policy.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Add-EntraBetaApplicationPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-EntraBetaServicePrincipalDelegatedPermissionClassification</command:name> <command:verb>Add</command:verb> <command:noun>EntraBetaServicePrincipalDelegatedPermissionClassification</command:noun> <maml:description> <maml:para>Add a classification for a delegated permission.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-EntraBetaServicePrincipalDelegatedPermissionClassification` cmdlet creates a delegated permission classification for the given permission on service principal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>The unique identifier of a service principal object in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PermissionId</maml:name> <maml:description> <maml:para>The ID for a delegated permission.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PermissionName</maml:name> <maml:description> <maml:para>The name for a delegated permission.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Classification</maml:name> <maml:description> <maml:para>The classification for a delegated permission. This parameter can take one of the following values:</maml:para> <maml:para>- Low: Specifies a classification for a permission as low impact.</maml:para> <maml:para>- Medium: Specifies a classification for a permission as medium impact.</maml:para> <maml:para>- High: Specifies a classification for a permission as high impact.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ClassificationEnum</command:parameterValue> <dev:type> <maml:name>ClassificationEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>The unique identifier of a service principal object in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PermissionId</maml:name> <maml:description> <maml:para>The ID for a delegated permission.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PermissionName</maml:name> <maml:description> <maml:para>The name for a delegated permission.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Classification</maml:name> <maml:description> <maml:para>The classification for a delegated permission. This parameter can take one of the following values:</maml:para> <maml:para>- Low: Specifies a classification for a permission as low impact.</maml:para> <maml:para>- Medium: Specifies a classification for a permission as medium impact.</maml:para> <maml:para>- High: Specifies a classification for a permission as high impact.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ClassificationEnum</command:parameterValue> <dev:type> <maml:name>ClassificationEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Online.Administration.DelegatedPermissionClassification</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---- Example 1: Create Delegated Permission Classification ----</maml:title> <dev:code>Connect-Entra -Scopes 'Policy.ReadWrite.PermissionGrant' $ServicePrincipal = Get-EntraBetaServicePrincipal -Filter "DisplayName eq '<service-principal-display-name>'" $PermissionId = $ServicePrincipal.PublishedPermissionScopes[0].Id $PermissionName = $ServicePrincipal.PublishedPermissionScopes[0].Value $params = @{ ServicePrincipalId = $ServicePrincipal.ObjectId PermissionId = $PermissionId Classification = 'Low' PermissionName = $PermissionName } Add-EntraBetaServicePrincipalDelegatedPermissionClassification @params Id Classification PermissionId PermissionName -- -------------- ------------ -------------- T2qU_E28O0GgkLLIYRPsTwE low fc946a4f-bc4d-413b-a090-b2c86113ec4f LicenseManager.AccessAsUser</dev:code> <dev:remarks> <maml:para>This command creates a delegated permission classification for the given permission on the service principal. You can use the command `Get-EntraBetaServicePrincipal` to get service principal ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the unique identifier of a service principal.</maml:para> <maml:para>- `-PermissionId` parameter specifies the ID for a delegated permission.</maml:para> <maml:para>- `-Classification` parameter specifies the classification for a delegated permission.</maml:para> <maml:para>- `-PermissionName` parameter specifies the name for a delegated permission.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Add-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-EntraBetaServicePrincipalOwner</command:name> <command:verb>Add</command:verb> <command:noun>EntraBetaServicePrincipalOwner</command:noun> <maml:description> <maml:para>Adds an owner to a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-EntraBetaServicePrincipalOwner` cmdlet adds an owner to a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EntraBetaServicePrincipalOwner</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the Microsoft Entra ID object to assign as owner/manager/member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the Microsoft Entra ID object to assign as owner/manager/member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--- Example 1: Add a user as an owner to a service principal ---</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" $owner = Get-EntraBetaUser -UserId 'SawyerM@contoso.com' Add-EntraBetaServicePrincipalOwner -ServicePrincipalId $servicePrincipal.Id -RefObjectId $owner.Id</dev:code> <dev:remarks> <maml:para>This example demonstrates how to add an owner to a service principal.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal Id.</maml:para> <maml:para>- `-RefObjectId` parameter specifies the user object Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Add-EntraBetaServicePrincipalOwner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipalOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaServicePrincipalOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplication</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplication</command:noun> <maml:description> <maml:para>Gets an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplication` cmdlet gets a Microsoft Entra ID application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaApplication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaApplication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Specifies a search string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Specifies a search string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------- Example 1: Get an application by ApplicationId --------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaApplication -ApplicationId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- ToGraph_443democc3c aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb bbbbbbbb-1111-2222-3333-cccccccccccc AzureADMyOrg contoso.com</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve specific application by providing ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------------- Example 2: Get all applications ---------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaApplication -All DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- test app aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb bbbbbbbb-1111-2222-3333-cccccccccccc AzureADandPersonalMicrosoftAccount contoso.com ToGraph_443DEM cccccccc-4444-5555-6666-dddddddddddd dddddddd-5555-6666-7777-eeeeeeeeeeee AzureADMyOrg contoso.com test adms eeeeeeee-6666-7777-8888-ffffffffffff ffffffff-7777-8888-9999-gggggggggggg AzureADandPersonalMicrosoftAccount contoso.com test adms app azure gggggggg-8888-9999-aaaa-hhhhhhhhhhhh hhhhhhhh-9999-aaaa-bbbb-iiiiiiiiiiii AzureADandPersonalMicrosoftAccount contoso.com test adms2 iiiiiiii-aaaa-bbbb-cccc-jjjjjjjjjjjj jjjjjjjj-bbbb-cccc-dddd-kkkkkkkkkkkk AzureADandPersonalMicrosoftAccount contoso.com</dev:code> <dev:remarks> <maml:para>This example demonstrates how to get all applications from Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 3: Get applications with expiring secrets ------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaApplication | Where-Object { $_.PasswordCredentials.keyId -ne $null -and $_.PasswordCredentials.EndDateTime -lt (Get-Date).AddDays(30) } | ForEach-Object { $_.DisplayName, $_.Id, $_.PasswordCredentials } CustomKeyIdentifier DisplayName EndDateTime Hint KeyId SecretText StartDateTime ------------------- ----------- ----------- ---- ----- ---------- ------------- AppOne 8/19/2024 9:00:00 PM 1jQ aaaaaaaa-0b0b-1c1c-2d2d-333333333333 8/6/2024 6:07:47 PM</dev:code> <dev:remarks> <maml:para>This example retrieves applications with expiring secrets within 30 days.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 4: Get an application by display name --------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaApplication -Filter "DisplayName eq 'ToGraph_443DEMO'" DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- ToGraph_443DEMO cccccccc-4444-5555-6666-dddddddddddd dddddddd-5555-6666-7777-eeeeeeeeeeee AzureADMyOrg contoso.com</dev:code> <dev:remarks> <maml:para>In this example, we retrieve application by its display name from Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 5: Search among retrieved applications --------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaApplication -SearchString 'My new application 2' DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- My new application 2 kkkkkkkk-cccc-dddd-eeee-llllllllllll llllllll-dddd-eeee-ffff-mmmmmmmmmmmm AzureADandPersonalMicrosoftAccount contoso.com</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve applications for specific string from Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 6: Retrieve an application by identifierUris -----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaApplication -Filter "identifierUris/any(uri:uri eq 'https://wingtips.wingtiptoysonline.com')"</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve applications by its identifierUris from Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationExtensionProperty</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationExtensionProperty</command:noun> <maml:description> <maml:para>Gets application extension properties.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationExtensionProperty` cmdlet gets application extension properties in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationExtensionProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Get extension properties -------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Helpdesk Application'" Get-EntraBetaApplicationExtensionProperty -ApplicationId $application.Id DeletedDateTime Id AppDisplayName DataType IsMultiValued IsSyncedFromOnPremises Name TargetObjects --------------- -- -------------- -------- ------------- ---------------------- ---- ------------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Boolean False False extension_c371a443f6734a3e8982a26357fb7d59_NewAttribute {User}</dev:code> <dev:remarks> <maml:para>This command gets the extension properties for the specified application in Microsoft Entra ID. You cane use the command `Get-EntraBetaApplication` to get application ID.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the unique identifier of an application.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationExtensionProperty</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationExtensionProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationExtensionProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationKeyCredential</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationKeyCredential</command:noun> <maml:description> <maml:para>Gets the key credentials for an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationKeyCredential` cmdlet retrieves the key credentials for an application. Specify `ObjectId` parameter to retrieve the key credentials for an application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationKeyCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>Specifies a unique ID of an application in Microsoft Entra ID to retrieve key credentials. Use `Get-EntraBetaApplication` for more details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>Specifies a unique ID of an application in Microsoft Entra ID to retrieve key credentials. Use `Get-EntraBetaApplication` for more details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Get key credentials ----------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" Get-EntraBetaApplicationKeyCredential -ObjectId $application.Id CustomKeyIdentifier DisplayName EndDateTime Key KeyId StartDateTime Type Usage ------------------- ----------- ----------- --- ----- ------------- ---- ----- {116, 101, 115, 116…} MyApp Cert 6/27/2024 11:49:17 AM bbbbbbbb-1c1c-2d2d-3e3e-444444444444 6/27/2023 11:29:17 AM AsymmetricX509Cert Verify</dev:code> <dev:remarks> <maml:para>This command gets the key credentials for the specified application. `-ObjectId` parameter specifies the ID of an application object in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationKeyCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationKeyCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationKeyCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationLogo</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationLogo</command:noun> <maml:description> <maml:para>Retrieve the logo of an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationLogo` cmdlet retrieves the logo that is set for an application. Specify the `ApplicationId` parameter to get a specific application logo for an application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationLogo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>If provided, the application logo is saved to the file using the specified file name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>If provided, the application logo is copied with a random filename to the file path that is specified in this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ApplicationId of the application for which the logo is to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>View</maml:name> <maml:description> <maml:para>If set to $true, the application's logo is displayed in a new window on the screen.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>If provided, the application logo is saved to the file using the specified file name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>If provided, the application logo is copied with a random filename to the file path that is specified in this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ApplicationId of the application for which the logo is to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>View</maml:name> <maml:description> <maml:para>If set to $true, the application's logo is displayed in a new window on the screen.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>- Example 1: Get an application logo for an application by ID -</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Helpdesk Application'" Get-EntraBetaApplicationLogo -ApplicationId $application.Id -FilePath 'D:\outfile1.jpg'</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve the application logo for an application that is specified through the Object ID parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationLogo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplicationLogo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationOwner</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationOwner</command:noun> <maml:description> <maml:para>Gets the owner of an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationOwner` cmdlet get an owner of an Microsoft Entra ID application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationOwner</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Get the owner of an application ----------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Helpdesk Application'" Get-EntraBetaApplicationOwner -ApplicationId $application.Id Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc cccccccc-2222-3333-4444-dddddddddddd dddddddd-3333-4444-5555-eeeeeeeeeeee eeeeeeee-4444-5555-6666-ffffffffffff</dev:code> <dev:remarks> <maml:para>This example demonstrates how to get the owners of an application in Microsoft Entra ID.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the unique identifier of an application.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 2: Get the details about the owner of an application -</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -SearchString '<application-name>' $applicationOwners = Get-EntraBetaApplicationOwner -ObjectId $application.ObjectId $ownerDetails = $applicationOwners | ForEach-Object { $ownerDetail = Get-EntraBetaObjectByObjectId -ObjectIds $_.Id [PSCustomObject]@{ displayName = $ownerDetail.displayName Id = $ownerDetail.Id UserPrincipalName = $ownerDetail.UserPrincipalName UserType = $ownerDetail.UserType accountEnabled = $ownerDetail.accountEnabled } } $ownerDetails | Format-Table -Property displayName, Id, UserPrincipalName, UserType, accountEnabled -AutoSize displayName Id UserPrincipalName UserType accountEnabled ----------- -- ----------------- -------- -------------- Sawyer Miller bbbbbbbb-1111-2222-3333-cccccccccccc SawyerM@contoso.com Member True Adele Vance ec5813fb-346e-4a33-a014-b55ffee3662b AdeleV@contoso.com Member True</dev:code> <dev:remarks> <maml:para>This example demonstrates how to get the owners of an application in Microsoft Entra ID with more owner lookup details.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------- Example 3: Get all owners of an application ---------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Helpdesk Application'" Get-EntraBetaApplicationOwner -ApplicationId $application.Id -All Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc cccccccc-2222-3333-4444-dddddddddddd dddddddd-3333-4444-5555-eeeeeeeeeeee eeeeeeee-4444-5555-6666-ffffffffffff</dev:code> <dev:remarks> <maml:para>This example demonstrates how to get the all owners of a specified application in Microsoft Entra ID.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the unique identifier of an application.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------- Example 4: Get top two owners of an application -------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Helpdesk Application'" Get-EntraBetaApplicationOwner -ApplicationId $application.Id -Top 2 Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc cccccccc-2222-3333-4444-dddddddddddd</dev:code> <dev:remarks> <maml:para>This example demonstrates how to get the two owners of a specified application in Microsoft Entra ID.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the unique identifier of an application.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationOwner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaApplicationOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationPasswordCredential</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationPasswordCredential</command:noun> <maml:description> <maml:para>Gets the password credential for an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationPasswordCredential` cmdlet receives the password credentials for a Microsoft Entra ID application. Specify `ApplicationId` parameter to cmdlet receives the password credentials.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationPasswordCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The objectID of the application for which to get the password credential. Use `Get-EntraBetaApplication` for more details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The objectID of the application for which to get the password credential. Use `Get-EntraBetaApplication` for more details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>- Example 1: Get password credential for specified application -</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" Get-EntraBetaApplicationPasswordCredential -ApplicationId $application.Id CustomKeyIdentifier DisplayName EndDateTime Hint KeyId SecretText StartDateTime ------------------- ----------- ----------- ---- ----- ---------- ------------- {100, 101, 109, 111} demo 26/07/2025 10:34:40 Ap6 bbbbbbbb-1111-2222-3333-cccccccccccc 26/07/2024 10:34:40</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve the password credential for specified application.</maml:para> <maml:para>- `-ApplicationId` specifies the ID of an application object in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationPasswordCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationPasswordCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationPasswordCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationPolicy</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationPolicy</command:noun> <maml:description> <maml:para>Gets an application policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationPolicy` cmdlet gets a Microsoft Entra ID application policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the application for which you need to retrieve the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the application for which you need to retrieve the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Get an application policy -------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' Get-EntraBetaApplicationPolicy -Id 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' Definition DeletedDateTime Description DisplayName Id ---------- --------------- ----------- ----------- -- {{"activityBasedTimeoutPolicies":{"AlternateLoginIDLookup":true, "IncludedUserIds":["UserID"]}}} NewUpdated aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb</dev:code> <dev:remarks> <maml:para>This command gets the specified application policy.</maml:para> <maml:para>- `-Id` Parameter Specifies the ID of the application for which you need to retrieve the policy.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaApplicationPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationProxyApplication</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationProxyApplication</command:noun> <maml:description> <maml:para>Retrieves an application configured for Application Proxy in Microsoft Entra ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationProxyApplication` cmdlet retrieves an application configured for Application Proxy in Microsoft Entra ID. Specify `ApplicationId` parameter to retrieve application configured for application proxy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationProxyApplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ApplicationId is a unique identifier for the application. You can find it using the `Get-EntraBetaApplication` command in PowerShell, or in the Microsoft Entra admin portal by navigating to Entra ID > Enterprise Applications > All Applications , selecting your application, and viewing the Properties tab. Use the `ObjectId` value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ApplicationId is a unique identifier for the application. You can find it using the `Get-EntraBetaApplication` command in PowerShell, or in the Microsoft Entra admin portal by navigating to Entra ID > Enterprise Applications > All Applications , selecting your application, and viewing the Properties tab. Use the `ObjectId` value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Retrieves an application configured for Application Proxy</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso App Proxy'" Get-EntraBetaApplicationProxyApplication -ApplicationId $application.Id AlternateUrl ApplicationServerTimeout ApplicationType ExternalAuthenticationType ExternalUrl ------------ ------------------------ --------------- -------------------------- ----------- Long enterpriseapp aadPreAuthentication https://testp-m365x99297270.msapppr...</dev:code> <dev:remarks> <maml:para>This example retrieves an application configured for Application Proxy.</maml:para> <maml:para>- `ApplicationId` parameter specifies the application ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationProxyApplication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationProxyApplicationConnectorGroup</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationProxyApplicationConnectorGroup</command:noun> <maml:description> <maml:para>The `Get-EntraBetaApplicationProxyApplicationConnectorGroup` cmdlet retrieves the connector group assigned for a specific application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationProxyApplicationConnectorGroup` cmdlet retrieves the connector group assigned for the specified application. The application must be configured for Application Proxy in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationProxyApplicationConnectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>ObjectId is the ID of the application. This ObjectId can be found using the `Get-EntraBetaApplication` command. You can also find this ObjectId in the Microsoft Portal by navigating to Microsoft Entra ID, Enterprise Applications, All Applications, Select your application, go to the properties tab, and use the ObjectId on that page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>ObjectId is the ID of the application. This ObjectId can be found using the `Get-EntraBetaApplication` command. You can also find this ObjectId in the Microsoft Portal by navigating to Microsoft Entra ID, Enterprise Applications, All Applications, Select your application, go to the properties tab, and use the ObjectId on that page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: retrieves the connector group assigned for the specified application</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso App Proxy'" Get-EntraBetaApplicationProxyApplicationConnectorGroup -ObjectId $application.Id Id Name ConnectorGroupType IsDefault -- ---- ------------------ --------- bbbbbbbb-1111-2222-3333-cccccccccccc test-group applicationProxy False</dev:code> <dev:remarks> <maml:para>This example retrieves the connector group assigned for the specified application.</maml:para> <maml:para>- `ObjectId` parameter specifies the application ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationProxyApplicationConnectorGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplicationProxyApplicationConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationProxyApplicationConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationProxyConnector</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationProxyConnector</command:noun> <maml:description> <maml:para>The `Get-EntraBetaApplicationProxyConnector` cmdlet a list of all connectors, or if specified, details of a specific connector.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationProxyConnector` cmdlet retrieves the details for a given connector. If no connectorId is specified, it retrieves all the connectors assigned to the tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationProxyConnector</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned. Details on querying with oData can be found here: <https://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol/#queryingcollections></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationProxyConnector</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The ID of the specific connector. You can find this ID by running the command without this parameter to get the desired ID, or by going into the portal and viewing connector details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationProxyConnector</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Specifies a search string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned. Details on querying with oData can be found here: <https://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol/#queryingcollections></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The ID of the specific connector. You can find this ID by running the command without this parameter to get the desired ID, or by going into the portal and viewing connector details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Specifies a search string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>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]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1: Retrieve all connectors --------------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnector Id DeletedDateTime -- --------------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb</dev:code> <dev:remarks> <maml:para>This command Retrieve all connectors.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--- Example 2: Retrieve information for a specific connector ---</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnector -OnPremisesPublishingProfileId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' Id DeletedDateTime -- --------------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb</dev:code> <dev:remarks> <maml:para>This example demonstrates how to Retrieve information for a specific connector.</maml:para> <maml:para>- `OnPremisesPublishingProfileId` parameter specifies the connector ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--- Example 3: Retrieve information for a top one connector ---</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnector -Top 1 Id DeletedDateTime -- --------------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb</dev:code> <dev:remarks> <maml:para>This example demonstrates how to Retrieve information for a top one connector.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 4: Retrieve information with SearchString parameter -</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnector -SearchString 'Entra PowerShell AppProxy Connector' Id DeletedDateTime -- --------------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb</dev:code> <dev:remarks> <maml:para>This example demonstrates how to Retrieve information using SearchString.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 5: Retrieve information using machineName property --</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnector -Filter "machineName eq 'AppProxy Machine'" Id DeletedDateTime -- --------------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb</dev:code> <dev:remarks> <maml:para>This example demonstrates how to Retrieve information using machineName property.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationProxyConnector</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplicationProxyConnector</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationProxyConnectorGroup</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationProxyConnectorGroup</command:noun> <maml:description> <maml:para>The `Get-EntraBetaApplicationProxyConnectorGroup` cmdlet retrieves a list of all connector groups, or if specified, details of a specific connector group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationProxyConnectorGroup` cmdlet retrieves a list of all connector groups, or if specified, details of the specified connector group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationProxyConnectorGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned. Details on querying with oData can be found here: <https://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol/#queryingcollections></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationProxyConnectorGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the specific connector group. You can find this ID by running the command without this parameter to get the desired ID, or by going into the portal and viewing connector group details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationProxyConnectorGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Specifies the search string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned. Details on querying with oData can be found here: <https://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol/#queryingcollections></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the specific connector group. You can find this ID by running the command without this parameter to get the desired ID, or by going into the portal and viewing connector group details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Specifies the search string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>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]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Retrieve all connector groups -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnectorGroup Id ConnectorGroupType IsDefault Name Region -- ------------------ --------- ---- ------ bbbbbbbb-1111-2222-3333-cccccccccccc applicationProxy False Test eur aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb applicationProxy True Default eur</dev:code> <dev:remarks> <maml:para>This example retrieves all connector groups.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 2: Retrieve a specific connector group --------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnectorGroup -Id 'bbbbbbbb-1111-2222-3333-cccccccccccc' Name Value ---- ----- Id ConnectorGroupType IsDefault Name Region -- ------------------ --------- ---- ------ bbbbbbbb-1111-2222-3333-cccccccccccc applicationProxy False Test eur</dev:code> <dev:remarks> <maml:para>This example retrieves a specific connector group.</maml:para> <maml:para>- `Id` parameter specifies the connector group ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------- Example 3: Retrieve Top one connector groups ---------</maml:title> <dev:code>Get-EntraBetaApplicationProxyConnectorGroup -Top 1 Id ConnectorGroupType IsDefault Name Region -- ------------------ --------- ---- ------ bbbbbbbb-1111-2222-3333-cccccccccccc applicationProxy False Test eur</dev:code> <dev:remarks> <maml:para>This example retrieves top one connector groups.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 4: Retrieve a connector groups with filter parameter -</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnectorGroup -Filter "name eq 'Default'" Id ConnectorGroupType IsDefault Name Region -- ------------------ --------- ---- ------ aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb applicationProxy True Default eur</dev:code> <dev:remarks> <maml:para>This example retrieves a connector groups with filter parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 5: Retrieve a connector groups with String parameter -</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnectorGroup -SearchString 'Test' Id ConnectorGroupType IsDefault Name Region -- ------------------ --------- ---- ------ bbbbbbbb-1111-2222-3333-cccccccccccc applicationProxy False Test eur</dev:code> <dev:remarks> <maml:para>This example retrieves a connector groups with String parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationProxyConnectorGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationProxyConnectorGroupMembers</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationProxyConnectorGroupMembers</command:noun> <maml:description> <maml:para>The `Get-EntraBetaApplicationProxyConnectorGroupMembers` get all the Application Proxy connectors associated with the given connector group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationProxyConnectorGroupMembers` get all the Application Proxy connectors associated with the given connector group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationProxyConnectorGroupMembers</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned. Details on querying with oData can be found here: <https://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol/#queryingcollections></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The ID of the Connector group. This ID can be found by running the `Get-EntraBetaApplicationProxyConnectorGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned. Details on querying with oData can be found here: <https://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol/#queryingcollections></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The ID of the Connector group. This ID can be found by running the `Get-EntraBetaApplicationProxyConnectorGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>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]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------- Example 1: Gets all the connectors in the group -------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnectorGroupMembers -OnPremisesPublishingProfileId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' Id ExternalIP MachineName Status Version -- ---------- ----------- ------ ------- bbbbbbbb-1111-2222-3333-cccccccccccc 106.195.6.123 AppProxy Machine active 1.5.3437.0</dev:code> <dev:remarks> <maml:para>This example retrieves all the connectors in the group.</maml:para> <maml:para>- `OnPremisesPublishingProfileId` parameter specifies the connector group ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 2: Gets top one connector in the group --------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnectorGroupMembers -OnPremisesPublishingProfileId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -Top 1 Id ExternalIP MachineName Status Version -- ---------- ----------- ------ ------- bbbbbbbb-1111-2222-3333-cccccccccccc 106.195.6.123 AppProxy Machine active 1.5.3437.0</dev:code> <dev:remarks> <maml:para>This example retrieves top one connector in the group.</maml:para> <maml:para>- `OnPremisesPublishingProfileId` parameter specifies the connector group ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Gets the connectors in the group with filter parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $params = @{ OnPremisesPublishingProfileId = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' Filter = "machineName eq 'AppProxy Machine'" } Get-EntraBetaApplicationProxyConnectorGroupMembers @params Id ExternalIP MachineName Status Version -- ---------- ----------- ------ ------- bbbbbbbb-1111-2222-3333-cccccccccccc 106.195.6.123 AppProxy Machine active 1.5.3437.0</dev:code> <dev:remarks> <maml:para>This example retrieves a connector in the group using machineName property.</maml:para> <maml:para>- `OnPremisesPublishingProfileId` parameter specifies the connector group ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationProxyConnectorGroupMembers</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationProxyConnectorMemberOf</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationProxyConnectorMemberOf</command:noun> <maml:description> <maml:para>The `Get-EntraBetaApplicationProxyConnectorMemberOf` command gets the ConnectorGroup that the specified Connector is a member of.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationProxyConnectorMemberOf` command gets the ConnectorGroup that the specified Connector is a member of. If no group is assigned to the connector, by default it is in 'Default.'</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationProxyConnectorMemberOf</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The ID of the connector. You can find ID by running `Get-EntraBetaApplicationProxyConnector`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The ID of the connector. You can find ID by running `Get-EntraBetaApplicationProxyConnector`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-- Example 1: Gets ConnectorGroup With Specified Connector ID --</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaApplicationProxyConnectorMemberOf -OnPremisesPublishingProfileId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' Id ConnectorGroupType IsDefault Name Region -- ------------------ --------- ---- ------ bbbbbbbb-1111-2222-3333-cccccccccccc applicationProxy False Backup Application Servers</dev:code> <dev:remarks> <maml:para>This example retrieves the ConnectorGroup With Specified Connector ID. - `-OnPremisesPublishingProfileId` parameter specifies the connector ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationProxyConnectorMemberOf</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationProxyConnector</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationServiceEndpoint</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationServiceEndpoint</command:noun> <maml:description> <maml:para>Retrieve the service endpoint of an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationServiceEndpoint` cmdlet retrieves the service endpoint(s) of an application.</maml:para> <maml:para>The service endpoint entity contains service discovery information. The serviceEndpoints property of the Application entity is of type ServiceEndpoint.</maml:para> <maml:para>Other services can use the information stored in the ServiceEndpoint entity to find this service and its addressable endpoints.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationServiceEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Return all service endpoints.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the object ID of the application for which the service endpoint is retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of results that are returned. The default is 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Return all service endpoints.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the object ID of the application for which the service endpoint is retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of results that are returned. The default is 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>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]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-- Example 1: Retrieve the application service endpoint by ID --</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "DisplayName eq 'Contoso Helpdesk App'" Get-EntraBetaApplicationServiceEndpoint -ServicePrincipalId $servicePrincipal.Id</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve service endpoint of the application that is specified through the Object ID parameter.</maml:para> <maml:para>`-ServicePrincipalId` parameter specifies the ID of an application object in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------- Example 2: Get all service endpoints -------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "DisplayName eq 'Contoso Helpdesk App'" Get-EntraBetaApplicationServiceEndpoint -ServicePrincipalId $servicePrincipal.Id -All</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve all service endpoints of a specified application.</maml:para> <maml:para>`-ServicePrincipalId` parameter specifies the ID of an application object in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 3: Get top five service endpoints ----------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "DisplayName eq 'Contoso Helpdesk App'" Get-EntraBetaApplicationServiceEndpoint -ServicePrincipalId $servicePrincipal.Id -Top 5</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve five service endpoints of a specified application.</maml:para> <maml:para>`-ServicePrincipalId` parameter specifies the ID of an application object in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaApplicationTemplate</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaApplicationTemplate</command:noun> <maml:description> <maml:para>Retrieve a list of applicationTemplate objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaApplicationTemplate` cmdlet allows users to get a list of all the application templates or a specific application template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaApplicationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of an application template.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of an application template.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Online.Administration.ApplicationTemplate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---- Example 1. Gets a list of application template objects ----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaApplicationTemplate</dev:code> <dev:remarks> <maml:para>This command gets all the application template objects</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 2. Gets an application template object --------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $applicationTemplate = Get-EntraBetaApplicationTemplate -Filter "DisplayName eq 'Dynamics CRM Online'" Get-EntraBetaApplicationTemplate -Id $applicationTemplate.Id Id Categories Description -- ---------- ----------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb {businessMgmt, productivity, projectManagement} Cube is perfect for businesses</dev:code> <dev:remarks> <maml:para>This command gets an application template object for the given id.</maml:para> <maml:para>- `-Id` Specifies the unique identifier of an application template.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaApplicationTemplate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDeletedApplication</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDeletedApplication</command:noun> <maml:description> <maml:para>Retrieves the list of previously deleted applications.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDeletedApplication` cmdlet Retrieves the list of previously deleted applications.</maml:para> <maml:para>Note: Deleted security groups are permanently removed and cannot be retrieved.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDeletedApplication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Retrieve only those deleted applications that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>The maximum number of applications returned by this cmdlet. The default value is 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaDeletedApplication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Retrieve only those applications that satisfy the -SearchString value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Retrieve only those deleted applications that satisfy the filter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Retrieve only those applications that satisfy the -SearchString value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>The maximum number of applications returned by this cmdlet. The default value is 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>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]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Get list of deleted applications ---------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaDeletedApplication DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- TestApp1 aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb bbbbbbbb-1111-2222-3333-cccccccccccc AzureADMyOrg contoso.com TestApp2 cccccccc-4444-5555-6666-dddddddddddd dddddddd-5555-6666-7777-eeeeeeeeeeee AzureADMyOrg contoso.com TestApp3 eeeeeeee-6666-7777-8888-ffffffffffff ffffffff-7777-8888-9999-gggggggggggg AzureADMyOrg contoso.com TestApp4 gggggggg-8888-9999-aaaa-hhhhhhhhhhhh hhhhhhhh-9999-aaaa-bbbb-iiiiiiiiiiii AzureADMyOrg contoso.com</dev:code> <dev:remarks> <maml:para>This cmdlet retrieves the list of deleted applications. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get list of deleted applications using All parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaDeletedApplication -All DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- TestApp1 aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb bbbbbbbb-1111-2222-3333-cccccccccccc AzureADMyOrg contoso.com TestApp2 cccccccc-4444-5555-6666-dddddddddddd dddddddd-5555-6666-7777-eeeeeeeeeeee AzureADMyOrg contoso.com TestApp3 eeeeeeee-6666-7777-8888-ffffffffffff ffffffff-7777-8888-9999-gggggggggggg AzureADMyOrg contoso.com TestApp4 gggggggg-8888-9999-aaaa-hhhhhhhhhhhh hhhhhhhh-9999-aaaa-bbbb-iiiiiiiiiiii AzureADMyOrg contoso.com</dev:code> <dev:remarks> <maml:para>This cmdlet retrieves the list of deleted applications using All parameter. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------- Example 3: Get top two deleted applications ---------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaDeletedApplication -Top 2 DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- TestApp1 aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb bbbbbbbb-1111-2222-3333-cccccccccccc AzureADMyOrg contoso.com TestApp2 cccccccc-4444-5555-6666-dddddddddddd dddddddd-5555-6666-7777-eeeeeeeeeeee AzureADMyOrg contoso.com</dev:code> <dev:remarks> <maml:para>This cmdlet retrieves top two deleted applications.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Get deleted applications using SearchString parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaDeletedApplication -SearchString 'TestApp1' DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- TestApp1 aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb bbbbbbbb-1111-2222-3333-cccccccccccc AzureADMyOrg contoso.com</dev:code> <dev:remarks> <maml:para>This cmdlet retrieves deleted applications using SearchString parameter. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 5: Get deleted applications filter by display name --</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaDeletedApplication -Filter "DisplayName eq 'TestApp1'" DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- TestApp1 aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb bbbbbbbb-1111-2222-3333-cccccccccccc AzureADMyOrg contoso.com</dev:code> <dev:remarks> <maml:para>This cmdlet retrieves deleted applications having specified display name. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title> Example 6: Get deleted applications with deletion age in days </maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaDeletedApplication | Select-Object DisplayName, Id, AppId, SignInAudience, PublisherDomain, DeletedDateTime, @{Name='DeletionAgeInDays'; Expression={(Get-Date) - $_.DeletedDateTime | Select-Object -ExpandProperty Days}} | Format-Table -AutoSize DisplayName Id AppId SignInAudience PublisherDomain DeletedDateTime DeletionAgeInDays ----------- -- ----- -------------- --------------- --------------- ----------------- Entra PowerShell App aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb bbbbbbbb-1111-2222-3333-cccccccccccc AzureADMyOrg contoso.com 9/18/2024 7:41:44 AM 1</dev:code> <dev:remarks> <maml:para>This cmdlet retrieves deleted applications with deletion age in days.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDeletedApplication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaPasswordSingleSignOnCredential</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaPasswordSingleSignOnCredential</command:noun> <maml:description> <maml:para>Gets the password Single-Sign-On (SSO) credentials.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet enables users to read their Password Single-Sign-On credentials for an application that they're part of. Specify `ObjectId` and `PasswordSSOCredential` parameters for retrieve SSO credentials. Admin could read the group credentials as well. Note that the password field is hidden for security purpose.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaPasswordSingleSignOnCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the object specific Microsoft Entra ID object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>PasswordSSOObjectId</maml:name> <maml:description> <maml:para>The ID of the user or group this credential set belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.PasswordSSOObjectId</command:parameterValue> <dev:type> <maml:name>System.PasswordSSOObjectId</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the object specific Microsoft Entra ID object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>PasswordSSOObjectId</maml:name> <maml:description> <maml:para>The ID of the user or group this credential set belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.PasswordSSOObjectId</command:parameterValue> <dev:type> <maml:name>System.PasswordSSOObjectId</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Online.Administration.PasswordSSOCredentials</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Get password single-sign-on credentials ------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Directory.ReadWrite.All' $servicePrincipal = Get-EntraBetaservicePrincipal -SearchString '<service-principal-name>' $params = @{ ObjectId = $servicePrincipal.Id PasswordSSOObjectId = 'bbbbbbbb-1111-2222-3333-cccccccccccc' } Get-EntraBetaPasswordSingleSignOnCredential @params Id -- cccccccc-2222-3333-4444-dddddddddddd</dev:code> <dev:remarks> <maml:para>This example returns a password SSO credential for the given ObjectId and PasswordSSOObjectId.</maml:para> <maml:para>- `PasswordSSOObjectId` parameter specifies the ID of the user or group this credential set belongs to.</maml:para> <maml:para>- `ObjectId` parameter specifies the ID of a service principal. You can use `Get-EntraBetaservicePrincipal` cmdlet to get service principal object ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaPasswordSingleSignOnCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaServicePrincipal</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaServicePrincipal</command:noun> <maml:description> <maml:para>Gets a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaServicePrincipal` cmdlet gets a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipal</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipal</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipal</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Specifies a search string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Specifies a search string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>- Example 1: Retrieve all service principal from the directory -</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaServicePrincipal DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Helpdesk Application aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMultipleOrgs Application Microsoft Device Management Checkin bbbbbbbb-1111-2222-3333-cccccccccccc 11112222-bbbb-3333-cccc-4444dddd5555 AzureADMultipleOrgs Application ProvisioningPowerBi cccccccc-2222-3333-4444-dddddddddddd 22223333-cccc-4444-dddd-5555eeee6666 Application</dev:code> <dev:remarks> <maml:para>This example retrieves all service principals from the directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title> Example 2: Retrieve a service principal by ServicePrincipalId </maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipal -ServicePrincipalId $servicePrincipal.Id DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Helpdesk Application aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMultipleOrgs Application</dev:code> <dev:remarks> <maml:para>This command retrieves specific service principal.</maml:para> <maml:para>- `-ServicePrincipalId` Parameter specifies the ID of a service principal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title> Example 3: Retrieve all service principals from the directory </maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaServicePrincipal -All DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Helpdesk Application aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMultipleOrgs Application Microsoft Device Management Checkin bbbbbbbb-1111-2222-3333-cccccccccccc 11112222-bbbb-3333-cccc-4444dddd5555 AzureADMultipleOrgs Application ProvisioningPowerBi cccccccc-2222-3333-4444-dddddddddddd 22223333-cccc-4444-dddd-5555eeee6666 Application</dev:code> <dev:remarks> <maml:para>This example retrieves all service principals from the directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Retrieve top two service principal from the directory</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaServicePrincipal -Top 2 DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Helpdesk Application aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMultipleOrgs Application Microsoft Device Management Checkin bbbbbbbb-1111-2222-3333-cccccccccccc 11112222-bbbb-3333-cccc-4444dddd5555 AzureADMultipleOrgs Application</dev:code> <dev:remarks> <maml:para>This command retrieves top two service principals from the directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 5: Get a service principal by display name ------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaServicePrincipal -Filter "DisplayName eq 'Helpdesk Application'" DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Helpdesk Application aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMultipleOrgs Application</dev:code> <dev:remarks> <maml:para>This example gets a service principal by its display name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 6: Retrieve a list of all service principal, which has a display name that contains "Helpdesk Application"</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaServicePrincipal -SearchString 'Helpdesk Application' DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Helpdesk Application aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMultipleOrgs Application</dev:code> <dev:remarks> <maml:para>This example gets a list of service principal, which has the specified display name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------- Example 7: Retrieve all Enterprise apps -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaServicePrincipal -Filter "tags/Any(x: x eq 'WindowsAzureActiveDirectoryIntegratedApp')" DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Enterprise App1 00001111-aaaa-2222-bbbb-3333cccc4444 33334444-dddd-5555-eeee-6666ffff7777 Application Enterprise App2 11112222-bbbb-3333-cccc-4444dddd5555 22223333-cccc-4444-dddd-5555eeee6666 AzureADMultipleOrgs Application</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve all enterprise apps.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------ Example 8: Retrieve all App proxy apps ------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaServicePrincipal -Filter "tags/Any(x: x eq 'WindowsAzureActiveDirectoryOnPremApp')" DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- App proxy 1 00001111-aaaa-2222-bbbb-3333cccc4444 33334444-dddd-5555-eeee-6666ffff7777 Application App proxy 2 11112222-bbbb-3333-cccc-4444dddd5555 22223333-cccc-4444-dddd-5555eeee6666 AzureADMultipleOrgs Application</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve all app proxy apps.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------ Example 9: Retrieve all disabled apps ------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaServicePrincipal -Filter "accountEnabled eq false" DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Disabled App1 00001111-aaaa-2222-bbbb-3333cccc4444 33334444-dddd-5555-eeee-6666ffff7777 Application</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve all disabled apps.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 10: Retrieve all Global Secure Access apps ------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaServicePrincipal -Filter "tags/Any(x: x eq 'PrivateAccessNonWebApplication') or tags/Any(x: x eq 'NetworkAccessManagedApplication')" DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Global secure access app 00001111-aaaa-2222-bbbb-3333cccc4444 33334444-dddd-5555-eeee-6666ffff7777 Application</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve all Global secure access apps.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 11: List all applications without user assignment --</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' Get-EntraBetaServicePrincipal -All | Where-Object {$_.appRoleAssignmentRequired -ne 'true'} DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- App without user assignment 00001111-aaaa-2222-bbbb-3333cccc4444 33334444-dddd-5555-eeee-6666ffff7777 Application</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve all applications without user assignment.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 12: List all SAML application details --------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "PreferredSingleSignOnMode eq 'saml'" $servicePrincipal | Select-Object Id, DisplayName, AccountEnabled, AppId, PreferredSingleSignOnMode, AppRoleAssignmentRequired, SignInAudience, NotificationEmailAddresses, PreferredTokenSigningKeyEndDateTime, PreferredTokenSigningKeyValid, ReplyUrls,LoginUrl, LogoutUrl | Format-Table -AutoSize Id DisplayName AccountEnabled AppId PreferredSingleSignOnMode AppRoleAssignmentRequired SignInAudience NotificationEmailAddresses -- ----------- -------------- ----- ------------------------- ------------------------- -------------- -------------- 00001111-aaaa-2222-bbbb-3333cccc4444 SAML App True 33334444-dddd-5555-eeee-6666ffff7777 saml True AzureADMyOrg {admin@Contoso}</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve all SAML application details.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaServicePrincipal</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaServicePrincipalAppRoleAssignedTo</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaServicePrincipalAppRoleAssignedTo</command:noun> <maml:description> <maml:para>Gets app role assignments for this app or service, granted to users, groups, and other service principals.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaServicePrincipalAppRoleAssignedTo` cmdlet gets app role assignments for this app or service, granted to users, groups, and other service principals.</maml:para> <maml:para>For delegated scenarios, the calling user needs at least one of the following Microsoft Entra roles.</maml:para> <maml:para>- Directory Synchronization Accounts</maml:para> <maml:para>- Directory Writer</maml:para> <maml:para>- Hybrid Identity Administrator</maml:para> <maml:para>- Identity Governance Administrator</maml:para> <maml:para>- Privileged Role Administrator</maml:para> <maml:para>- User Administrator</maml:para> <maml:para>- Application Administrator</maml:para> <maml:para>- Cloud Application Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipalAppRoleAssignedTo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>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]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>`Get-EntraBetaServiceAppRoleAssignedTo` is an alias for `Get-EntraBetaServicePrincipalAppRoleAssignedTo`.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Get app role assignment by ID -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalAppRoleAssignedTo -ServicePrincipalId $servicePrincipal.Id Id AppRoleId CreationTimestamp PrincipalDisplayName PrincipalId PrincipalType ResourceDisplayName ResourceId -- --------- ----------------- -------------------- ----------- ------------- ------------------- ---------- 1aaaaaa1-2bb2-3cc3-4dd4-5eeeeeeeeee5 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Helpdesk Application aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Helpdesk Application</dev:code> <dev:remarks> <maml:para>This example shows how to get app role assignments for an app or service, granted to users, groups, and other service principals.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------- Example 2: Get all app role assignments -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalAppRoleAssignedTo -ServicePrincipalId $servicePrincipal.Id -All Id AppRoleId CreationTimestamp PrincipalDisplayName PrincipalId PrincipalType ResourceDisplayName ResourceId -- --------- ----------------- -------------------- ----------- ------------- ------------------- ---------- 1aaaaaa1-2bb2-3cc3-4dd4-5eeeeeeeeee5 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box aaaa0000-bb11-2222-33cc-444444dddddd 2bbbbbb2-3cc3-4dd4-5ee5-6ffffffffff6 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box bbbb1111-cc22-3333-44dd-555555eeeeee 3cccccc3-4dd4-5ee5-6ff6-7aaaaaaaaaa7 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box cccc2222-dd33-4444-55ee-666666ffffff 4dddddd4-5ee5-6ff6-7aa7-8bbbbbbbbbb8 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box dddd3333-ee44-5555-66ff-777777aaaaaa 5eeeeee5-6ff6-7aa7-8bb8-9cccccccccc9 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box eeee4444-ff55-6666-77aa-888888bbbbbb</dev:code> <dev:remarks> <maml:para>This command gets the all app role assignments for the service principal granted to users, groups, and other service principals.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------- Example 3: Get five app role assignments -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalAppRoleAssignedTo -ServicePrincipalId $servicePrincipal.Id -Top 5 Id AppRoleId CreationTimestamp PrincipalDisplayName PrincipalId PrincipalType ResourceDisplayName ResourceId -- --------- ----------------- -------------------- ----------- ------------- ------------------- ---------- 1aaaaaa1-2bb2-3cc3-4dd4-5eeeeeeeeee5 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box aaaa0000-bb11-2222-33cc-444444dddddd 2bbbbbb2-3cc3-4dd4-5ee5-6ffffffffff6 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box bbbb1111-cc22-3333-44dd-555555eeeeee 3cccccc3-4dd4-5ee5-6ff6-7aaaaaaaaaa7 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box cccc2222-dd33-4444-55ee-666666ffffff 4dddddd4-5ee5-6ff6-7aa7-8bbbbbbbbbb8 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box dddd3333-ee44-5555-66ff-777777aaaaaa 5eeeeee5-6ff6-7aa7-8bb8-9cccccccccc9 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box eeee4444-ff55-6666-77aa-888888bbbbbb</dev:code> <dev:remarks> <maml:para>This command gets the five app role assignments for the service principal granted to users, groups, and other service principals.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaServicePrincipalAppRoleAssignedTo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipalAppRoleAssignment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaServicePrincipalAppRoleAssignment</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaServicePrincipalAppRoleAssignment</command:noun> <maml:description> <maml:para>Gets a service principal application role assignment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaServicePrincipalAppRoleAssignment` cmdlet gets a role assignment for a service principal application in Microsoft Entra ID.</maml:para> <maml:para>For delegated scenarios, the calling user needs at least one of the following Microsoft Entra roles.</maml:para> <maml:para>- Directory Synchronization Accounts</maml:para> <maml:para>- Directory Writer</maml:para> <maml:para>- Hybrid Identity Administrator</maml:para> <maml:para>- Identity Governance Administrator</maml:para> <maml:para>- Privileged Role Administrator</maml:para> <maml:para>- User Administrator</maml:para> <maml:para>- Application Administrator</maml:para> <maml:para>- Cloud Application Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipalAppRoleAssignment</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>The maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>The maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>`Get-EntraBetaServiceAppRoleAssignment` is an alias for `Get-EntraBetaServicePrincipalAppRoleAssignment`.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Retrieve the application role assignments for a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalAppRoleAssignment -ServicePrincipalId $servicePrincipal.Id Id AppRoleId CreationTimestamp PrincipalDisplayName PrincipalId PrincipalType ResourceDisplayName ResourceId -- --------- ----------------- -------------------- ----------- ------------- ------------------- ---------- 1aaaaaa1-2bb2-3cc3-4dd4-5eeeeeeeeee5 00000000-0000-0000-0000-000000000000 07-07-2023 17:03:59 MOD Administrator aaaaaaaa-bbbb-cccc-1111-222222222222 User ProvisioningPowerBi 021510b7-e753-40…</dev:code> <dev:remarks> <maml:para>This command gets application role assignments for specified service principal. You can use the command `Get-EntraBetaServicePrincipal` to get service principal Id.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Retrieve all application role assignments for a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalAppRoleAssignment -ServicePrincipalId $servicePrincipal.Id -All Id AppRoleId CreationTimestamp PrincipalDisplayName PrincipalId PrincipalType ResourceDisplayName ResourceId -- --------- ----------------- -------------------- ----------- ------------- ------------------- ---------- 1aaaaaa1-2bb2-3cc3-4dd4-5eeeeeeeeee5 00000000-0000-0000-0000-000000000000 07-07-2023 17:03:59 MOD Administrator aaaaaaaa-bbbb-cccc-1111-222222222222 User ProvisioningPowerBi 021510b7-e753-40… 2bbbbbb2-3cc3-4dd4-5ee5-6ffffffffff6 00000000-0000-0000-0000-000000000000 07-07-2023 17:03:59 MOD Administrator aaaaaaaa-bbbb-cccc-1111-222222222222 User1 ProvisioningPowerBi 021510b7-e753-40… 3cccccc3-4dd4-5ee5-6ff6-7aaaaaaaaaa7 00000000-0000-0000-0000-000000000000 07-07-2023 17:03:59 MOD Administrator aaaaaaaa-bbbb-cccc-1111-222222222222 User2 ProvisioningPowerBi 021510b7-e753-40… 4dddddd4-5ee5-6ff6-7aa7-8bbbbbbbbbb8 00000000-0000-0000-0000-000000000000 07-07-2023 17:03:59 MOD Administrator aaaaaaaa-bbbb-cccc-1111-222222222222 User3 ProvisioningPowerBi 021510b7-e753-40… 5eeeeee5-6ff6-7aa7-8bb8-9cccccccccc9 00000000-0000-0000-0000-000000000000 07-07-2023 17:03:59 MOD Administrator aaaaaaaa-bbbb-cccc-1111-222222222222 User4 ProvisioningPowerBi 021510b7-e753-40…</dev:code> <dev:remarks> <maml:para>This command gets all application role assignments for specified service principal.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Retrieve the top three application role assignments for a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalAppRoleAssignment -ServicePrincipalId $servicePrincipal.Id -Top 3 Id AppRoleId CreationTimestamp PrincipalDisplayName PrincipalId PrincipalType ResourceDisplayName ResourceId -- --------- ----------------- -------------------- ----------- ------------- ------------------- ---------- 1aaaaaa1-2bb2-3cc3-4dd4-5eeeeeeeeee5 00000000-0000-0000-0000-000000000000 07-07-2023 17:03:59 MOD Administrator aaaaaaaa-bbbb-cccc-1111-222222222222 User ProvisioningPowerBi 021510b7-e753-40… 2bbbbbb2-3cc3-4dd4-5ee5-6ffffffffff6 00000000-0000-0000-0000-000000000000 07-07-2023 17:03:59 MOD Administrator aaaaaaaa-bbbb-cccc-1111-222222222222 User1 ProvisioningPowerBi 021510b7-e753-40… 3cccccc3-4dd4-5ee5-6ff6-7aaaaaaaaaa7 00000000-0000-0000-0000-000000000000 07-07-2023 17:03:59 MOD Administrator aaaaaaaa-bbbb-cccc-1111-222222222222 User2 ProvisioningPowerBi 021510b7-e753-40…</dev:code> <dev:remarks> <maml:para>This command gets top three application role assignments for specified service principal.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaServicePrincipalAppRoleAssignment</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaServicePrincipalAppRoleAssignment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaServicePrincipalAppRoleAssignment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaServicePrincipalCreatedObject</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaServicePrincipalCreatedObject</command:noun> <maml:description> <maml:para>Get objects created by a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaServicePrincipalCreatedObject` cmdlet gets an object created by a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipalCreatedObject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Retrieve the objects that created by a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalCreatedObject -ServicePrincipalId $servicePrincipal.Id</dev:code> <dev:remarks> <maml:para>This example gets objects created by the service principal identified by $ServicePrincipalId. You can use the command `Get-EntraBetaServicePrincipal` to get service principal ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Retrieve the all objects created by a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalCreatedObject -ServicePrincipalId $servicePrincipal.Id -All</dev:code> <dev:remarks> <maml:para>This example demonstrates how to get the all object created by a specified service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Retrieve the top two objects created by a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalCreatedObject -ServicePrincipalId $servicePrincipal.Id -Top 2</dev:code> <dev:remarks> <maml:para>This example demonstrates how to get the top two object created by a specified service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaServicePrincipalCreatedObject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaServicePrincipalDelegatedPermissionClassification</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaServicePrincipalDelegatedPermissionClassification</command:noun> <maml:description> <maml:para>Retrieve the delegated permission classification objects on a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaServicePrincipalDelegatedPermissionClassification` cmdlet retrieves the delegated permission classifications from a service principal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>The unique identifier of a service principal object in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of a delegated permission classification object ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>The unique identifier of a service principal object in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The OData v4.0 filter statement. Controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>The unique identifier of a service principal object in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of a delegated permission classification object ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The OData v4.0 filter statement. Controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Online.Administration.DelegatedPermissionClassification</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> Example 1: Get a list of delegated permission classifications </maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalDelegatedPermissionClassification -ServicePrincipalId $servicePrincipal.Id Id Classification PermissionId PermissionName -- -------------- ------------ -------------- bbbbbbbb-7777-8888-9999-cccccccccccc low eeeeeeee-4444-5555-6666-ffffffffffff Sites.Read.All cccccccc-8888-9999-0000-dddddddddddd low dddd3333-ee44-5555-66ff-777777aaaaaa profile</dev:code> <dev:remarks> <maml:para>This command retrieves all delegated permission classifications from the service principal.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the unique identifier of a service principal. Use `Get-EntraBetaServicePrincipal` to get more details.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---- Example 2: Get a delegated permission classifications ----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" $permissionClassification = Get-EntraBetaServicePrincipalDelegatedPermissionClassification -ServicePrincipalId $servicePrincipal.Id -Filter "PermissionName eq 'Sites.Read.All'" Get-EntraBetaServicePrincipalDelegatedPermissionClassification -ServicePrincipalId $servicePrincipal.Id -Id $permissionClassification.Id Id Classification PermissionId PermissionName -- -------------- ------------ -------------- bbbbbbbb-7777-8888-9999-cccccccccccc low eeeeeeee-4444-5555-6666-ffffffffffff Sites.Read.All</dev:code> <dev:remarks> <maml:para>This command retrieves the delegated permission classification by Id from the service principal.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the unique identifier of a service principal. Use `Get-EntraBetaServicePrincipal` to get more details.</maml:para> <maml:para>- `-Id` parameter specifies the delegated permission classification object Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Get a delegated permission classification with filter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalDelegatedPermissionClassification -ServicePrincipalId $servicePrincipal.Id -Filter "PermissionName eq 'Sites.Read.All'" Id Classification PermissionId PermissionName -- -------------- ------------ -------------- bbbbbbbb-7777-8888-9999-cccccccccccc low eeeeeeee-4444-5555-6666-ffffffffffff Sites.Read.All</dev:code> <dev:remarks> <maml:para>This command retrieves the filtered delegated permission classifications from the service principal.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the unique identifier of a service principal. Use `Get-EntraBetaServicePrincipal` to get more details.</maml:para> <maml:para>- `-Id` parameter specifies the delegated permission classification object Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaServicePrincipalKeyCredential</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaServicePrincipalKeyCredential</command:noun> <maml:description> <maml:para>Get key credentials for a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaServicePrincipalKeyCredential` cmdlet gets the key credentials for a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipalKeyCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of the application for which to get the password credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of the application for which to get the password credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> Example 1: Retrieve the key credential of a service principal </maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalKeyCredential -ServicePrincipalId $servicePrincipal.Id CustomKeyIdentifier DisplayName EndDateTime Key KeyId StartDateTime Type Usage ------------------- ----------- ----------- --- ----- ------------- ---- ----- 08-02-2025 09:57:08 68b45e27-fef8-4f0d-bc7a-76bd949c16d1 08-02-2024 09:57:08 Symmetric Sign</dev:code> <dev:remarks> <maml:para>This example retrieves the key credentials for specified service principal in Microsoft Entra ID. You can use the command `Get-EntraBetaServicePrincipal` to get a service principal object Id.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaServicePrincipalKeyCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaServicePrincipalMembership</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaServicePrincipalMembership</command:noun> <maml:description> <maml:para>Get a service principal membership.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaServicePrincipalMembership` cmdlet gets the memberships of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipalMembership</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-- Example 1: Retrieve the memberships of a service principal --</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalMembership -ServicePrincipalId $servicePrincipal.Id Id DeletedDateTime -- --------------- 11112222-aaaa-3333-bbbb-4444cccc5555</dev:code> <dev:remarks> <maml:para>This cmdlet retrieves a specified service principal memberships in Microsoft Entra ID. You can use the command `Get-EntraBetaServicePrincipal` to get service principal ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 2: Retrieve all memberships of a service principal --</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalMembership -ServicePrincipalId $servicePrincipal.Id -All Id DeletedDateTime -- --------------- 11112222-aaaa-3333-bbbb-4444cccc5555 22223333-cccc-4444-dddd-5555eeee6666 33334444-dddd-5555-eeee-6666ffff7777</dev:code> <dev:remarks> <maml:para>This command gets all memberships of a specified service principal.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Retrieve top two memberships of a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalMembership -ServicePrincipalId $servicePrincipal.Id -Top 2 Id DeletedDateTime -- --------------- 11112222-aaaa-3333-bbbb-4444cccc5555 22223333-cccc-4444-dddd-5555eeee6666</dev:code> <dev:remarks> <maml:para>This command gets top two memberships of a specified service principal.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaServicePrincipalMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaServicePrincipalOAuth2PermissionGrant</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaServicePrincipalOAuth2PermissionGrant</command:noun> <maml:description> <maml:para>Gets an OAuth2PermissionGrant object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaServicePrincipalOAuth2PermissionGrant` cmdlet gets an OAuth2PermissionGrant object for a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipalOAuth2PermissionGrant</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Retrieve the OAuth2 permission grants of a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalOAuth2PermissionGrant -ServicePrincipalId $servicePrincipal.Id Id ClientId ConsentType PrincipalId ResourceId Scope -- -------- ----------- ----------- ---------- ----- A1bC2dE3f... 00001111-aaaa-2222-bbbb-3333cccc4444 AllPrincipals aaaaaaaa-bbbb-cccc-1111-222222222222 openid profile U...</dev:code> <dev:remarks> <maml:para>This cmdlet retrieves a OAuth2PermissionGrant object for a service principal in Microsoft Entra ID. You can use the command `Get-EntraBetaServicePrincipal` to get service principal Id.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get all OAuth2 permission grants of a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalOAuth2PermissionGrant -ServicePrincipalId $servicePrincipal.Id -All Id ClientId ConsentType PrincipalId ResourceId Scope -- -------- ----------- ----------- ---------- ----- A1bC2dE3f... 00001111-aaaa-2222-bbbb-3333cccc4444 AllPrincipals aaaaaaaa-bbbb-cccc-1111-222222222222 openid profile U... A1bC2dE3f... 00001111-aaaa-2222-bbbb-3333cccc4444 Principal 412be9d1-1460-4061-8eed-cca203fcb215 aaaaaaaa-bbbb-cccc-1111-222222222222 openid profile U... A1bC2dE3f... 00001111-aaaa-2222-bbbb-3333cccc4444 Principal 996d39aa-fdac-4d97-aa3d-c81fb47362ac aaaaaaaa-bbbb-cccc-1111-222222222222 PrivilegedAccess...</dev:code> <dev:remarks> <maml:para>This example demonstrates how to get all OAuth2PermissionGrant objects for a service principal in Microsoft Entra ID. - `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Get two OAuth2 permission grants of a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalOAuth2PermissionGrant -ServicePrincipalId $servicePrincipal.Id -Top 2 Id ClientId ConsentType PrincipalId ResourceId Scope -- -------- ----------- ----------- ---------- ----- A1bC2dE3f... 00001111-aaaa-2222-bbbb-3333cccc4444 Principal 412be9d1-1460-4061-8eed-cca203fcb215 aaaaaaaa-bbbb-cccc-1111-222222222222 openid profile U... A1bC2dE3f... 00001111-aaaa-2222-bbbb-3333cccc4444 Principal 996d39aa-fdac-4d97-aa3d-c81fb47362ac aaaaaaaa-bbbb-cccc-1111-222222222222 PrivilegedAccess...</dev:code> <dev:remarks> <maml:para>This example demonstrates how to get top two OAuth2PermissionGrant objects for a service principal in Microsoft Entra ID. - `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaServicePrincipalOAuth2PermissionGrant</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaServicePrincipalOwnedObject</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaServicePrincipalOwnedObject</command:noun> <maml:description> <maml:para>Gets an object owned by a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaServicePrincipalOwnedObject` cmdlet retrieves an object owned by a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipalOwnedObject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>- Example 1: Retrieve the owned objects of a service principal -</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalOwnedObject -ServicePrincipalId $ServicePrincipal.Id Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc</dev:code> <dev:remarks> <maml:para>The command retrieves the owned objects of a service principal.</maml:para> <maml:para>- `-ServicePrincipalId` Parameter specifies the ID of a service principal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Retrieve the all owned objects of a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalOwnedObject -ServicePrincipalId $ServicePrincipal.Id -All Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc cccccccc-2222-3333-4444-dddddddddddd</dev:code> <dev:remarks> <maml:para>This example retrieves an object owned by a service principal in Microsoft Entra ID. You can use the command `Get-EntraBetaServicePrincipal` to get service principal Id.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Retrieve top one owned object of a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalOwnedObject -ServicePrincipalId $ServicePrincipal.Id -Top 1 Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc</dev:code> <dev:remarks> <maml:para>This example retrieves the top one owned object of a specified service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaServicePrincipalOwnedObject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaServicePrincipalOwner</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaServicePrincipalOwner</command:noun> <maml:description> <maml:para>Get the owner of a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaServicePrincipalOwner` cmdlet gets the owners of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipalOwner</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Retrieve the owner of a service principal -----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalOwner -ServicePrincipalId $servicePrincipal.Id | Select-Object Id, userPrincipalName, DisplayName, '@odata.type' Id userPrincipalName displayName @odata.type -- ----------------- ----------- ----------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb AlexW@Contoso.com Alex Wilber #microsoft.graph.user bbbbbbbb-1111-2222-3333-cccccccccccc ChristieC@Contoso.com Christie Cline #microsoft.graph.user</dev:code> <dev:remarks> <maml:para>This example gets the owners of a specified service principal. You can use the command `Get-EntraBetaServicePrincipal` to get service principal object ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the unique identifier of a service principal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 2: Retrieve all the owners of a service principal --</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalOwner -ServicePrincipalId $servicePrincipal.Id -All | Select-Object Id, userPrincipalName, DisplayName, '@odata.type' Id userPrincipalName displayName @odata.type -- ----------------- ----------- ----------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb AlexW@Contoso.com Alex Wilber #microsoft.graph.user bbbbbbbb-1111-2222-3333-cccccccccccc ChristieC@Contoso.com Christie Cline #microsoft.graph.user</dev:code> <dev:remarks> <maml:para>This command gets all the owners of a service principal. You can use the command `Get-EntraBetaServicePrincipal` to get service principal object ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the unique identifier of a service principal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 3: Retrieve top two owners of a service principal --</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalOwner -ServicePrincipalId $servicePrincipal.Id -Top 2 | Select-Object Id, userPrincipalName, DisplayName, '@odata.type' Id userPrincipalName displayName @odata.type -- ----------------- ----------- ----------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb AlexW@Contoso.com Alex Wilber #microsoft.graph.user bbbbbbbb-1111-2222-3333-cccccccccccc ChristieC@Contoso.com Christie Cline #microsoft.graph.user</dev:code> <dev:remarks> <maml:para>This command gets top two owners of a service principal. You can use the command `Get-EntraBetaServicePrincipal` to get service principal object ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the unique identifier of a service principal.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaServicePrincipalOwner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaServicePrincipalOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaServicePrincipalOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaServicePrincipalPasswordCredential</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaServicePrincipalPasswordCredential</command:noun> <maml:description> <maml:para>Get credentials for a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaServicePrincipalPasswordCredential` cmdlet gets the password credentials for a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaServicePrincipalPasswordCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of the service principal for which to get password credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of the service principal for which to get password credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Retrieve the password credential of a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Get-EntraBetaServicePrincipalPasswordCredential -ServicePrincipalId $servicePrincipal.Id CustomKeyIdentifier DisplayName EndDateTime Hint KeyId SecretText StartDateTime ------------------- ----------- ----------- ---- ----- ---------- ------------- 17-04-2025 07:32:41 gjW bdf6a3df-cc9b-4612-b948-e32804ee88f7 17-04-2024 07:32:41 21-03-2025 08:12:08 4fl 7f4414ec-8f72-49a8-b949-70d635899656 21-03-2024 08:12:08 12-12-2024 08:39:07 mjl 0fff6b21-0a20-4f7c-93ba-26ed9b648344 12-12-2023 08:39:10</dev:code> <dev:remarks> <maml:para>This example retrieves the password credentials for specified service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the object ID of a service principal. You can use the command `Get-EntraBetaServicePrincipal` to get a service principal Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaServicePrincipalPasswordCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaServicePrincipalPasswordCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaServicePrincipalPasswordCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaApplication</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaApplication</command:noun> <maml:description> <maml:para>Creates (registers) a new application object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates (registers) a new application object. Specify the `DisplayName` parameter to create a new application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaApplication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AddIns</maml:name> <maml:description> <maml:para>Defines custom behavior that a consuming service can use to call an app in specific contexts.</maml:para> <maml:para>For example, applications that can render file streams may set the addIns property for its "FileHandler" functionality.</maml:para> <maml:para>This will let services like Office 365 call the application in the context of a document the user is working on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AddIn]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AddIn]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Api</maml:name> <maml:description> <maml:para>Specifies settings for an application that implements a web API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ApiApplication</command:parameterValue> <dev:type> <maml:name>ApiApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppRoles</maml:name> <maml:description> <maml:para>The collection of application roles that an application might declare. These roles can be assigned to users, groups, or service principals.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupMembershipClaims</maml:name> <maml:description> <maml:para>Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IdentifierUris</maml:name> <maml:description> <maml:para>User-defined URI(s) that uniquely identify a Web application within its Microsoft Entra ID tenant, or within a verified custom domain (see "Domains" tab in the Azure classic portal) if the application is multi-tenant.</maml:para> <maml:para>The first element is populated from the Web application's "APP ID URI" field if updated via the Azure classic portal (or respective Microsoft Entra ID PowerShell cmdlet parameter).</maml:para> <maml:para>Extra URIs can be added via the application manifest; see Understanding the Microsoft Entra ID Application Manifest for details. This collection is also used to populate the Web application's servicePrincipalNames collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InformationalUrl</maml:name> <maml:description> <maml:para>Basic profile information of the application such as app's marketing, support, terms of service and privacy statement URLs.</maml:para> <maml:para>The terms of service and privacy statement are surfaced to users through the user consent experience.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InformationalUrl</command:parameterValue> <dev:type> <maml:name>InformationalUrl</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsDeviceOnlyAuthSupported</maml:name> <maml:description> <maml:para>Specifies if the application supports authentication using a device token.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsFallbackPublicClient</maml:name> <maml:description> <maml:para>Specifies the fallback application type as public client, such as an installed application running on a mobile device.</maml:para> <maml:para>The default value is false that means the fallback application type is confidential client such as web app.</maml:para> <maml:para>There are certain scenarios where Microsoft Entra ID can't determine the client application type (for example, ROPC flow where it's configured without specifying a redirect URI).</maml:para> <maml:para>In those cases Microsoft Entra ID interprets the application type based on the value of this property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyCredentials</maml:name> <maml:description> <maml:para>The collection of key credentials associated with the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OptionalClaims</maml:name> <maml:description> <maml:para>Application developers can configure optional claims in their Microsoft Entra ID apps to specify which claims they want in tokens sent to their application by the Microsoft security token service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OptionalClaims</command:parameterValue> <dev:type> <maml:name>OptionalClaims</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrgRestrictions</maml:name> <maml:description> <maml:para>Reserved for future use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ParentalControlSettings</maml:name> <maml:description> <maml:para>Specifies parental control settings for an application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ParentalControlSettings</command:parameterValue> <dev:type> <maml:name>ParentalControlSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredentials</maml:name> <maml:description> <maml:para>The collection of password credentials associated with the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreAuthorizedApplications</maml:name> <maml:description> <maml:para>Lists applications and requested permissions for implicit consent. Requires an admin to have provided consent to the application.</maml:para> <maml:para>preAuthorizedApplications don't require the user to consent to the requested permissions. Permissions listed in preAuthorizedApplications don't require user consent.</maml:para> <maml:para>However, any additional requested permissions not listed in preAuthorizedApplications require user consent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PreAuthorizedApplication]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PreAuthorizedApplication]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublicClient</maml:name> <maml:description> <maml:para>Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PublicClientApplication</command:parameterValue> <dev:type> <maml:name>PublicClientApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RequiredResourceAccess</maml:name> <maml:description> <maml:para>Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources.</maml:para> <maml:para>This pre-configuration of required resource access drives the consent experience.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignInAudience</maml:name> <maml:description> <maml:para>Specifies what Microsoft accounts are supported for the current application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Custom strings that can be used to categorize and identify the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TokenEncryptionKeyId</maml:name> <maml:description> <maml:para>Specifies the keyId of a public key from the keyCredentials collection.</maml:para> <maml:para>When configured, Microsoft Entra ID encrypts all the tokens it emits by using the key this property points to.</maml:para> <maml:para>The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Web</maml:name> <maml:description> <maml:para>Specifies settings for a web application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebApplication</command:parameterValue> <dev:type> <maml:name>WebApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AddIns</maml:name> <maml:description> <maml:para>Defines custom behavior that a consuming service can use to call an app in specific contexts.</maml:para> <maml:para>For example, applications that can render file streams may set the addIns property for its "FileHandler" functionality.</maml:para> <maml:para>This will let services like Office 365 call the application in the context of a document the user is working on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AddIn]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AddIn]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Api</maml:name> <maml:description> <maml:para>Specifies settings for an application that implements a web API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ApiApplication</command:parameterValue> <dev:type> <maml:name>ApiApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppRoles</maml:name> <maml:description> <maml:para>The collection of application roles that an application might declare. These roles can be assigned to users, groups, or service principals.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupMembershipClaims</maml:name> <maml:description> <maml:para>Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IdentifierUris</maml:name> <maml:description> <maml:para>User-defined URI(s) that uniquely identify a Web application within its Microsoft Entra ID tenant, or within a verified custom domain (see "Domains" tab in the Azure classic portal) if the application is multi-tenant.</maml:para> <maml:para>The first element is populated from the Web application's "APP ID URI" field if updated via the Azure classic portal (or respective Microsoft Entra ID PowerShell cmdlet parameter).</maml:para> <maml:para>Extra URIs can be added via the application manifest; see Understanding the Microsoft Entra ID Application Manifest for details. This collection is also used to populate the Web application's servicePrincipalNames collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InformationalUrl</maml:name> <maml:description> <maml:para>Basic profile information of the application such as app's marketing, support, terms of service and privacy statement URLs.</maml:para> <maml:para>The terms of service and privacy statement are surfaced to users through the user consent experience.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InformationalUrl</command:parameterValue> <dev:type> <maml:name>InformationalUrl</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsDeviceOnlyAuthSupported</maml:name> <maml:description> <maml:para>Specifies if the application supports authentication using a device token.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsFallbackPublicClient</maml:name> <maml:description> <maml:para>Specifies the fallback application type as public client, such as an installed application running on a mobile device.</maml:para> <maml:para>The default value is false that means the fallback application type is confidential client such as web app.</maml:para> <maml:para>There are certain scenarios where Microsoft Entra ID can't determine the client application type (for example, ROPC flow where it's configured without specifying a redirect URI).</maml:para> <maml:para>In those cases Microsoft Entra ID interprets the application type based on the value of this property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyCredentials</maml:name> <maml:description> <maml:para>The collection of key credentials associated with the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OptionalClaims</maml:name> <maml:description> <maml:para>Application developers can configure optional claims in their Microsoft Entra ID apps to specify which claims they want in tokens sent to their application by the Microsoft security token service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OptionalClaims</command:parameterValue> <dev:type> <maml:name>OptionalClaims</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrgRestrictions</maml:name> <maml:description> <maml:para>Reserved for future use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ParentalControlSettings</maml:name> <maml:description> <maml:para>Specifies parental control settings for an application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ParentalControlSettings</command:parameterValue> <dev:type> <maml:name>ParentalControlSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredentials</maml:name> <maml:description> <maml:para>The collection of password credentials associated with the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreAuthorizedApplications</maml:name> <maml:description> <maml:para>Lists applications and requested permissions for implicit consent. Requires an admin to have provided consent to the application.</maml:para> <maml:para>preAuthorizedApplications don't require the user to consent to the requested permissions. Permissions listed in preAuthorizedApplications don't require user consent.</maml:para> <maml:para>However, any additional requested permissions not listed in preAuthorizedApplications require user consent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PreAuthorizedApplication]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PreAuthorizedApplication]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublicClient</maml:name> <maml:description> <maml:para>Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PublicClientApplication</command:parameterValue> <dev:type> <maml:name>PublicClientApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RequiredResourceAccess</maml:name> <maml:description> <maml:para>Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources.</maml:para> <maml:para>This pre-configuration of required resource access drives the consent experience.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignInAudience</maml:name> <maml:description> <maml:para>Specifies what Microsoft accounts are supported for the current application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Custom strings that can be used to categorize and identify the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TokenEncryptionKeyId</maml:name> <maml:description> <maml:para>Specifies the keyId of a public key from the keyCredentials collection.</maml:para> <maml:para>When configured, Microsoft Entra ID encrypts all the tokens it emits by using the key this property points to.</maml:para> <maml:para>The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Web</maml:name> <maml:description> <maml:para>Specifies settings for a web application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebApplication</command:parameterValue> <dev:type> <maml:name>WebApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.ApiApplication</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.InformationalUrl</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.OptionalClaims</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.ParentalControlSettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.PublicClientApplication</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.WebApplication</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AddIn]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PreAuthorizedApplication]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Nullable`one[System.Boolean]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.MsApplication</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------- Example 1: Create an application ---------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' New-EntraBetaApplication -DisplayName 'My new application' DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- My new application aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg domain.mail.contoso.com</dev:code> <dev:remarks> <maml:para>This command creates an application in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Create an application using IdentifierUris parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' New-EntraBetaApplication -DisplayName 'My new application' -IdentifierUris 'https://mynewapp.contoso.com' DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- My new application aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg domain.mail.contoso.com</dev:code> <dev:remarks> <maml:para>This command creates an application in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 3: Create an application using Api parameter -----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $api = @{ RequestedAccessTokenVersion = 2 } New-EntraBetaApplication -DisplayName 'My new application' -Api $api DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- My new application aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg domain.mail.contoso.com</dev:code> <dev:remarks> <maml:para>This command creates an application in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 4: Create an application using AppRoles parameter --</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $types = @() $types += 'User' $approle = New-Object Microsoft.Open.MSGraph.Model.AppRole $approle.AllowedMemberTypes = $types $approle.Description = 'msiam_access' $approle.DisplayName = 'msiam_access' $approle.Id = '643985ce-3eaf-4a67-9550-ecca25cb6814' $approle.Value = 'Application' $approle.IsEnabled = $true New-EntraBetaApplication -DisplayName 'My new application' -AppRoles $approle DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- My new application aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg domain.mail.contoso.com</dev:code> <dev:remarks> <maml:para>This command creates an application in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 5: Create an application using OptionalClaims parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $optionalClaims = @{ IdToken = [PSCustomObject]@{ Name = "claimName"; Source = "claimSource" } } New-EntraBetaApplication -DisplayName 'My new application' -OptionalClaims $optionalClaims DisplayName Id AppId SignInAudience PublisherDomain ----------- -- ----- -------------- --------------- My new application aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg domain.mail.contoso.com</dev:code> <dev:remarks> <maml:para>This command creates an application in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaApplication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaApplicationExtensionProperty</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaApplicationExtensionProperty</command:noun> <maml:description> <maml:para>Creates an application extension property.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaApplicationExtensionProperty` cmdlet creates an application extension property for an object in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaApplicationExtensionProperty</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DataType</maml:name> <maml:description> <maml:para>Specifies the data type of the value the extension property can hold. Following values are supported.</maml:para> <maml:para>- Binary - 256 bytes maximum</maml:para> <maml:para>- Boolean</maml:para> <maml:para>- DateTime - Must be specified in ISO 8601 format. Will be stored in UTC.</maml:para> <maml:para>- Integer - 32-bit value.</maml:para> <maml:para>- LargeInteger - 64-bit value.</maml:para> <maml:para>- String - 256 characters maximum</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the extension property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies a unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetObjects</maml:name> <maml:description> <maml:para>Specifies the Microsoft Graph resources that can use the extension property. All values must be in PascalCase. The following values are supported.</maml:para> <maml:para>- User</maml:para> <maml:para>- Group</maml:para> <maml:para>- AdministrativeUnit</maml:para> <maml:para>- Application</maml:para> <maml:para>- Device</maml:para> <maml:para>- Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DataType</maml:name> <maml:description> <maml:para>Specifies the data type of the value the extension property can hold. Following values are supported.</maml:para> <maml:para>- Binary - 256 bytes maximum</maml:para> <maml:para>- Boolean</maml:para> <maml:para>- DateTime - Must be specified in ISO 8601 format. Will be stored in UTC.</maml:para> <maml:para>- Integer - 32-bit value.</maml:para> <maml:para>- LargeInteger - 64-bit value.</maml:para> <maml:para>- String - 256 characters maximum</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the extension property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies a unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetObjects</maml:name> <maml:description> <maml:para>Specifies the Microsoft Graph resources that can use the extension property. All values must be in PascalCase. The following values are supported.</maml:para> <maml:para>- User</maml:para> <maml:para>- Group</maml:para> <maml:para>- AdministrativeUnit</maml:para> <maml:para>- Application</maml:para> <maml:para>- Device</maml:para> <maml:para>- Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Create an extension property -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" New-EntraBetaApplicationExtensionProperty -ApplicationId $application.Id -Name 'NewAttribute' DeletedDateTime Id AppDisplayName DataType IsSyncedFromOnPremises Name TargetObjects --------------- -- -------------- -------- ---------------------- ---- ------------- 11112222-bbbb-3333-cccc-4444dddd5555 My new test app String False extension_11112222-bbbb-3333-cccc-4444dddd5555_NewAttribute {}</dev:code> <dev:remarks> <maml:para>This command creates an application extension property of the string type for the specified object.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the unique identifier of an application.</maml:para> <maml:para>- `-Name` parameter specifies the name of the extension property.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Create an extension property with data type parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" New-EntraBetaApplicationExtensionProperty -ApplicationId $application.Id -Name 'NewAttribute1' -DataType 'Boolean' DeletedDateTime Id AppDisplayName DataType IsSyncedFromOnPremises Name TargetObjects --------------- -- -------------- -------- ---------------------- ---- ------------- 11112222-bbbb-3333-cccc-4444dddd5555 My new test app Boolean False extension_11112222-bbbb-3333-cccc-4444dddd5555_NewAttribute {}</dev:code> <dev:remarks> <maml:para>This command creates an application extension property of the specified data type for the specified object.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the unique identifier of an application.</maml:para> <maml:para>- `-Name` parameter specifies the name of the extension property.</maml:para> <maml:para>- `-DataType` parameter specifies the data type of the value the extension property can hold.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Create an extension property with targets parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" $targets = New-Object System.Collections.Generic.List[System.String] $targets.Add('User') New-EntraBetaApplicationExtensionProperty -ApplicationId $application.Id -Name 'NewAttribute2' -TargetObjects $targets DeletedDateTime Id AppDisplayName DataType IsSyncedFromOnPremises Name TargetObjects --------------- -- -------------- -------- ---------------------- ---- ------------- 11112222-bbbb-3333-cccc-4444dddd5555 My new test app String False extension_11112222-bbbb-3333-cccc-4444dddd5555_NewAttribute {User}</dev:code> <dev:remarks> <maml:para>The example shows how to create an application extension property with the specified target objects for the specified object.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the unique identifier of an application.</maml:para> <maml:para>- `-Name` parameter specifies the name of the extension property.</maml:para> <maml:para>- `-TargetObjects` parameter specifies the Microsoft Graph resources that use the extension property. All values must be in PascalCase.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaApplicationExtensionProperty</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationExtensionProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationExtensionProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaApplicationFromApplicationTemplate</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaApplicationFromApplicationTemplate</command:noun> <maml:description> <maml:para>Instantiates an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet allows users to create application from application template</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaApplicationFromApplicationTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of an object in Azure Active Directory</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Application template display name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ApplicationTemplateDisplayName</command:parameterValue> <dev:type> <maml:name>ApplicationTemplateDisplayName</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of an object in Azure Active Directory</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Application template display name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ApplicationTemplateDisplayName</command:parameterValue> <dev:type> <maml:name>ApplicationTemplateDisplayName</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Online.Administration.ApplicationTemplateCopy</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- 1. Creates an application from application template -----</maml:title> <dev:code>PS C:\> $instantiated_app = New-EntraBetaApplicationTemplate -Id e8b7b394-057d-4203-a93a-1879c28ece38 -DisplayName bugzilla-copy1</dev:code> <dev:remarks> <maml:para>This command instantiates a new application based on application template referenced by the id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaApplicationFromApplicationTemplate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaApplicationKey</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaApplicationKey</command:noun> <maml:description> <maml:para>Adds a new key to an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new key to an application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaApplicationKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyCredential</maml:name> <maml:description> <maml:para>The application key credential to add.</maml:para> <maml:para>NOTES: keyId value should be null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KeyCredential</command:parameterValue> <dev:type> <maml:name>KeyCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the application object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredential</maml:name> <maml:description> <maml:para>The application password credential to add.</maml:para> <maml:para>NOTES: keyId value should be null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PasswordCredential</command:parameterValue> <dev:type> <maml:name>PasswordCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Proof</maml:name> <maml:description> <maml:para>A signed JWT token used as a proof of possession of the existing keys.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyCredential</maml:name> <maml:description> <maml:para>The application key credential to add.</maml:para> <maml:para>NOTES: keyId value should be null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KeyCredential</command:parameterValue> <dev:type> <maml:name>KeyCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the application object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredential</maml:name> <maml:description> <maml:para>The application password credential to add.</maml:para> <maml:para>NOTES: keyId value should be null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PasswordCredential</command:parameterValue> <dev:type> <maml:name>PasswordCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Proof</maml:name> <maml:description> <maml:para>A signed JWT token used as a proof of possession of the existing keys.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.KeyCredential</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.PasswordCredential</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Add a key credential to an application ------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $app = Get-EntraBetaApplication -Filter "DisplayName eq '<application-display-name>'" $params = @{ ObjectId = $app.Id KeyCredential = @{ key=[System.Convert]::FromBase64String('{base64cert}') } PasswordCredential = @{ DisplayName = 'mypassword' } Proof = '{token}' } New-EntraBetaApplicationKey @params</dev:code> <dev:remarks> <maml:para>This command adds a key credential to an specified application.</maml:para> <maml:para>- `-ObjectId` parameter specifies the unique identifier of an application.</maml:para> <maml:para>- `-KeyCredential` parameter specifies the application key credential to add.</maml:para> <maml:para>- `-PasswordCredential` parameter specifies the application password credential to add.</maml:para> <maml:para>- `-Proof` parameter specifies the signed JWT token used as a proof of possession of the existing keys.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaApplicationKey</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaApplicationKeyCredential</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaApplicationKeyCredential</command:noun> <maml:description> <maml:para>Creates a key credential for an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaApplicationKeyCredential` cmdlet creates a key credential for an application.</maml:para> <maml:para>An application can use this command along with `Remove-EntraBetaApplicationKeyCredential` to automate the rolling of its expiring keys.</maml:para> <maml:para>As part of the request validation, proof of possession of an existing key is verified before the action can be performed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaApplicationKeyCredential</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>CustomKeyIdentifier</maml:name> <maml:description> <maml:para>Specifies a custom key ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>Specifies the time when the key becomes invalid as a DateTime object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies a unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Specifies the time when the key becomes valid as a DateTime object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of the key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KeyType</command:parameterValue> <dev:type> <maml:name>KeyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Usage</maml:name> <maml:description> <maml:para>Specifies the key usage.</maml:para> <maml:para>- `AsymmetricX509Cert`: The usage must be `Verify`.</maml:para> <maml:para>- `X509CertAndPassword`: The usage must be `Sign`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KeyUsage</command:parameterValue> <dev:type> <maml:name>KeyUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value for the key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>CustomKeyIdentifier</maml:name> <maml:description> <maml:para>Specifies a custom key ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>Specifies the time when the key becomes invalid as a DateTime object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies a unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Specifies the time when the key becomes valid as a DateTime object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of the key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KeyType</command:parameterValue> <dev:type> <maml:name>KeyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Usage</maml:name> <maml:description> <maml:para>Specifies the key usage.</maml:para> <maml:para>- `AsymmetricX509Cert`: The usage must be `Verify`.</maml:para> <maml:para>- `X509CertAndPassword`: The usage must be `Sign`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KeyUsage</command:parameterValue> <dev:type> <maml:name>KeyUsage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value for the key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Create a new application key credential ------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" $params = @{ ApplicationId = $application.Id CustomKeyIdentifier = 'EntraPowerShellKey' StartDate = '2024-03-21T14:14:14Z' Type = 'Symmetric' Usage = 'Sign' Value = '<my-value>' } New-EntraBetaApplicationKeyCredential @params CustomKeyIdentifier : {84, 101, 115, 116} EndDate : 2024-03-21T14:14:14Z KeyId : aaaaaaaa-0b0b-1c1c-2d2d-333333333333 StartDate : 2025-03-21T14:14:14Z Type : Symmetric Usage : Sign Value : {49, 50, 51}</dev:code> <dev:remarks> <maml:para>This example shows how to create an application key credential.</maml:para> <maml:para>- `-ApplicationId` Specifies a unique ID of an application</maml:para> <maml:para>- `-CustomKeyIdentifier` Specifies a custom key ID.</maml:para> <maml:para>- `-StartDate` Specifies the time when the key becomes valid as a DateTime object.</maml:para> <maml:para>- `-Type` Specifies the type of the key.</maml:para> <maml:para>- `-Usage` Specifies the key usage. for `AsymmetricX509Cert` the usage must be `Verify`and for `X509CertAndPassword` the usage must be `Sign`.</maml:para> <maml:para>- `-Value` Specifies the value for the key.</maml:para> <maml:para></maml:para> <maml:para>You can use the `Get-EntraBetaApplication` cmdlet to retrieve the application Object ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Use a certificate to add an application key credential</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" $cer = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2 #create a new certificate object $cer.Import('C:\Users\ContosoUser\appcert.cer') $bin = $cer.GetRawCertData() $base64Value = [System.Convert]::ToBase64String($bin) $bin = $cer.GetCertHash() $base64Thumbprint = [System.Convert]::ToBase64String($bin) $keyid = [System.Guid]::NewGuid().ToString() $params = @{ ApplicationId = $application.Id CustomKeyIdentifier = $base64Thumbprint Type = 'AsymmetricX509Cert' Usage = 'Verify' Value = $base64Value StartDate = $cer.GetEffectiveDateString() EndDate = $cer.GetExpirationDateString() } New-EntraBetaApplicationKeyCredential @params</dev:code> <dev:remarks> <maml:para>This example shows how to create an application key credential.</maml:para> <maml:para>- `-ApplicationId` Specifies a unique ID of an application</maml:para> <maml:para>- `-CustomKeyIdentifier` Specifies a custom key ID.</maml:para> <maml:para>- `-StartDate` Specifies the time when the key becomes valid as a DateTime object.</maml:para> <maml:para>- `-EndDate` Specifies the time when the key becomes invalid as a DateTime object.</maml:para> <maml:para>- `-Type` Specifies the type of the key.</maml:para> <maml:para>- `-Usage` Specifies the key usage. for `AsymmetricX509Cert` the usage must be `Verify`and for `X509CertAndPassword` the usage must be `Sign`.</maml:para> <maml:para>- `-Value` Specifies the value for the key.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaApplicationKeyCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationKeyCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationKeyCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaApplicationPassword</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaApplicationPassword</command:noun> <maml:description> <maml:para>Adds a strong password to an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a strong password to an application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaApplicationPassword</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the application object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredential</maml:name> <maml:description> <maml:para>Represents a password credential associated with an application or a service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PasswordCredential</command:parameterValue> <dev:type> <maml:name>PasswordCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the application object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredential</maml:name> <maml:description> <maml:para>Represents a password credential associated with an application or a service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PasswordCredential</command:parameterValue> <dev:type> <maml:name>PasswordCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.PasswordCredential</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Add a password to an application ---------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Directory.ReadWrite.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" $passwordCredential= New-Object Microsoft.Open.MSGraph.Model.PasswordCredential $passwordCredential.StartDateTime = Get-Date -Year 2024 -Month 10 -Day 23 $passwordCredential.EndDateTime = Get-Date -Year 2025 -Month 2 -Day 28 $passwordCredential.CustomKeyIdentifier = [System.Text.Encoding]::UTF8.GetBytes('ERP App Password') $passwordCredential.Hint = 'erpapppassword' $passwordCredential.DisplayName = 'ERP App Password' New-EntraBetaApplicationPassword -ObjectId $application.Id -PasswordCredential $passwordCredential CustomKeyIdentifier DisplayName EndDateTime Hint KeyId SecretText StartDateTime ------------------- ----------- ----------- ---- ----- ---------- ------------- {97} 2/28/2025 7:05:39 AM nnW bbbbbbbb-1c1c-2d2d-3e3e-444444444444 <my-secret-text> 12/28/2024 7:05:39 AM</dev:code> <dev:remarks> <maml:para>This example adds a password to the specified application.</maml:para> <maml:para>- `-ObjectId` parameter specifies the unique identifier of the application.</maml:para> <maml:para>- `-PasswordCredential` parameter specifies a password credential associated with an application or a service principal.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaApplicationPassword</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationPassword</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaApplicationPasswordCredential</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaApplicationPasswordCredential</command:noun> <maml:description> <maml:para>Creates a password credential for an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaApplicationPasswordCredential` cmdlet creates a password credential for an application in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaApplicationPasswordCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>CustomKeyIdentifier</maml:name> <maml:description> <maml:para>A unique binary identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The date and time at which the password becomes valid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>The date and time at which the password expires.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>CustomKeyIdentifier</maml:name> <maml:description> <maml:para>A unique binary identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The date and time at which the password becomes valid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>The date and time at which the password expires.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Create a password credential -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "displayName eq '<displayName>'" New-EntraBetaApplicationPasswordCredential -ApplicationId $application.Id CustomKeyIdentifier DisplayName EndDateTime Hint KeyId SecretText StartDateTime ------------------- ----------- ----------- ---- ----- ---------- ------------- 3/21/2026 9:48:40 AM n34 tttttttt-0000-2222-0000-aaaaaaaaaaaa wbBNW8kCuiPjNRg9NX98W_aaaaaaa 3/21/2024 9:48:40 AM</dev:code> <dev:remarks> <maml:para>This command creates new password credential for specified application.</maml:para> <maml:para>- `-ApplicationId` Specifies the ID of an application.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Create a password credential using CustomKeyIdentifier parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "displayName eq '<displayName>'" New-EntraBetaApplicationPasswordCredential -ApplicationId $application.Id -CustomKeyIdentifier '<userfriendlyDisplayName>' CustomKeyIdentifier DisplayName EndDateTime Hint KeyId SecretText StartDat eTime ------------------- ----------- ----------- ---- ----- ---------- -------- 100 101 109 111 80 97 115 115 119 111 114 100 demoPassword 6/10/2026 7:43:45 AM 9tb tttttttt-0000-2222-0000-aaaaaaaaaaaa wbBNW8kCuiPjNRg9NX98W_EaU6cqG 6/10/...</dev:code> <dev:remarks> <maml:para>This command creates new password credential for specified application.</maml:para> <maml:para>- `-ApplicationId` Specifies the ID of an application.</maml:para> <maml:para>- `-CustomKeyIdentifier` Speicifies unique binary identifier.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Create a password credential using StartDate parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "displayName eq '<displayName>'" $startDate = (Get-Date).AddYears(0) New-EntraBetaApplicationPasswordCredential -ApplicationId $application.Id -CustomKeyIdentifier '<userfriendlyDisplayName>' -StartDate $startDate CustomKeyIdentifier DisplayName EndDateTime Hint KeyId SecretText StartDateTime ------------------- ----------- ----------- ---- ----- ---------- ------------- 3/21/2026 9:48:40 AM n34 tttttttt-0000-2222-0000-aaaaaaaaaaaa wbBNW8kCuiPjNRg9NX98W_aaaaaaa 3/21/2024 9:48:40 AM</dev:code> <dev:remarks> <maml:para>This command creates new password credential for specified application.</maml:para> <maml:para>- `-ApplicationId` Specifies the ID of an application.</maml:para> <maml:para>- `-StartDate` Speicifies the date and time at which the password becomes valid.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Create a password credential using EndDate parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "displayName eq '<displayName>'" $endDate = (Get-Date).AddYears(2) New-EntraBetaApplicationPasswordCredential -ApplicationId $application.Id -CustomKeyIdentifier '<userfriendlyDisplayName>' -EndDate $endDate CustomKeyIdentifier DisplayName EndDateTime Hint KeyId SecretText StartDateTime ------------------- ----------- ----------- ---- ----- ---------- ------------- 3/21/2026 9:48:40 AM n34 tttttttt-0000-2222-0000-aaaaaaaaaaaa wbBNW8kCuiPjNRg9NX98W_aaaaaaa 3/21/2024 9:48:40 AM</dev:code> <dev:remarks> <maml:para>This command creates new password credential for specified application.</maml:para> <maml:para>- `-ApplicationId` Specifies the ID of an application.</maml:para> <maml:para>- `-EndDate` Speicifies The date and time at which the password expires.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaApplicationPasswordCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationPasswordCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaApplicationProxyApplication</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaApplicationProxyApplication</command:noun> <maml:description> <maml:para>The `New-EntraBetaApplicationProxyApplication` cmdlet creates a new application configured for Application Proxy in Microsoft Entra ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaApplicationProxyApplication` cmdlet creates a new application configured for Application Proxy in Microsoft Entra ID. To ensure this application is usable, also make sure you assign users and configure SSO if needed. Without specifying a ConnectorGroupId, this application by default uses the `Default` connector group in your tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaApplicationProxyApplication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ApplicationServerTimeout</maml:name> <maml:description> <maml:para>Set this value to Long only if your application is slow to authenticate and connect.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Long</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ApplicationServerTimeoutEnum</command:parameterValue> <dev:type> <maml:name>ApplicationServerTimeoutEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ConnectorGroupId</maml:name> <maml:description> <maml:para>Provide the ID of the Connector group you would like assigned to this application. You can find this value by using the `Get-EntraBetaApplicationProxyConnectorGroup` command. Connectors process the remote access to your application, and connector groups help you organize connectors and apps by region, network, or purpose. If you don't have any connector groups created yet, your app is assigned to Default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the new application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ExternalAuthenticationType</maml:name> <maml:description> <maml:para>How Application Proxy verifies users before giving them access to your application. AadPreAuthentication: Application Proxy redirects users to sign in with Microsoft Entra ID, which authenticates their permissions for the directory and application. We recommend keeping this option as the default, so that you can take advantage of Microsoft Entra ID security features like conditional access and multifactor authentication. Pass through: Users don't have to authenticate against Microsoft Entra ID to access the application. You can still set up authentication requirements on the backend.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AadPreAuthentication</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Passthru</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ExternalAuthenticationTypeEnum</command:parameterValue> <dev:type> <maml:name>ExternalAuthenticationTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ExternalUrl</maml:name> <maml:description> <maml:para>The address your users go to in order to access the app from outside your network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>InternalUrl</maml:name> <maml:description> <maml:para>The URL that you use to access the application from inside your private network. You can provide a specific path on the backend server to publish, while the rest of the server is unpublished. In this way, you can publish different sites on the same server as different apps, and give each one its own name and access rules. If you publish a path, make sure that it includes all the necessary images, scripts, and style sheets for your application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsTranslateHostHeaderEnabled</maml:name> <maml:description> <maml:para>If set to true, translates urls in headers. Keep this value true unless your application required the original host header in the authentication request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsTranslateLinksInBodyEnabled</maml:name> <maml:description> <maml:para>If set to true, translates urls in body. Keep this value as No unless you have to hardcoded HTML links to other on-premises applications, and don't use custom domains.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsHttpOnlyCookieEnabled</maml:name> <maml:description> <maml:para>Yes allows application proxy to include the HTTPOnly flag in HTTP response headers. This flag provides extra security benefits, for example, it prevents client-side scripting (CSS) from copying or modifying the cookies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsPersistentCookieEnabled</maml:name> <maml:description> <maml:para>Yes allows application proxy to set its access cookies to not expire when the web browser is closed. The persistence lasts until the access token expires, or until the user manually deletes the persistent cookies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsSecureCookieEnabled</maml:name> <maml:description> <maml:para>Yes allows application proxy to include the Secure flag in HTTP response headers. Secure Cookies enhances security by transmitting cookies over a TLS secured channel such as HTTPS. TLS prevents cookie transmission in clear text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ApplicationServerTimeout</maml:name> <maml:description> <maml:para>Set this value to Long only if your application is slow to authenticate and connect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ApplicationServerTimeoutEnum</command:parameterValue> <dev:type> <maml:name>ApplicationServerTimeoutEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ConnectorGroupId</maml:name> <maml:description> <maml:para>Provide the ID of the Connector group you would like assigned to this application. You can find this value by using the `Get-EntraBetaApplicationProxyConnectorGroup` command. Connectors process the remote access to your application, and connector groups help you organize connectors and apps by region, network, or purpose. If you don't have any connector groups created yet, your app is assigned to Default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name of the new application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ExternalAuthenticationType</maml:name> <maml:description> <maml:para>How Application Proxy verifies users before giving them access to your application. AadPreAuthentication: Application Proxy redirects users to sign in with Microsoft Entra ID, which authenticates their permissions for the directory and application. We recommend keeping this option as the default, so that you can take advantage of Microsoft Entra ID security features like conditional access and multifactor authentication. Pass through: Users don't have to authenticate against Microsoft Entra ID to access the application. You can still set up authentication requirements on the backend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ExternalAuthenticationTypeEnum</command:parameterValue> <dev:type> <maml:name>ExternalAuthenticationTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ExternalUrl</maml:name> <maml:description> <maml:para>The address your users go to in order to access the app from outside your network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>InternalUrl</maml:name> <maml:description> <maml:para>The URL that you use to access the application from inside your private network. You can provide a specific path on the backend server to publish, while the rest of the server is unpublished. In this way, you can publish different sites on the same server as different apps, and give each one its own name and access rules. If you publish a path, make sure that it includes all the necessary images, scripts, and style sheets for your application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsTranslateHostHeaderEnabled</maml:name> <maml:description> <maml:para>If set to true, translates urls in headers. Keep this value true unless your application required the original host header in the authentication request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsTranslateLinksInBodyEnabled</maml:name> <maml:description> <maml:para>If set to true, translates urls in body. Keep this value as No unless you have to hardcoded HTML links to other on-premises applications, and don't use custom domains.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsHttpOnlyCookieEnabled</maml:name> <maml:description> <maml:para>Yes allows application proxy to include the HTTPOnly flag in HTTP response headers. This flag provides extra security benefits, for example, it prevents client-side scripting (CSS) from copying or modifying the cookies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsPersistentCookieEnabled</maml:name> <maml:description> <maml:para>Yes allows application proxy to set its access cookies to not expire when the web browser is closed. The persistence lasts until the access token expires, or until the user manually deletes the persistent cookies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsSecureCookieEnabled</maml:name> <maml:description> <maml:para>Yes allows application proxy to include the Secure flag in HTTP response headers. Secure Cookies enhances security by transmitting cookies over a TLS secured channel such as HTTPS. TLS prevents cookie transmission in clear text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>System.Nullable`1[[Microsoft.Open.MSGraph.Model.ApplicationProxyApplicationObject+ExternalAuthenticationTypeEnum, Microsoft.Open.MS.GraphV10.Client, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]] System.Nullable`1[[System. Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] System.Nullable`1[[Microsoft.Open.MSGraph.Model.ApplicationProxyApplicationObject+ApplicationServerTimeoutEnum, Microsoft.Open.MS.GraphV10.Client, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Creating a new application with only the basic required settings, and the default domain for applications</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $params = @{ DisplayName = 'Finance Tracker' ExternalUrl = 'https://finance-awcycles.msappproxy.net/' InternalUrl = 'http://finance/' } New-EntraBetaApplicationProxyApplication @params ObjectId : bbbbbbbb-1111-2222-3333-cccccccccccc externalAuthenticationType : applicationServerTimeout : externalUrl : https://finance-awcycles.msappproxy.net/ internalUrl : http://finance/ isTranslateHostHeaderEnabled : False isTranslateLinksInBodyEnabled : False isOnPremPublishingEnabled : True verifiedCustomDomainCertificatesMetadata : verifiedCustomDomainKeyCredential : verifiedCustomDomainPasswordCredential : singleSignOnSettings : @{singleSignOnMode=none; kerberosSignOnSettings=} isHttpOnlyCookieEnabled : False isSecureCookieEnabled : False isPersistentCookieEnabled : False</dev:code> <dev:remarks> <maml:para>This example creating a new application with only the basic required settings, and the default domain for applications.</maml:para> <maml:para>- `-DisplayName` parameter specifies the display name of new application.</maml:para> <maml:para>- `-ExternalUrl` parameter specifies the URL that use to access the application from outside user private network.</maml:para> <maml:para>- `-InternalUrl` parameter specifies the URL that use to access the application from inside user private network.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Creating a new application with ApplicationServerTimeout and ExternalAuthenticationType parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $params = @{ DisplayName = 'Finance Tracker' ExternalUrl = 'https://finance-awcycles.msappproxy.net/' InternalUrl = 'http://finance/' ApplicationServerTimeout = Long ExternalAuthenticationType = 'aadPreAuthentication' } New-EntraBetaApplicationProxyApplication @params ObjectId : bbbbbbbb-1111-2222-3333-cccccccccccc externalAuthenticationType : aadPreAuthentication applicationServerTimeout : Long externalUrl : https://testp4-m365x99297270.msappproxy.net/ internalUrl : https://testp4.com/ isTranslateHostHeaderEnabled : False isTranslateLinksInBodyEnabled : False isOnPremPublishingEnabled : True verifiedCustomDomainCertificatesMetadata : verifiedCustomDomainKeyCredential : verifiedCustomDomainPasswordCredential : singleSignOnSettings : @{singleSignOnMode=none; kerberosSignOnSettings=} isHttpOnlyCookieEnabled : False isSecureCookieEnabled : False isPersistentCookieEnabled : False</dev:code> <dev:remarks> <maml:para>This example creating a new application with `ApplicationServerTimeout` and `ExternalAuthenticationType` parameter.</maml:para> <maml:para>- `-DisplayName` parameter specifies the display name of new application.</maml:para> <maml:para>- `-ExternalUrl` parameter specifies the URL that use to access the application from outside user private network.</maml:para> <maml:para>- `-InternalUrl` parameter specifies the URL that use to access the application from inside user private network.</maml:para> <maml:para>- `-ApplicationServerTimeout` parameter specifies the application server timeout to set.</maml:para> <maml:para>- `-ExternalAuthenticationType` parameter specifies the external authentication type.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Creating a new application with IsHttpOnlyCookieEnabled, IsSecureCookieEnabled, IsTranslateLinksInBodyEnabled and ConnectorGroupId parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $params = @{ DisplayName = 'Finance Tracker' ExternalUrl = 'https://finance-awcycles.msappproxy.net/' InternalUrl = 'http://finance/' IsHttpOnlyCookieEnabled = $false IsSecureCookieEnabled = $false IsPersistentCookieEnabled = $false IsTranslateLinksInBodyEnabled = $false ConnectorGroupId = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' } New-EntraBetaApplicationProxyApplication @params ObjectId : bbbbbbbb-1111-2222-3333-cccccccccccc externalAuthenticationType : aadPreAuthentication applicationServerTimeout : Long externalUrl : https://testp4-m365x99297270.msappproxy.net/ internalUrl : https://testp4.com/ isTranslateHostHeaderEnabled : False isTranslateLinksInBodyEnabled : False isOnPremPublishingEnabled : True verifiedCustomDomainCertificatesMetadata : verifiedCustomDomainKeyCredential : verifiedCustomDomainPasswordCredential : singleSignOnSettings : @{singleSignOnMode=none; kerberosSignOnSettings=} isHttpOnlyCookieEnabled : False isSecureCookieEnabled : False isPersistentCookieEnabled : False</dev:code> <dev:remarks> <maml:para>This example creating a new application with `IsHttpOnlyCookieEnabled`, `IsSecureCookieEnabled`, `IsTranslateLinksInBodyEnabled`, and `ConnectorGroupId` parameter.</maml:para> <maml:para>- `-DisplayName` parameter specifies the display name of new application.</maml:para> <maml:para>- `-ExternalUrl` parameter specifies the URL that use to access the application from outside user private network.</maml:para> <maml:para>- `-InternalUrl` parameter specifies the URL that use to access the application from inside user private network.</maml:para> <maml:para>- `-ConnectorGroupId` parameter specifies the Connector group ID that assigned to this application.</maml:para> <maml:para>- `-IsHttpOnlyCookieEnabled` parameter specifies the application proxy to include the HTTPOnly flag in HTTP response headers.</maml:para> <maml:para>- `-IsSecureCookieEnabled` parameter specifies the application proxy to include the Secure flag in HTTP response headers.</maml:para> <maml:para>- `-IsPersistentCookieEnabled` parameter specifies application proxy to set its access cookies to not expire when the web browser is closed.</maml:para> <maml:para>- `-IsTranslateLinksInBodyEnabled` parameter specifies the translates urls in body.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaApplicationProxyApplication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaApplicationProxyConnectorGroup</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaApplicationProxyConnectorGroup</command:noun> <maml:description> <maml:para>The `New-EntraBetaApplicationProxyConnectorGroup` cmdlet creates a new Application Proxy Connector group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaApplicationProxyConnectorGroup` cmdlet creates a new Application Proxy connector group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaApplicationProxyConnectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new Connector Group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Name</command:parameterValue> <dev:type> <maml:name>System.Name</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new Connector Group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Name</command:parameterValue> <dev:type> <maml:name>System.Name</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.Name</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Create a new Connector Group -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' New-EntraBetaApplicationProxyConnectorGroup -Name 'Backup Application Servers' Name Value ---- ----- id aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb @odata.context https://graph.microsoft.com/beta/$metadata#onPremisesPublishingProfiles('applicationProxy')/connectorGroups/$entity isDefault False name Backup Application Servers region eur connectorGroupType applicationProxy</dev:code> <dev:remarks> <maml:para>This example creates a new Connector Group using specified name.</maml:para> <maml:para>- `-Name` parameter specifies the new connector group name.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaApplicationProxyConnectorGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaPasswordSingleSignOnCredential</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaPasswordSingleSignOnCredential</command:noun> <maml:description> <maml:para>Creates the password Single-Sign-On (SSO) credentials.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet enables users to create their Password Single-Sign-On credentials for an application that they're part of. Specify `ObjectId` and `PasswordSSOCredential` parameters to create an SSO credentials. Admin could create the group credentials as well.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaPasswordSingleSignOnCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the object specific Microsoft Entra ID object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>PasswordSSOCredential</maml:name> <maml:description> <maml:para>User or group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.PasswordSSOCredentials</command:parameterValue> <dev:type> <maml:name>System.PasswordSSOCredentials</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the object specific Microsoft Entra ID object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>PasswordSSOCredential</maml:name> <maml:description> <maml:para>User or group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.PasswordSSOCredentials</command:parameterValue> <dev:type> <maml:name>System.PasswordSSOCredentials</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Online.Administration.PasswordSSOCredentials</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: New password single-sign-on credentials ------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Directory.ReadWrite.All' $credentials = New-Object -TypeName Microsoft.Open.MSGraph.Model.PasswordSSOCredentials $credentials.Id = '<user-or-group-Id>' $servicePrincipal = Get-EntraBetaservicePrincipal -SearchString '<service-principal-name>' $creds1 = [Microsoft.Open.MSGraph.Model.PasswordSSOCredential]@{FieldId="param_emailOrUserName"; Value="foobar@ms.com"; Type="text"} $creds2 = [Microsoft.Open.MSGraph.Model.PasswordSSOCredential]@{FieldId="param_password"; Value="my-secret"; Type="password"} $credentials.Credentials = @($creds1, $creds2) $params = @{ ObjectId = $servicePrincipal.Id PasswordSSOCredential = $credentials } New-EntraBetaPasswordSingleSignOnCredential @params Id -- cccccccc-2222-3333-4444-dddddddddddd</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create an password SSO credential for the given ObjectId and PasswordSSOObjectId.</maml:para> <maml:para>- `-PasswordSSOObjectId` parameter specifies the User or Group ID.</maml:para> <maml:para>- `-ObjectId` parameter specifies the object ID of a service principal.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaPasswordSingleSignOnCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaServicePrincipal</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaServicePrincipal</command:noun> <maml:description> <maml:para>Creates a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new service Principal.</maml:para> <maml:para>For multitenant apps, the calling user must also be in at least one of the following Microsoft Entra roles:</maml:para> <maml:para>- Application Administrator</maml:para> <maml:para>- Cloud Application Administrator</maml:para> <maml:para></maml:para> <maml:para>For single-tenant apps where the calling user is a non-admin user but is the owner of the backing application, the user must have the Application Developer role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaServicePrincipal</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccountEnabled</maml:name> <maml:description> <maml:para>True if the service principal account is enabled; otherwise, false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlternativeNames</maml:name> <maml:description> <maml:para>The alternative names for this service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppId</maml:name> <maml:description> <maml:para>The unique identifier for the associated application (its appId property).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppRoleAssignmentRequired</maml:name> <maml:description> <maml:para>Indicates whether an application role assignment is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the service principal display name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Homepage</maml:name> <maml:description> <maml:para>Home page or landing page of the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyCredentials</maml:name> <maml:description> <maml:para>The collection of key credentials associated with the service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LogoutUrl</maml:name> <maml:description> <maml:para>Specifies the logout URL.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredentials</maml:name> <maml:description> <maml:para>The collection of password credentials associated with the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReplyUrls</maml:name> <maml:description> <maml:para>The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalNames</maml:name> <maml:description> <maml:para>Specifies an array of service principal names. Based on the identifierURIs collection, plus the application's appId property, these URIs are used to reference an application's service principal. A client uses ServicePrincipalNames to:</maml:para> <maml:para>- populate requiredResourceAccess, via "Permissions to other applications" in the Azure classic portal.</maml:para> <maml:para>- Specify a resource URI to acquire an access token, which is the URI returned in the claim.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalType</maml:name> <maml:description> <maml:para>The type of the service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Tags linked to this service principal.</maml:para> <maml:para>Note that if you intend for this service principal to show up in the All Applications list in the admin portal, you need to set this value to {WindowsAzureActiveDirectoryIntegratedApp}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccountEnabled</maml:name> <maml:description> <maml:para>True if the service principal account is enabled; otherwise, false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlternativeNames</maml:name> <maml:description> <maml:para>The alternative names for this service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppId</maml:name> <maml:description> <maml:para>The unique identifier for the associated application (its appId property).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppRoleAssignmentRequired</maml:name> <maml:description> <maml:para>Indicates whether an application role assignment is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the service principal display name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Homepage</maml:name> <maml:description> <maml:para>Home page or landing page of the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyCredentials</maml:name> <maml:description> <maml:para>The collection of key credentials associated with the service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LogoutUrl</maml:name> <maml:description> <maml:para>Specifies the logout URL.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredentials</maml:name> <maml:description> <maml:para>The collection of password credentials associated with the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReplyUrls</maml:name> <maml:description> <maml:para>The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalNames</maml:name> <maml:description> <maml:para>Specifies an array of service principal names. Based on the identifierURIs collection, plus the application's appId property, these URIs are used to reference an application's service principal. A client uses ServicePrincipalNames to:</maml:para> <maml:para>- populate requiredResourceAccess, via "Permissions to other applications" in the Azure classic portal.</maml:para> <maml:para>- Specify a resource URI to acquire an access token, which is the URI returned in the claim.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalType</maml:name> <maml:description> <maml:para>The type of the service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Tags linked to this service principal.</maml:para> <maml:para>Note that if you intend for this service principal to show up in the All Applications list in the admin portal, you need to set this value to {WindowsAzureActiveDirectoryIntegratedApp}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Create a new service principal using DisplayName, AccountEnabled, Tags, and AppRoleAssignmentRequired</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Helpdesk Application'" $params = @{ AccountEnabled = $true AppId = $application.AppId AppRoleAssignmentRequired = $true DisplayName = $application.DisplayName Tags = {WindowsAzureActiveDirectoryIntegratedApp} } New-EntraBetaServicePrincipal @params DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Helpdesk Application bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg Application</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create a new service Principal in Microsoft Entra ID. You can use the command `Get-EntraBetaApplication` to get application app Id.</maml:para> <maml:para>The tag `-Tags {WindowsAzureActiveDirectoryIntegratedApp}` is used to have this service principal show up in the list of Integrated Applications in the Admin Portal.</maml:para> <maml:para>- `-AccountEnabled` parameter specifies true if the service principal account is enabled, otherwise false.</maml:para> <maml:para>- `-AppId` parameter specifies the unique identifier for the associated application (its appId property).</maml:para> <maml:para>- `-DisplayName` parameter specifies the service principal display name.</maml:para> <maml:para>- `-AppRoleAssignmentRequired` parameter indicates whether an application role assignment is required.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Create a new service principal using Homepage, logoutUrl, and ReplyUrls</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Helpdesk Application'" $params = @{ AppId = $application.AppId Homepage = 'https://localhost/home' LogoutUrl = 'htpp://localhost/logout' ReplyUrls = 'https://localhost/redirect' } New-EntraBetaServicePrincipal @params DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Helpdesk Application bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg Application</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create a new service Principal in Microsoft Entra ID. You can use the command `Get-EntraBetaApplication` to get application app Id.</maml:para> <maml:para>- `-AppId` parameter specifies the unique identifier for the associated application (its appId property).</maml:para> <maml:para>- `-Homepage` parameter specifies the home page or landing page of the application.</maml:para> <maml:para>- `-LogoutUrl` parameter specifies the logout URL.</maml:para> <maml:para>- `-ReplyUrls` parameter specifies the URLs that user tokens are sent to for sign in with the associated application.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 3: Create a new service principal by KeyCredentials -</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $creds = New-Object Microsoft.Open.AzureAD.Model.KeyCredential $creds.CustomKeyIdentifier = [System.Text.Encoding]::UTF8.GetBytes('Test') $startdate = Get-Date -Year 2024 -Month 07 -Day 23 $creds.StartDate = $startdate $creds.Type = 'Symmetric' $creds.Usage = 'Sign' $creds.Value = [System.Text.Encoding]::UTF8.GetBytes('strong-cred-value') $creds.EndDate = Get-Date -Year 2024 -Month 10 -Day 23 $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Helpdesk Application'" New-EntraBetaServicePrincipal -AppId $application.AppId -KeyCredentials $creds DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Helpdesk Application bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg Application</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create a new service Principal in Microsoft Entra ID. You can use the command `Get-EntraBetaApplication` to get application app Id.</maml:para> <maml:para>- `-AppId` parameter specifies the unique identifier for the associated application (its appId property).</maml:para> <maml:para>- `-KeyCredentials` parameter specifies the collection of key credentials associated with the service principal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Create a new service principal by AlternativeNames, ServicePrincipalType, and ServicePrincipalName</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Helpdesk Application'" New-EntraBetaServicePrincipal -AppId $application.AppId -AlternativeNames 'sktest2' -ServicePrincipalType 'Application' -ServicePrincipalNames $application.AppId DisplayName Id AppId SignInAudience ServicePrincipalType ----------- -- ----- -------------- -------------------- Helpdesk Application bbbbbbbb-1111-2222-3333-cccccccccccc 00001111-aaaa-2222-bbbb-3333cccc4444 AzureADMyOrg Application</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create a new service Principal in Microsoft Entra ID. You can use the command `Get-EntraBetaApplication` to get application app Id.</maml:para> <maml:para>- `-AppId` parameter specifies the unique identifier for the associated application (its appId property).</maml:para> <maml:para>- `-AlternativeNames` parameter specifies the alternative names for this service principal.</maml:para> <maml:para>- `-ServicePrincipalType` parameter specifies the type of the service principal.</maml:para> <maml:para>- `-ServicePrincipalNames` parameter specifies an array of service principal names.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaServicePrincipal</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaServicePrincipalAppRoleAssignment</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaServicePrincipalAppRoleAssignment</command:noun> <maml:description> <maml:para>Assigns a service principal to an application role.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaServicePrincipalAppRoleAssignment` cmdlet assigns a service principal to an application role in Microsoft Entra ID.</maml:para> <maml:para>For delegated scenarios, the calling user needs at least one of the following Microsoft Entra roles.</maml:para> <maml:para>- Directory Synchronization Accounts</maml:para> <maml:para>- Directory Writer</maml:para> <maml:para>- Hybrid Identity Administrator</maml:para> <maml:para>- Identity Governance Administrator</maml:para> <maml:para>- Privileged Role Administrator</maml:para> <maml:para>- User Administrator</maml:para> <maml:para>- Application Administrator</maml:para> <maml:para>- Cloud Application Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaServicePrincipalAppRoleAssignment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrincipalId</maml:name> <maml:description> <maml:para>Specifies a principal ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies a resource ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrincipalId</maml:name> <maml:description> <maml:para>Specifies a principal ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Specifies a resource ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>`New-EntraBetaServiceAppRoleAssignment` is an alias for `New-EntraBetaServicePrincipalAppRoleAssignment`.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Assign an app role to a service principal -----</maml:title> <dev:code>Connect-Entra -Scopes 'AppRoleAssignment.ReadWrite.All' $clientServicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" $resourceServicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Microsoft Graph'" $appRole = $resourceServicePrincipal.AppRoles | Where-Object { $_.Value -eq "User.ReadBasic.All" } New-EntraBetaServicePrincipalAppRoleAssignment -ObjectId $clientServicePrincipal.Id -PrincipalId $clientServicePrincipal.Id -Id $appRole.Id -ResourceId $resourceServicePrincipal.Id</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 2: Assign an app role to another service principal --</maml:title> <dev:code>Connect-Entra -Scopes 'AppRoleAssignment.ReadWrite.All' $clientServicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" $servicePrincipalObject = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Box'" New-EntraBetaServicePrincipalAppRoleAssignment -ObjectId $clientServicePrincipal.Id -PrincipalId $clientServicePrincipal.Id -ResourceId $servicePrincipalObject.Id -Id $servicePrincipalObject.Approles[1].Id Id AppRoleId CreationTimestamp PrincipalDisplayName PrincipalId PrincipalType ResourceDisplayName ResourceId -- --------- ----------------- -------------------- ----------- ------------- ------------------- ---------- 1aaaaaa1-2bb2-3cc3-4dd4-5eeeeeeeeee5 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box aaaa0000-bb11-2222-33cc-444444dddddd</dev:code> <dev:remarks> <maml:para>This example demonstrates how to assign an app role to another service principal in Microsoft Entra ID. You can use the command `Get-EntraBetaServicePrincipal` to get a service principal Id.</maml:para> <maml:para>- `-ObjectId` parameter specifies the ObjectId of a client service principal to which you're assigning the app role.</maml:para> <maml:para>- `-ResourceId`parameter specifies the ObjectId of the resource service principal.</maml:para> <maml:para>- `-Id` parameter specifies the Id of the app role (defined on the resource service principal) to assign to the client service principal. If no app roles are defined on the resource app, you can use `00000000-0000-0000-0000-000000000000`.</maml:para> <maml:para>- `-PrincipalId` parameter specifies the ObjectId of the client service principal to which you're assigning the app role.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------- Example 3: Assign an app role to a user -----------</maml:title> <dev:code>Connect-Entra -Scopes 'AppRoleAssignment.ReadWrite.All' $servicePrincipalObject = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Box'" $user = Get-EntraBetaUser -UserId 'PattiF@Contoso.com' New-EntraBetaServicePrincipalAppRoleAssignment ` -ObjectId $servicePrincipalObject.Id ` -ResourceId $servicePrincipalObject.Id ` -Id $servicePrincipalObject.Approles[1].Id ` -PrincipalId $user.Id Id AppRoleId CreationTimestamp PrincipalDisplayName PrincipalId PrincipalType ResourceDisplayName ResourceId -- --------- ----------------- -------------------- ----------- ------------- ------------------- ---------- 2bbbbbb2-3cc3-4dd4-5ee5-6ffffffffff6 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box bbbb1111-cc22-3333-44dd-555555eeeeee</dev:code> <dev:remarks> <maml:para>This example demonstrates how to assign an app role to a user in Microsoft Entra ID. You can use the command `Get-EntraBetaServicePrincipal` to get a service principal Id. You can use the command `Get-EntraBetaUser` to get a user Id.</maml:para> <maml:para>- `-ObjectId` parameter specifies the ObjectId of the app's service principal.</maml:para> <maml:para>- `-ResourceId`parameter specifies the ObjectId of the app's service principal.</maml:para> <maml:para>- `-Id` parameter specifies the Id of app role (defined on the app's service principal) to assign to the user. If no app roles are defined to the resource app, you can use `00000000-0000-0000-0000-000000000000` to indicate that the app is assigned to the user.</maml:para> <maml:para>- `-PrincipalId` parameter specifies the ObjectId of a user to which you're assigning the app role.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------- Example 4: Assign an app role to a group -----------</maml:title> <dev:code>Connect-Entra -Scopes 'AppRoleAssignment.ReadWrite.All' $servicePrincipalObject = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Box'" $group = Get-EntraBetaGroup -Filter "displayName eq 'Contoso marketing'" New-EntraBetaServicePrincipalAppRoleAssignment ` -ObjectId $servicePrincipalObject.Id ` -ResourceId $servicePrincipalObject.Id ` -Id $servicePrincipalObject.Approles[1].Id ` -PrincipalId $group.Id Id AppRoleId CreationTimestamp PrincipalDisplayName PrincipalId PrincipalType ResourceDisplayName ResourceId -- --------- ----------------- -------------------- ----------- ------------- ------------------- ---------- 3cccccc3-4dd4-5ee5-6ff6-7aaaaaaaaaa7 00000000-0000-0000-0000-000000000000 12-03-2024 11:05:29 Box aaaaaaaa-bbbb-cccc-1111-222222222222 ServicePrincipal Box cccc2222-dd33-4444-55ee-666666ffffff</dev:code> <dev:remarks> <maml:para>This example demonstrates how to assign an app role to a group in Microsoft Entra ID. You can use the command `Get-EntraBetaServicePrincipal` to get a service principal Id. You can use the command `Get-EntraBetaGroup` to get a group Id.</maml:para> <maml:para>- `-ObjectId` parameter specifies the ObjectId of the app's service principal.</maml:para> <maml:para>- `-ResourceId`parameter specifies the ObjectId of the app's service principal.</maml:para> <maml:para>- `-Id` parameter specifies the Id of app role (defined on the app's service principal) to assign to the group. If no app roles are defined to the resource app, you can use `00000000-0000-0000-0000-000000000000` to indicate that the app is assigned to the group.</maml:para> <maml:para>- `-PrincipalId` parameter specifies the ObjectId of a group to which you're assigning the app role.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaServicePrincipalAppRoleAssignment</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipalAppRoleAssignment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaServicePrincipalAppRoleAssignment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaServicePrincipalPasswordCredential</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaServicePrincipalPasswordCredential</command:noun> <maml:description> <maml:para>Creates a password credential for a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaServicePrincipalPasswordCredential` cmdlet creates a password credential for a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaServicePrincipalPasswordCredential</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2024 is 2024-01-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of the service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2024 is 2024-01-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2024 is 2024-01-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of the service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2024 is 2024-01-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---- Example 1: Create a password credential with StartDate ----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" New-EntraBetaServicePrincipalPasswordCredential -ServicePrincipalId $servicePrincipal.Id -StartDate '2024-11-04T14:14:14Z' secretText : A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u @odata.type : #microsoft.graph.servicePrincipal endDateTime : 08-08-2026 10:30:00 hint : LY. customKeyIdentifier : startDateTime : 08-08-2024 14:14:14 keyId : aaaaaaaa-0b0b-1c1c-2d2d-333333333333 @odata.context : https://graph.microsoft.com/beta/$metadata#servicePrincipals('00001111-aaaa-2222-bbbb-3333cccc4444')/addPassword displayName : StartDate : 08-08-2024 14:14:14 EndDate : 08-08-2026 10:30:00</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create a password credential with StartDate for a service principal in Microsoft Entra ID. - `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> <maml:para>- `-StarteDate` parameter specifies the date and time at which the password becomes valid.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 2: Create a password credential with EndDate -----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" New-EntraBetaServicePrincipalPasswordCredential -ServicePrincipalId $servicePrincipal.Id -EndDate '2024-11-04T14:14:14Z' secretText : A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u @odata.type : #microsoft.graph.servicePrincipal endDateTime : 08-08-2026 10:30:00 hint : LY. customKeyIdentifier : startDateTime : 08-08-2024 14:14:14 keyId : bbbbbbbb-1c1c-2d2d-3e3e-444444444444 @odata.context : https://graph.microsoft.com/beta/$metadata#servicePrincipals('00001111-aaaa-2222-bbbb-3333cccc4444')/addPassword displayName : StartDate : 08-08-2024 14:14:14 EndDate : 08-08-2026 10:30:00</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create a password credential with EndDate for a service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> <maml:para>- `-EndDate` parameter specifies the date and time at which the password expires represented using ISO 8601 format and is always in UTC time.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaServicePrincipalPasswordCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipalPasswordCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaServicePrincipalPasswordCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplication</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplication</command:noun> <maml:description> <maml:para>Deletes an application object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaApplication` cmdlet deletes an application object identified by ApplicationId. Specify the `ApplicationId` parameter to delete an application object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------- Example 1: Remove an application ---------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" Remove-EntraBetaApplication -ApplicationId $application.Id</dev:code> <dev:remarks> <maml:para>This example demonstrates how to delete an application object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 2: Remove an application using pipelining ------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" | Remove-EntraBetaApplication</dev:code> <dev:remarks> <maml:para>This example demonstrates how to delete an application object using pipelining.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplicationExtensionProperty</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplicationExtensionProperty</command:noun> <maml:description> <maml:para>Removes an application extension property.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaApplicationExtensionProperty` cmdlet removes an application extension property for an object in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplicationExtensionProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ExtensionPropertyId</maml:name> <maml:description> <maml:para>Specifies the unique ID of the extension property to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ExtensionPropertyId</maml:name> <maml:description> <maml:para>Specifies the unique ID of the extension property to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Remove an application extension property -----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" $extension = Get-EntraApplicationExtensionProperty -ApplicationId $application.Id | Where-Object {$_.Name -eq 'extension_3ed1a24748dd4e4cb91fc0ab09576ff0_NewAttribute'} Remove-EntraBetaApplicationExtensionProperty -ApplicationId $application.Id -ExtensionPropertyId $extension.Id</dev:code> <dev:remarks> <maml:para>This example removes the extension property that has the specified ID from an application in Microsoft Entra ID.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the unique identifier of an application.</maml:para> <maml:para>- `-ExtensionPropertyId` parameter specifies the unique identifier of the extension property to remove.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplicationExtensionProperty</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationExtensionProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationExtensionProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplicationKey</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplicationKey</command:noun> <maml:description> <maml:para>Removes a key from an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a key from an application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplicationKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>Specifies the unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyId</maml:name> <maml:description> <maml:para>The key Id corresponding to the key object to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Proof</maml:name> <maml:description> <maml:para>The JWT token provided as a proof of possession.</maml:para> <maml:para>A self-signed JWT token used as a proof of possession of the existing keys. This JWT token must be signed with a private key that corresponds to one of the existing valid certificates associated with the application. The token should contain the following claims:</maml:para> <maml:para>- `aud`: Audience needs to be 00000002-0000-0000-c000-000000000000.</maml:para> <maml:para>- `iss`: Issuer needs to be the ID of the application that initiates the request.</maml:para> <maml:para>- `nbf`: Not before time.</maml:para> <maml:para>- `exp`: Expiration time should be the value of nbf + 10 minutes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>Specifies the unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyId</maml:name> <maml:description> <maml:para>The key Id corresponding to the key object to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Proof</maml:name> <maml:description> <maml:para>The JWT token provided as a proof of possession.</maml:para> <maml:para>A self-signed JWT token used as a proof of possession of the existing keys. This JWT token must be signed with a private key that corresponds to one of the existing valid certificates associated with the application. The token should contain the following claims:</maml:para> <maml:para>- `aud`: Audience needs to be 00000002-0000-0000-c000-000000000000.</maml:para> <maml:para>- `iss`: Issuer needs to be the ID of the application that initiates the request.</maml:para> <maml:para>- `nbf`: Not before time.</maml:para> <maml:para>- `exp`: Expiration time should be the value of nbf + 10 minutes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---- Example 1: Remove a key credential from an application ----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Directory.ReadWrite.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" Remove-EntraBetaApplicationKey -ObjectId $application.Id -KeyId 'aaaaaaaa-0b0b-1c1c-2d2d-333333333333' -Proof '{token}'</dev:code> <dev:remarks> <maml:para>This command removes the specified key credential from the specified application.</maml:para> <maml:para>- `-ObjectId` parameter specifies the unique identifier of an application.</maml:para> <maml:para>- `-KeyId` parameter specifies the key Id corresponding to the key object to be removed.</maml:para> <maml:para>- `-Proof` parameter specifies the JWT token provided as a proof of possession.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplicationKey</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplicationKeyCredential</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplicationKeyCredential</command:noun> <maml:description> <maml:para>Removes a key credential from an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaApplicationKeyCredential` cmdlet removes a key credential from an application.</maml:para> <maml:para>An application can use this command along with `New-EntraBetaApplicationKeyCredential` to automate the rolling of its expiring keys.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplicationKeyCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyId</maml:name> <maml:description> <maml:para>Specifies a custom key ID. The unique identifier for the password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies a unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyId</maml:name> <maml:description> <maml:para>Specifies a custom key ID. The unique identifier for the password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies a unique ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1: Remove a key credential --------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" Remove-EntraBetaApplicationKeyCredential -ApplicationId $application.Id -KeyId 'aaaaaaaa-0b0b-1c1c-2d2d-333333333333'</dev:code> <dev:remarks> <maml:para>This command removes the specified key credential from the specified application.</maml:para> <maml:para>- `-ApplicationId` Specifies the ID of an application.</maml:para> <maml:para>- `-KeyId` Specifies a custom key ID. Use `Get-EntraBetaApplicationKeyCredential` to get the keyId details.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplicationKeyCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationKeyCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationKeyCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplicationOwner</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplicationOwner</command:noun> <maml:description> <maml:para>Removes an owner from an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaApplicationOwner` cmdlet removes an owner from an application in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplicationOwner</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>Specifies the ID of the owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>Specifies the ID of the owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------- Example 1: Remove an owner from an application --------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" $owner = Get-EntraBetaApplicationOwner -ApplicationId $application.Id | Where-Object {$_.userPrincipalName -eq 'SawyerM@contoso.com'} Remove-EntraBetaApplicationOwner -ApplicationId $application.Id -OwnerId $owner.Id</dev:code> <dev:remarks> <maml:para>This example removes the specified owner from the specified application. You can use the command `Get-EntraBetaApplication` to get application Id.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the the unique identifier of a application.</maml:para> <maml:para>- `-OwnerId` parameter specifies the ID of the owner.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplicationOwner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaApplicationOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplicationPassword</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplicationPassword</command:noun> <maml:description> <maml:para>Remove a password from an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a password from an application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplicationPassword</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyId</maml:name> <maml:description> <maml:para>The unique identifier for the key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyId</maml:name> <maml:description> <maml:para>The unique identifier for the key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Removes a password from an application ------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" $applicationPassword = Get-EntraBetaApplicationPasswordCredential -ApplicationId $application.Id | Where-Object {$_.DisplayName -eq 'ERP App Password'} Remove-EntraBetaApplicationPassword -ObjectId $application.Id -KeyId $applicationPassword.KeyId</dev:code> <dev:remarks> <maml:para>This example removes the specified password from the specified application.</maml:para> <maml:para>- `-ObjectId` parameter specifies the unique identifier of the application.</maml:para> <maml:para>- `-KeyId` parameter specifies the unique identifier of the PasswordCredential.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplicationPassword</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationPassword</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplicationPasswordCredential</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplicationPasswordCredential</command:noun> <maml:description> <maml:para>Removes a password credential from an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaApplicationPasswordCredential` cmdlet removes a password credential from an application in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplicationPasswordCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyId</maml:name> <maml:description> <maml:para>Specifies the ID of the password credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of the application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyId</maml:name> <maml:description> <maml:para>Specifies the ID of the password credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of the application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Remove an application password credential -----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $application = Get-EntraBetaApplication -Filter "displayName eq 'Contoso Helpdesk Application'" $applicationPassword = Get-EntraBetaApplicationPasswordCredential -ApplicationId $application.Id | Where-Object {$_.DisplayName -eq 'ERP App Password'} Remove-EntraBetaApplicationPasswordCredential -ApplicationId $application.Id -KeyId $applicationPassword.KeyId</dev:code> <dev:remarks> <maml:para>This example demonstrates how to remove the password credential for an application.</maml:para> <maml:para>- `ApplicationId` Specifies the ID of the application. Use `Get-EntraBetaApplication` to get application ApplicationId value.</maml:para> <maml:para>- `KeyId` Specifies the ID of the password credential. Use `Get-EntraBetaApplicationPasswordCredential` to retrieve a specific credential details.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplicationPasswordCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationPasswordCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationPasswordCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplicationPolicy</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplicationPolicy</command:noun> <maml:description> <maml:para>Removes an application policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaApplicationPolicy` cmdlet removes an application policy from Microsoft Entra ID. Specify `Id`and `PolicyId` parameters to remove an specific application policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplicationPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Specifies the ID of the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the application for which you need to retrieve the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>PolicyId</maml:name> <maml:description> <maml:para>Specifies the ID of the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the application for which you need to retrieve the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Remove an application policy -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $params = @{ Id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' PolicyId = 'bbbbbbbb-1111-2222-3333-cccccccccccc' } Remove-EntraBetaApplicationPolicy @params</dev:code> <dev:remarks> <maml:para>This command removes the specified application policy.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplicationPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaApplicationPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplicationProxyApplication</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplicationProxyApplication</command:noun> <maml:description> <maml:para>Deletes an Application Proxy application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaApplicationProxyApplication` cmdlet removes Application Proxy configurations from a specific application in Microsoft Entra ID, and can delete the application completely if specified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplicationProxyApplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The unique application ID of the application. This ApplicationId can be found using the `Get-EntraBetaApplication` command. You can also find this ApplicationId in the Microsoft by navigating to Microsoft Entra ID > App registrations > All applications. Select your application. This will takes you to the application's overview page. Use the ObjectId on that page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RemoveADApplication</maml:name> <maml:description> <maml:para>This RemoveADApplication parameter allows you to delete application completely. When this RemoveADApplication is false (default), Application Proxy properties are removed from the application, but the application still exists. If this RemoveADApplication is true, the application is removed from Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The unique application ID of the application. This ApplicationId can be found using the `Get-EntraBetaApplication` command. You can also find this ApplicationId in the Microsoft by navigating to Microsoft Entra ID > App registrations > All applications. Select your application. This will takes you to the application's overview page. Use the ObjectId on that page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RemoveADApplication</maml:name> <maml:description> <maml:para>This RemoveADApplication parameter allows you to delete application completely. When this RemoveADApplication is false (default), Application Proxy properties are removed from the application, but the application still exists. If this RemoveADApplication is true, the application is removed from Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Remove a Proxy Application ------------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Remove-EntraBetaApplicationProxyApplication -ApplicationId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'</dev:code> <dev:remarks> <maml:para>This example removes a Proxy Application.</maml:para> <maml:para>- `ApplicationId` parameter specifies the application ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Remove a Proxy Application, and remove it from Microsoft Entra ID completely</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Remove-EntraBetaApplicationProxyApplication -ApplicationId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -RemoveADApplication $true</dev:code> <dev:remarks> <maml:para>This example removes a Proxy Application, and removes it from Microsoft Entra ID completely.</maml:para> <maml:para>- `ApplicationId` parameter specifies the application ID. - `RemoveADApplication` parameter specifies the user confirmation to delete application completely.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplicationProxyApplication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplicationProxyApplicationConnectorGroup</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplicationProxyApplicationConnectorGroup</command:noun> <maml:description> <maml:para>The `Remove-EntraBetaApplicationProxyApplicationConnectorGroupcmdlet` sets the connector group assigned for the specified application to 'Default' and removes the current assignment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If your application is already in the 'Default' group, you see an error because the application can't be removed from the 'Default' group unless it's being added to another group. The application must be configured for Application Proxy in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplicationProxyApplicationConnectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The unique application ID of the application. The application ID can be found using the `Get-EntraBetaApplication` command. You can also find objectId in the Microsoft Entra Admin Center by navigating to Microsoft Entra ID > App registrations > All applications. Select your application. From the application overview page, copy the ObjectId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The unique application ID of the application. The application ID can be found using the `Get-EntraBetaApplication` command. You can also find objectId in the Microsoft Entra Admin Center by navigating to Microsoft Entra ID > App registrations > All applications. Select your application. From the application overview page, copy the ObjectId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Remove the Connector Group associated with an application, setting the group to 'Default'</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Remove-EntraBetaApplicationProxyApplicationConnectorGroup -OnPremisesPublishingProfileId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'</dev:code> <dev:remarks> <maml:para>This example removes the Connector Group associated with an application, setting the group to 'Default.'</maml:para> <maml:para>- `OnPremisesPublishingProfileId` parameter specifies the application ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplicationProxyApplicationConnectorGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplicationProxyApplicationConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationProxyApplicationConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplicationProxyConnectorGroup</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplicationProxyConnectorGroup</command:noun> <maml:description> <maml:para>The `Remove-EntraBetaApplicationProxyConnectorGroup` cmdlet deletes an Application Proxy Connector group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaApplicationProxyConnectorGroup` cmdlet deletes an Application Proxy Connector Group. It can only be used on an empty connector group, with no connectors assigned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplicationProxyConnectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the Connector group to delete. You can find this value by running the `Get-EntraBetaApplicationProxyConnectorGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the Connector group to delete. You can find this value by running the `Get-EntraBetaApplicationProxyConnectorGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Remove a specific Connector Group ---------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Remove-EntraBetaApplicationProxyConnectorGroup -Id 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'</dev:code> <dev:remarks> <maml:para>This example removes a specific Connector Group.</maml:para> <maml:para>- `Id` parameter specifies the connector group ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplicationProxyConnectorGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaApplicationVerifiedPublisher</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaApplicationVerifiedPublisher</command:noun> <maml:description> <maml:para>Removes the verified publisher from an application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the verified publisher from an application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaApplicationVerifiedPublisher</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>AppObjectId</maml:name> <maml:description> <maml:para>The unique identifier of a Microsoft Entra ID Application object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>AppObjectId</maml:name> <maml:description> <maml:para>The unique identifier of a Microsoft Entra ID Application object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>- Example 1: Remove the verified publisher from an application -</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $application = Get-EntraBetaApplication -Filter "displayName eq 'Contoso Helpdesk Application'" Remove-EntraBetaApplicationVerifiedPublisher -AppObjectId $application.Id</dev:code> <dev:remarks> <maml:para>This command demonstrates how to remove the verified publisher from an application. - `-AppObjectId` parameter specifies the unique identifier of an application.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaApplicationVerifiedPublisher</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaApplicationVerifiedPublisher</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaDeletedApplication</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaDeletedApplication</command:noun> <maml:description> <maml:para>Permanently delete a recently deleted application object from deleted items.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Permanently delete a recently deleted application object from deleted items. After an item is permanently deleted, it can't be restored.</maml:para> <maml:para>For delegated scenarios, the calling user needs to have at least one of the following Microsoft Entra roles.</maml:para> <maml:para>- To permanently delete deleted applications or service principals: Application Administrator, Cloud Application Administrator, or Hybrid Identity Administrator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaDeletedApplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of deleted application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of deleted application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Remove deleted application object ---------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $deletedApplication = Get-EntraBetaDeletedApplication -SearchString 'My PowerShell Application' Remove-EntraBetaDeletedApplication -ObjectId $deletedApplication.Id</dev:code> <dev:remarks> <maml:para>This command removes recently deleted application. You can use the command `Get-EntraBetaDeletedApplication` to get deleted application Id.</maml:para> <maml:para>- `-ObjectId` parameter specifies the Id of a deleted application.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---- Example 2: Remove deleted application using pipelining ----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' Get-EntraBetaDeletedApplication -Filter "DisplayName eq 'My PowerShell Application'" | Remove-EntraBetaDeletedApplication</dev:code> <dev:remarks> <maml:para>This command removes recently deleted application using pipelining.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaDeletedApplication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restore-EntraBetaDeletedApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDeletedApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaDeletedDirectoryObject</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaDeletedDirectoryObject</command:noun> <maml:description> <maml:para>Permanently delete a previously deleted directory object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaDeletedDirectoryObject` cmdlet is used to permanently delete a previously deleted directory object.</maml:para> <maml:para>When a directory object is permanently deleted, it can no longer be restored.</maml:para> <maml:para>For delegated scenarios, the calling user needs to have at least one of the following Microsoft Entra roles.</maml:para> <maml:para>- To permanently delete applications or service principals: `Application Administrator`, `Cloud Application Administrator`, or `Hybrid Identity Administrator`.</maml:para> <maml:para>- To permanently delete users: `User Administrator`.</maml:para> <maml:para>- To permanently delete groups: `Groups Administrator`.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaDeletedDirectoryObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the directory object that is permanently deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the directory object that is permanently deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--- Example 1: Delete a previously deleted directory object ---</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Group.ReadWrite.All','Application.ReadWrite.All','User.ReadWrite.All' $deletedApplication = Get-EntraBetaDeletedApplication -SearchString 'My PowerShell Application' Remove-EntraBetaDeletedDirectoryObject -DirectoryObjectId $deletedApplication.Id</dev:code> <dev:remarks> <maml:para>This example demonstrates how to permanently delete a previously deleted directory object by ID.</maml:para> <maml:para>- `-Id` parameter specifies the ID of the directory object that is permanently deleted.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaDeletedDirectoryObject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDeletedDirectoryObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restore-EntraBetaDeletedDirectoryObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaPasswordSingleSignOnCredential</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaPasswordSingleSignOnCredential</command:noun> <maml:description> <maml:para>Removes the password Single-Sign-On (SSO) credentials.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet enables users to remove their Password Single-Sign-On credentials for an application that they're part of. Specify `ObjectId` and `PasswordSSOCredential` parameters to remove specific SSO credentials. Admin could remove the group credentials as well.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaPasswordSingleSignOnCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the object specific Microsoft Entra ID object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>PasswordSSOObjectId</maml:name> <maml:description> <maml:para>User or group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.PasswordSSOObjectId</command:parameterValue> <dev:type> <maml:name>System.PasswordSSOObjectId</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the object specific Microsoft Entra ID object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>PasswordSSOObjectId</maml:name> <maml:description> <maml:para>User or group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.PasswordSSOObjectId</command:parameterValue> <dev:type> <maml:name>System.PasswordSSOObjectId</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---- Example 1: Remove password single-sign-on credentials ----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All', 'Directory.ReadWrite.All' $servicePrincipal = Get-EntraBetaservicePrincipal -SearchString '<service-principal-name>' $params = @{ ObjectId = $servicePrincipal.Id PasswordSSOCredential = 'bbbbbbbb-1111-2222-3333-cccccccccccc' } Remove-EntraBetaPasswordSingleSignOnCredential @params</dev:code> <dev:remarks> <maml:para>This example removes the password SSO credentials for the given ObjectId and PasswordSSOObjectId.</maml:para> <maml:para>- `-PasswordSSOObjectId` parameter specifies the User or Group ID.</maml:para> <maml:para>- `-ObjectId` parameter specifies the object ID of a service principal.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaPasswordSingleSignOnCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaServicePrincipal</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaServicePrincipal</command:noun> <maml:description> <maml:para>Removes a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaServicePrincipal` cmdlet removes a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaServicePrincipal</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Removes a service principal ------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" | Remove-EntraBetaServicePrincipal</dev:code> <dev:remarks> <maml:para>This example demonstrates how to remove a service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaServicePrincipal</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaServicePrincipalAppRoleAssignment</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaServicePrincipalAppRoleAssignment</command:noun> <maml:description> <maml:para>Removes a service principal application role assignment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaServicePrincipalAppRoleAssignment` cmdlet removes a service principal application role assignment in Microsoft Entra ID.</maml:para> <maml:para>App roles which are assigned to service principals are also known as application permissions. Deleting an app role assignment for a service principal is equivalent to revoking the app-only permission grant.</maml:para> <maml:para>For delegated scenarios, the calling user needs at least one of the following Microsoft Entra roles.</maml:para> <maml:para>- Directory Synchronization Accounts</maml:para> <maml:para>- Directory Writer</maml:para> <maml:para>- Hybrid Identity Administrator</maml:para> <maml:para>- Identity Governance Administrator</maml:para> <maml:para>- Privileged Role Administrator</maml:para> <maml:para>- User Administrator</maml:para> <maml:para>- Application Administrator</maml:para> <maml:para>- Cloud Application Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaServicePrincipalAppRoleAssignment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>AppRoleAssignmentId</maml:name> <maml:description> <maml:para>Specifies the ID of the application role assignment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>AppRoleAssignmentId</maml:name> <maml:description> <maml:para>Specifies the ID of the application role assignment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>`Remove-EntraBetaServiceAppRoleAssignment` is an alias for `Remove-EntraBetaServicePrincipalAppRoleAssignment`.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Removes a service principal application role assignment</maml:title> <dev:code>Connect-Entra -Scopes 'AppRoleAssignment.ReadWrite.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" $group = Get-EntraBetaGroup -Filter "displayName eq 'Contoso marketing'" $assignment = Get-EntraBetaServicePrincipalAppRoleAssignment -ServicePrincipalId $servicePrincipal.Id | Where-Object {$_.PrincipalId -eq $group.Id} Remove-EntraBetaServicePrincipalAppRoleAssignment -ServicePrincipalId $servicePrincipal.Id -AppRoleAssignmentId $assignment.Id</dev:code> <dev:remarks> <maml:para>This example demonstrates how to remove a service principal application role assignment for a group in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` - specifies the unique identifier (Object ID) of the service principal or user from which you want to remove an app role assignment.</maml:para> <maml:para>- `-AppRoleAssignmentId` - specifies the unique identifier (ID) of the app role assignment that you want to remove.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaServicePrincipalAppRoleAssignment</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipalAppRoleAssignment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaServicePrincipalAppRoleAssignment</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaServicePrincipalDelegatedPermissionClassification</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaServicePrincipalDelegatedPermissionClassification</command:noun> <maml:description> <maml:para>Remove delegated permission classification.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaServicePrincipalDelegatedPermissionClassification` cmdlet deletes the given delegated permission classification by Id from service principal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>The unique identifier of a service principal object in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of a delegated permission classification object Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>The unique identifier of a service principal object in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of a delegated permission classification object Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--- Example 1: Remove a delegated permission classification ---</maml:title> <dev:code>Connect-Entra -Scopes 'Policy.ReadWrite.PermissionGrant' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" $permissionClassification = Get-EntraBetaServicePrincipalDelegatedPermissionClassification -ServicePrincipalId $servicePrincipal.Id | Where-Object {$_.PermissionName -eq 'Sites.Read.All'} Remove-EntraBetaServicePrincipalDelegatedPermissionClassification -ServicePrincipalId $servicePrincipal.Id -Id $permissionClassification.Id</dev:code> <dev:remarks> <maml:para>This command deletes the delegated permission classification by Id from the service principal.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the unique identifier of a service principal.</maml:para> <maml:para>- `-Id` parameter specifies the unique identifier of a delegated permission classification object Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipalDelegatedPermissionClassification</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaServicePrincipalOwner</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaServicePrincipalOwner</command:noun> <maml:description> <maml:para>Removes an owner from a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaServicePrincipalOwner` cmdlet removes an owner from a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaServicePrincipalOwner</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>Specifies the ID of the owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>Specifies the ID of the owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Removes an owner from a service principal -----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" $ownership = Get-EntraBetaServicePrincipalOwner -ServicePrincipalId $servicePrincipal.Id | Select-Object Id, userPrincipalName, DisplayName, '@odata.type' $owner = $ownership | Where-Object {$_.userPrincipalName -eq 'SawyerM@Contoso.com' } Remove-EntraBetaServicePrincipalOwner -ServicePrincipalId $servicePrincipal.Id -OwnerId $owner.Id</dev:code> <dev:remarks> <maml:para>This example demonstrates how to remove an owner from a service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the service principal Id.</maml:para> <maml:para>- `-OwnerId` parameter specifies the service principal owner Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaServicePrincipalOwner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaServicePrincipalOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipalOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaServicePrincipalPasswordCredential</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaServicePrincipalPasswordCredential</command:noun> <maml:description> <maml:para>Removes a password credential from a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaServicePrincipalPasswordCredential` cmdlet removes a password credential from a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaServicePrincipalPasswordCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyId</maml:name> <maml:description> <maml:para>Specifies the unique identifier of password credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeyId</maml:name> <maml:description> <maml:para>Specifies the unique identifier of password credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Remove a password credential from a service principal in Microsoft Entra ID</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" $key = Get-EntraBetaServicePrincipalPasswordCredential -ServicePrincipalId $servicePrincipal.Id $key = $key | Where-Object {$_.DisplayName -eq 'My Password friendly name'} Remove-EntraBetaServicePrincipalPasswordCredential -ServicePrincipalId $servicePrincipal.Id -KeyId $key.KeyId</dev:code> <dev:remarks> <maml:para>This example demonstrates how to remove a password credential from a service principal in Microsoft Entra ID. - `-ServicePrincipalId` parameter specifies the ObjectId of a specified Service Principal Password Credential. - `-KeyId` parameter specifies the unique identifier of a Password Credential.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaServicePrincipalPasswordCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipalPasswordCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaServicePrincipalPasswordCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restore-EntraBetaDeletedApplication</command:name> <command:verb>Restore</command:verb> <command:noun>EntraBetaDeletedApplication</command:noun> <maml:description> <maml:para>Restores a previously deleted application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet restores a previously deleted application.</maml:para> <maml:para>Restoring an application doesn't restore the associated service principal automatically. You must explicitly restore the deleted service principal.</maml:para> <maml:para>For delegated scenarios, the calling user needs to have at least one of the following Microsoft Entra roles.</maml:para> <maml:para>- Application Administrator</maml:para> <maml:para>- Cloud Application Administrator</maml:para> <maml:para>- Hybrid Identity Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restore-EntraBetaDeletedApplication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IdentifierUris</maml:name> <maml:description> <maml:para>The IdentifierUris of the application that is to be restored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The ObjectId of the deleted application that is to be restored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IdentifierUris</maml:name> <maml:description> <maml:para>The IdentifierUris of the application that is to be restored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The ObjectId of the deleted application that is to be restored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Restores a previously deleted application -----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $deletedApplication = Get-EntraBetaDeletedApplication -SearchString 'My PowerShell Application' Restore-EntraBetaDeletedApplication -ObjectId $deletedApplication.Id Id DeletedDateTime -- --------------- ffffffff-5555-6666-7777-aaaaaaaaaaaa</dev:code> <dev:remarks> <maml:para>This example shows how an application is deleted, then the deleted application is retrieved using the `Get-EntraBetaDeletedApplication` cmdlet, and subsequently the application is restored by specifying the application's Object ID in the `Restore-EntraBetaDeletedApplication` cmdlet.</maml:para> <maml:para>- `-ObjectId` parameter specifies the ObjectId of the deleted application that is to be restored.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Restore-EntraBetaDeletedApplication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDeletedApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDeletedApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Select-EntraBetaGroupIdsServicePrincipalIsMemberOf</command:name> <command:verb>Select</command:verb> <command:noun>EntraBetaGroupIdsServicePrincipalIsMemberOf</command:noun> <maml:description> <maml:para>Selects the groups in which a service principal is a member.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Select-EntraBetaGroupIdsServicePrincipalIsMemberOf` cmdlet selects the groups in which a service principal is a member in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Select-EntraBetaGroupIdsServicePrincipalIsMemberOf</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>GroupIdsForMembershipCheck</maml:name> <maml:description> <maml:para>Specifies an array of group object IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GroupIdsForMembershipCheck</command:parameterValue> <dev:type> <maml:name>GroupIdsForMembershipCheck</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>GroupIdsForMembershipCheck</maml:name> <maml:description> <maml:para>Specifies an array of group object IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GroupIdsForMembershipCheck</command:parameterValue> <dev:type> <maml:name>GroupIdsForMembershipCheck</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get the group membership of a group for a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.Read.All' $group = New-Object Microsoft.Open.AzureAD.Model.GroupIdsForMembershipCheck $group.GroupIds = (Get-EntraBetaGroup -Top 10).Id $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "DisplayName eq 'Helpdesk Application'" Select-EntraBetaGroupIdsServicePrincipalIsMemberOf -ObjectId $servicePrincipal.Id -GroupIdsForMembershipCheck $group aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb</dev:code> <dev:remarks> <maml:para>This command gets the group membership of a group for a specified service principal. Use the command `Get-EntraBetaGroup` to get group Id and `Get-EntraBetaServicePrincipal` to get service principal Id.</maml:para> <maml:para>- `-ObjectId` parameter specifies the service principal Id.</maml:para> <maml:para>- `-GroupIdsForMembershipCheck` parameter specifies the array of group object IDs.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Select-EntraBetaGroupIdsServicePrincipalIsMemberOf</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaApplication</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaApplication</command:noun> <maml:description> <maml:para>Updates the properties of an application object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the properties of an application object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaApplication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AddIns</maml:name> <maml:description> <maml:para>Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams might set the addIns property for its "FileHandler" functionality.</maml:para> <maml:para>This lets services like Office 365 call the application in the context of a document the user is working on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AddIn]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AddIn]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Api</maml:name> <maml:description> <maml:para>Specifies settings for an application that implements a web API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ApiApplication</command:parameterValue> <dev:type> <maml:name>ApiApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppRoles</maml:name> <maml:description> <maml:para>The collection of application roles that an application might declare.</maml:para> <maml:para>These roles can be assigned to users, groups, or service principals.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupMembershipClaims</maml:name> <maml:description> <maml:para>Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IdentifierUris</maml:name> <maml:description> <maml:para>Specifies identifier Uniform Resource Identifiers (URIs).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InformationalUrl</maml:name> <maml:description> <maml:para>Basic profile information of the application such as app's marketing, support, terms of service and privacy statement URLs.</maml:para> <maml:para>The terms of service and privacy statement are surfaced to users through the user consent experience.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InformationalUrl</command:parameterValue> <dev:type> <maml:name>InformationalUrl</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsDeviceOnlyAuthSupported</maml:name> <maml:description> <maml:para>Specifies if the application supports authentication using a device token.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsFallbackPublicClient</maml:name> <maml:description> <maml:para>Specifies the fallback application type as public client, such as an installed application running on a mobile device.</maml:para> <maml:para>The default value is `false` that means the fallback application type is confidential client such as web app.</maml:para> <maml:para>There are certain scenarios where Microsoft Entra ID can't determine the client application type (for example, ROPC flow where it's configured without specifying a redirect URI).</maml:para> <maml:para>In those cases Microsoft Entra ID interprets the application type based on the value of this property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyCredentials</maml:name> <maml:description> <maml:para>Specifies key credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OptionalClaims</maml:name> <maml:description> <maml:para>Application developers can configure optional claims in their Microsoft Entra ID apps to specify which claims they want in tokens sent to their application by the Microsoft security token service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OptionalClaims</command:parameterValue> <dev:type> <maml:name>OptionalClaims</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrgRestrictions</maml:name> <maml:description> <maml:para>Reserved for future use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ParentalControlSettings</maml:name> <maml:description> <maml:para>Specifies parental control settings for an application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ParentalControlSettings</command:parameterValue> <dev:type> <maml:name>ParentalControlSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredentials</maml:name> <maml:description> <maml:para>Specifies password credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreAuthorizedApplications</maml:name> <maml:description> <maml:para>Lists applications and requested permissions for implicit consent. Requires an admin to have provided consent to the application.</maml:para> <maml:para>preAuthorizedApplications don't require the user to consent to the requested permissions. Permissions listed in preAuthorizedApplications don't require user consent.</maml:para> <maml:para>However, any additional requested permissions not listed in preAuthorizedApplications require user consent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PreAuthorizedApplication]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PreAuthorizedApplication]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublicClient</maml:name> <maml:description> <maml:para>Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is `false`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PublicClientApplication</command:parameterValue> <dev:type> <maml:name>PublicClientApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RequiredResourceAccess</maml:name> <maml:description> <maml:para>Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources.</maml:para> <maml:para>This pre-configuration of required resource access drives the consent experience.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignInAudience</maml:name> <maml:description> <maml:para>Specifies what Microsoft accounts are supported for the current application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Custom strings that can be used to categorize and identify the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TokenEncryptionKeyId</maml:name> <maml:description> <maml:para>Specifies the keyId of a public key from the keyCredentials collection.</maml:para> <maml:para>When configured, Microsoft Entra ID encrypts all the tokens it emits by using the key this property points to.</maml:para> <maml:para>The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Web</maml:name> <maml:description> <maml:para>Specifies settings for a web application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebApplication</command:parameterValue> <dev:type> <maml:name>WebApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AddIns</maml:name> <maml:description> <maml:para>Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams might set the addIns property for its "FileHandler" functionality.</maml:para> <maml:para>This lets services like Office 365 call the application in the context of a document the user is working on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AddIn]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AddIn]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Api</maml:name> <maml:description> <maml:para>Specifies settings for an application that implements a web API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ApiApplication</command:parameterValue> <dev:type> <maml:name>ApiApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppRoles</maml:name> <maml:description> <maml:para>The collection of application roles that an application might declare.</maml:para> <maml:para>These roles can be assigned to users, groups, or service principals.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupMembershipClaims</maml:name> <maml:description> <maml:para>Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IdentifierUris</maml:name> <maml:description> <maml:para>Specifies identifier Uniform Resource Identifiers (URIs).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InformationalUrl</maml:name> <maml:description> <maml:para>Basic profile information of the application such as app's marketing, support, terms of service and privacy statement URLs.</maml:para> <maml:para>The terms of service and privacy statement are surfaced to users through the user consent experience.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InformationalUrl</command:parameterValue> <dev:type> <maml:name>InformationalUrl</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsDeviceOnlyAuthSupported</maml:name> <maml:description> <maml:para>Specifies if the application supports authentication using a device token.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsFallbackPublicClient</maml:name> <maml:description> <maml:para>Specifies the fallback application type as public client, such as an installed application running on a mobile device.</maml:para> <maml:para>The default value is `false` that means the fallback application type is confidential client such as web app.</maml:para> <maml:para>There are certain scenarios where Microsoft Entra ID can't determine the client application type (for example, ROPC flow where it's configured without specifying a redirect URI).</maml:para> <maml:para>In those cases Microsoft Entra ID interprets the application type based on the value of this property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyCredentials</maml:name> <maml:description> <maml:para>Specifies key credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies the ID of an application in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OptionalClaims</maml:name> <maml:description> <maml:para>Application developers can configure optional claims in their Microsoft Entra ID apps to specify which claims they want in tokens sent to their application by the Microsoft security token service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">OptionalClaims</command:parameterValue> <dev:type> <maml:name>OptionalClaims</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrgRestrictions</maml:name> <maml:description> <maml:para>Reserved for future use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ParentalControlSettings</maml:name> <maml:description> <maml:para>Specifies parental control settings for an application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ParentalControlSettings</command:parameterValue> <dev:type> <maml:name>ParentalControlSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredentials</maml:name> <maml:description> <maml:para>Specifies password credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreAuthorizedApplications</maml:name> <maml:description> <maml:para>Lists applications and requested permissions for implicit consent. Requires an admin to have provided consent to the application.</maml:para> <maml:para>preAuthorizedApplications don't require the user to consent to the requested permissions. Permissions listed in preAuthorizedApplications don't require user consent.</maml:para> <maml:para>However, any additional requested permissions not listed in preAuthorizedApplications require user consent.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PreAuthorizedApplication]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PreAuthorizedApplication]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublicClient</maml:name> <maml:description> <maml:para>Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is `false`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PublicClientApplication</command:parameterValue> <dev:type> <maml:name>PublicClientApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RequiredResourceAccess</maml:name> <maml:description> <maml:para>Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources.</maml:para> <maml:para>This pre-configuration of required resource access drives the consent experience.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SignInAudience</maml:name> <maml:description> <maml:para>Specifies what Microsoft accounts are supported for the current application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Custom strings that can be used to categorize and identify the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TokenEncryptionKeyId</maml:name> <maml:description> <maml:para>Specifies the keyId of a public key from the keyCredentials collection.</maml:para> <maml:para>When configured, Microsoft Entra ID encrypts all the tokens it emits by using the key this property points to.</maml:para> <maml:para>The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Web</maml:name> <maml:description> <maml:para>Specifies settings for a web application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebApplication</command:parameterValue> <dev:type> <maml:name>WebApplication</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.ApiApplication</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.InformationalUrl</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.OptionalClaims</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.ParentalControlSettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.PublicClientApplication</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.Open.MSGraph.Model.WebApplication</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AddIn]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AppRole]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.KeyCredential]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PasswordCredential]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.PreAuthorizedApplication]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RequiredResourceAccess]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Nullable`1[System.Boolean]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------- Example 1: Update an application ---------------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" $params = @{ ApplicationId = $application.Id DisplayName = 'Contoso Entra PowerShell App Production' IdentifierUris = 'https://contoso.com' GroupMembershipClaims = 'SecurityGroup' IsDeviceOnlyAuthSupported = $False Tags = 'mytag' } Set-EntraBetaApplication @params</dev:code> <dev:remarks> <maml:para>This command updates an application in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Update an application using IdentifierUris parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" Set-EntraBetaApplication -ApplicationId $application.Id -IdentifierUris 'https://mynewapp.contoso.com'</dev:code> <dev:remarks> <maml:para>This command updates an application in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Update an application using GroupMembershipClaims parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" Set-EntraBetaApplication -ApplicationId $application.Id -GroupMembershipClaims 'SecurityGroup'</dev:code> <dev:remarks> <maml:para>This command updates an application in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Update an application using IsDeviceOnlyAuthSupported parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" Set-EntraBetaApplication -ApplicationId $application.Id -IsDeviceOnlyAuthSupported $False</dev:code> <dev:remarks> <maml:para>This command updates an application in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---- Example 5: Update an application using Tags parameter ----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" Set-EntraBetaApplication -ApplicationId $application.Id -Tags 'mytag'</dev:code> <dev:remarks> <maml:para>This command updates an application in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaApplication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaApplicationLogo</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaApplicationLogo</command:noun> <maml:description> <maml:para>Sets the logo for an Application</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaApplicationLogo` cmdlet is used to set the logo for an application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaApplicationLogo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The file path of the file that is to be uploaded as the application logo.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ApplicationId of the Application for which the logo is set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The file path of the file that is to be uploaded as the application logo.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>The ApplicationId of the Application for which the logo is set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>System.IO.Stream System.Byte[]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>File uploads must be smaller than 500KB.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Sets the application logo for the application specified by the ApplicationId parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" Set-EntraBetaApplicationLogo -ApplicationId $application.Id -FilePath 'D:\applogo.jpg'</dev:code> <dev:remarks> <maml:para>This cmdlet sets the application logo for the application specified by the `-ApplicationId` parameter to the image specified with the `-FilePath` parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaApplicationLogo</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationLogo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaApplicationProxyApplication</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaApplicationProxyApplication</command:noun> <maml:description> <maml:para>The `Set-EntraBetaApplicationProxyApplication` allows you to modify and set configurations for an application in Microsoft Entra ID configured to use ApplicationProxy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaApplicationProxyApplication` allows you to modify and set other settings for an application in Microsoft Entra ID configured to use ApplicationProxy. Specify `ApplicationId` parameter to update application configured for application proxy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaApplicationProxyApplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies a unique application ID of an application in Microsoft Entra ID. This objectid can be found using the `Get-EntraBetaApplication` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ExternalUrl</maml:name> <maml:description> <maml:para>The address your users go to in order to access the app from outside your network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>InternalUrl</maml:name> <maml:description> <maml:para>The URL that you use to access the application from inside your private network. You can provide a specific path on the backend server to publish, while the rest of the server is unpublished. In this way, you can publish different sites on the same server as different apps, and give each one its own name and access rules. If you publish a path, make sure that it includes all the necessary images, scripts, and style sheets for your application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ExternalAuthenticationType</maml:name> <maml:description> <maml:para>How Application Proxy verifies users before giving them access to your application. AadPreAuth: Application Proxy redirects users to sign in with Microsoft Entra ID, which authenticates their permissions for the directory and application. We recommend keeping this option as the default, so that you can take advantage of Microsoft Entra ID security features like conditional access and multifactor authentication. Pass through: Users don't have to authenticate against Microsoft Entra ID to access the application. You can still set up authentication requirements on the backend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ExternalAuthenticationTypeEnum</command:parameterValue> <dev:type> <maml:name>ExternalAuthenticationTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsTranslateHostHeaderEnabled</maml:name> <maml:description> <maml:para>If set to true, translates urls in headers. Keep this value true unless your application required the original host header in the authentication request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsTranslateLinksInBodyEnabled</maml:name> <maml:description> <maml:para>If set to true, translates urls in body. Keep this value as No unless you have to hardcoded HTML links to other on-premises applications, and don't use custom domains.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ApplicationServerTimeout</maml:name> <maml:description> <maml:para>Specifies the backend server timeout type. Set this value to Long only if your application is slow to authenticate and connect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ApplicationServerTimeoutEnum</command:parameterValue> <dev:type> <maml:name>ApplicationServerTimeoutEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ConnectorGroupId</maml:name> <maml:description> <maml:para>Provide the ID of the Connector group you would like assigned to this application. You can find this value by using the `Get-EntraBetaApplicationProxyConnectorGroup` command. Connectors process the remote access to your application, and connector groups help you organize connectors and apps by region, network, or purpose. If you don't have any connector groups created yet, your app is assigned to Default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsHttpOnlyCookieEnabled</maml:name> <maml:description> <maml:para>Allows application proxy to include the HTTPOnly flag in HTTP response headers. This flag provides extra security benefits, for example, it prevents client-side scripting (CSS) from copying or modifying the cookies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsPersistentCookieEnabled</maml:name> <maml:description> <maml:para>Allows application proxy to set its access cookies to not expire when the web browser is closed. The persistence lasts until the access token expires, or until the user manually deletes the persistent cookies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsSecureCookieEnabled</maml:name> <maml:description> <maml:para>Allows application proxy to include the Secure flag in HTTP response headers. Secure Cookies enhances security by transmitting cookies over a "TLS" secured channel such as HTTPS. TLS prevents cookie transmission in clear text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ApplicationId</maml:name> <maml:description> <maml:para>Specifies a unique application ID of an application in Microsoft Entra ID. This objectid can be found using the `Get-EntraBetaApplication` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ExternalUrl</maml:name> <maml:description> <maml:para>The address your users go to in order to access the app from outside your network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>InternalUrl</maml:name> <maml:description> <maml:para>The URL that you use to access the application from inside your private network. You can provide a specific path on the backend server to publish, while the rest of the server is unpublished. In this way, you can publish different sites on the same server as different apps, and give each one its own name and access rules. If you publish a path, make sure that it includes all the necessary images, scripts, and style sheets for your application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ExternalAuthenticationType</maml:name> <maml:description> <maml:para>How Application Proxy verifies users before giving them access to your application. AadPreAuth: Application Proxy redirects users to sign in with Microsoft Entra ID, which authenticates their permissions for the directory and application. We recommend keeping this option as the default, so that you can take advantage of Microsoft Entra ID security features like conditional access and multifactor authentication. Pass through: Users don't have to authenticate against Microsoft Entra ID to access the application. You can still set up authentication requirements on the backend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ExternalAuthenticationTypeEnum</command:parameterValue> <dev:type> <maml:name>ExternalAuthenticationTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsTranslateHostHeaderEnabled</maml:name> <maml:description> <maml:para>If set to true, translates urls in headers. Keep this value true unless your application required the original host header in the authentication request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsTranslateLinksInBodyEnabled</maml:name> <maml:description> <maml:para>If set to true, translates urls in body. Keep this value as No unless you have to hardcoded HTML links to other on-premises applications, and don't use custom domains.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ApplicationServerTimeout</maml:name> <maml:description> <maml:para>Specifies the backend server timeout type. Set this value to Long only if your application is slow to authenticate and connect.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ApplicationServerTimeoutEnum</command:parameterValue> <dev:type> <maml:name>ApplicationServerTimeoutEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ConnectorGroupId</maml:name> <maml:description> <maml:para>Provide the ID of the Connector group you would like assigned to this application. You can find this value by using the `Get-EntraBetaApplicationProxyConnectorGroup` command. Connectors process the remote access to your application, and connector groups help you organize connectors and apps by region, network, or purpose. If you don't have any connector groups created yet, your app is assigned to Default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsHttpOnlyCookieEnabled</maml:name> <maml:description> <maml:para>Allows application proxy to include the HTTPOnly flag in HTTP response headers. This flag provides extra security benefits, for example, it prevents client-side scripting (CSS) from copying or modifying the cookies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsPersistentCookieEnabled</maml:name> <maml:description> <maml:para>Allows application proxy to set its access cookies to not expire when the web browser is closed. The persistence lasts until the access token expires, or until the user manually deletes the persistent cookies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>IsSecureCookieEnabled</maml:name> <maml:description> <maml:para>Allows application proxy to include the Secure flag in HTTP response headers. Secure Cookies enhances security by transmitting cookies over a "TLS" secured channel such as HTTPS. TLS prevents cookie transmission in clear text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Update ExternalUrl, InternalUrl, ExternalAuthenticationType, and IsTranslateHostHeaderEnabled parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $params = @{ ApplicationId = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' ExternalUrl = 'https://finance-awcycles.msappproxy.net/' InternalUrl = 'http://finance/' ExternalAuthenticationType = 'AadPreAuthentication' IsTranslateHostHeaderEnabled = $false } Set-EntraBetaApplicationProxyApplication @params ObjectId : aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb externalAuthenticationType : aadPreAuthentication applicationServerTimeout : Long externalUrl : https://testp-m365x99297270.msappproxy.net/ internalUrl : https://testp.com/ isTranslateHostHeaderEnabled : False isTranslateLinksInBodyEnabled : False isOnPremPublishingEnabled : True verifiedCustomDomainCertificatesMetadata : verifiedCustomDomainKeyCredential : verifiedCustomDomainPasswordCredential : singleSignOnSettings : @{singleSignOnMode=none; kerberosSignOnSettings=} isHttpOnlyCookieEnabled : False isSecureCookieEnabled : False isPersistentCookieEnabled : False</dev:code> <dev:remarks> <maml:para>This example update `ExternalUrl`, `InternalUrl`, `ExternalAuthenticationType`, and `IsTranslateHostHeaderEnabled` parameter.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the application ID.</maml:para> <maml:para>- `-ExternalUrl` parameter specifies the URL that use to access the application from outside user private network.</maml:para> <maml:para>- `-InternalUrl` parameter specifies the URL that use to access the application from inside user private network.</maml:para> <maml:para>- `-ExternalAuthenticationType` parameter specifies the external authentication type.</maml:para> <maml:para>- `-IsTranslateHostHeaderEnabled` parameter specifies the translates urls in headers.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Update IsHttpOnlyCookieEnabled, IsSecureCookieEnabled, and IsPersistentCookieEnabled parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $params = @{ ApplicationId = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' ExternalUrl = 'https://finance-awcycles.msappproxy.net/' InternalUrl = 'http://finance/' ExternalAuthenticationType = 'AadPreAuthentication' IsTranslateHostHeaderEnabled = $false IsHttpOnlyCookieEnabled = $false IsSecureCookieEnabled = $false IsPersistentCookieEnabled = $false } Set-EntraBetaApplicationProxyApplication @params ObjectId : aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb externalAuthenticationType : aadPreAuthentication applicationServerTimeout : Long externalUrl : https://testp-contoso.msappproxy.net/ internalUrl : https://testp.com/ isTranslateHostHeaderEnabled : False isTranslateLinksInBodyEnabled : False isOnPremPublishingEnabled : True verifiedCustomDomainCertificatesMetadata : verifiedCustomDomainKeyCredential : verifiedCustomDomainPasswordCredential : singleSignOnSettings : @{singleSignOnMode=none; kerberosSignOnSettings=} isHttpOnlyCookieEnabled : False isSecureCookieEnabled : False isPersistentCookieEnabled : False</dev:code> <dev:remarks> <maml:para>This example update `IsHttpOnlyCookieEnabled`, `IsSecureCookieEnabled`, and `IsPersistentCookieEnabled` parameter.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the application ID.</maml:para> <maml:para>- `-ExternalUrl` parameter specifies the URL that use to access the application from outside user private network.</maml:para> <maml:para>- `-InternalUrl` parameter specifies the URL that use to access the application from inside user private network.</maml:para> <maml:para>- `-ExternalAuthenticationType` parameter specifies the external authentication type.</maml:para> <maml:para>- `-IsHttpOnlyCookieEnabled` parameter specifies the application proxy to include the HTTPOnly flag in HTTP response headers.</maml:para> <maml:para>- `-IsSecureCookieEnabled` parameter specifies the application proxy to include the Secure flag in HTTP response headers.</maml:para> <maml:para>- `-IsTranslateHostHeaderEnabled` parameter specifies the translates urls in headers.</maml:para> <maml:para>- `-IsPersistentCookieEnabled` parameter specifies application proxy to set its access cookies to not expire when the web browser is closed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Update IsTranslateLinksInBodyEnabled, ApplicationServerTimeout, and ConnectorGroupId parameter</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $params = @{ ApplicationId = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' ExternalUrl = 'https://finance-awcycles.msappproxy.net/' InternalUrl = 'http://finance/' ExternalAuthenticationType = 'AadPreAuthentication' IsTranslateHostHeaderEnabled = $false ApplicationServerTimeout = Long ConnectorGroupId = 'bbbbbbbb-1111-2222-3333-cccccccccccc' } Set-EntraBetaApplicationProxyApplication @params ObjectId : aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb externalAuthenticationType : aadPreAuthentication applicationServerTimeout : Long externalUrl : https://testp-contoso.msappproxy.net/ internalUrl : https://testp.com/ isTranslateHostHeaderEnabled : False isTranslateLinksInBodyEnabled : False isOnPremPublishingEnabled : True verifiedCustomDomainCertificatesMetadata : verifiedCustomDomainKeyCredential : verifiedCustomDomainPasswordCredential : singleSignOnSettings : @{singleSignOnMode=none; kerberosSignOnSettings=} isHttpOnlyCookieEnabled : False isSecureCookieEnabled : False isPersistentCookieEnabled : False</dev:code> <dev:remarks> <maml:para>This example update `IsTranslateLinksInBodyEnabled`, `ApplicationServerTimeout`, and `ConnectorGroupId` parameter.</maml:para> <maml:para>- `-ApplicationId` parameter specifies the application ID.</maml:para> <maml:para>- `-ExternalUrl` parameter specifies the URL that use to access the application from outside user private network.</maml:para> <maml:para>- `-InternalUrl` parameter specifies the URL that use to access the application from inside user private network.</maml:para> <maml:para>- `-ConnectorGroupId` parameter specifies the Connector group ID that assigned to this application.</maml:para> <maml:para>- `-ApplicationServerTimeout` parameter specifies the application server timeout to set.</maml:para> <maml:para>- `-ExternalAuthenticationType` parameter specifies the external authentication type.</maml:para> <maml:para>- `-IsTranslateHostHeaderEnabled` parameter specifies the translates urls in headers.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaApplicationProxyApplication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationProxyApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaApplicationProxyApplicationConnectorGroup</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaApplicationProxyApplicationConnectorGroup</command:noun> <maml:description> <maml:para>The `Set-EntraBetaApplicationProxyApplicationConnectorGroup` cmdlet assigns the given connector group to a specified application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaApplicationProxyApplicationConnectorGroup` cmdlet sets the connector group assigned for the specified application. Specify `OnPremisesPublishingProfileId` and `ConnectorGroupId` parameter to assign the given connector group to a specified application.</maml:para> <maml:para>The application must be configured for Application Proxy in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaApplicationProxyApplicationConnectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ConnectorGroupId</maml:name> <maml:description> <maml:para>The ID of the Connector group that should be assigned to the application. Use the `Get-EntraBetaApplicationProxyConnectorGroup` command to find the Connector Group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The unique application ID for the application the Connector group assigns to. The application ID can be found using the `Get-EntraBetaApplication` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ConnectorGroupId</maml:name> <maml:description> <maml:para>The ID of the Connector group that should be assigned to the application. Use the `Get-EntraBetaApplicationProxyConnectorGroup` command to find the Connector Group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The unique application ID for the application the Connector group assigns to. The application ID can be found using the `Get-EntraBetaApplication` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Set a new Connector Group for a specific application</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $params = @{ OnPremisesPublishingProfileId = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' ConnectorGroupId = 'bbbbbbbb-1111-2222-3333-cccccccccccc' } Set-EntraBetaApplicationProxyApplicationConnectorGroup @params</dev:code> <dev:remarks> <maml:para>This example set a new Connector Group for a specific application.</maml:para> <maml:para>- `OnPremisesPublishingProfileId` parameter specifies the application ID.</maml:para> <maml:para>- `ConnectorGroupId` parameter specifies the connector group ID that assign to the application.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaApplicationProxyApplicationConnectorGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationProxyApplicationConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationProxyApplicationConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaApplicationProxyApplicationSingleSignOn</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaApplicationProxyApplicationSingleSignOn</command:noun> <maml:description> <maml:para>The `Set-EntraBetaApplicationProxyApplicationSingleSignOn` cmdlet allows you to set and modify single sign-on (SSO) settings for an application configured for Application Proxy in Microsoft Entra ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaApplicationProxyApplicationSingleSignOn` cmdlet allows you to set and modify single sign-on (SSO) settings for an application configured for Application Proxy in Microsoft Entra ID. This is limited to setting No SSO, Kerberos Constrained Delegation (for applications using Integrated Windows Authentication), and Header-based SSO.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaApplicationProxyApplicationSingleSignOn</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KerberosDelegatedLoginIdentity</maml:name> <maml:description> <maml:para>The identity that the Connector can use on behalf of your users to authenticate.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">UserPrincipalName</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OnPremisesUserPrincipalName</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UserPrincipalUsername</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OnPremisesUserPrincipalUsername</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OnPremisesSAMAccountName</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">KerberosSignOnMappingAttributeTypeEnum</command:parameterValue> <dev:type> <maml:name>KerberosSignOnMappingAttributeTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KerberosInternalApplicationServicePrincipalName</maml:name> <maml:description> <maml:para>The internal application SPN of the application server. This ServicePrincipalName (SPN) needs to be in the list of services to which the Connector can present delegated credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique application ID of the application that needs different SSO settings. ObjectId can be found using the `Get-EntraBetaApplication` command. You can also find this in the Microsoft Portal by navigating to Microsoft Entra ID, Enterprise Applications, All Applications, Select your application, go to the properties tab, and use the ObjectId on that page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SingleSignOnMode</maml:name> <maml:description> <maml:para>Choose the type of SSO you would like the application to use. Only three SSO settings are supported in PowerShell, for more options, please use the Microsoft Portal.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OnPremisesKerberos</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HeaderBased</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">SingleSignOnModeEnum</command:parameterValue> <dev:type> <maml:name>SingleSignOnModeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KerberosDelegatedLoginIdentity</maml:name> <maml:description> <maml:para>The identity that the Connector can use on behalf of your users to authenticate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KerberosSignOnMappingAttributeTypeEnum</command:parameterValue> <dev:type> <maml:name>KerberosSignOnMappingAttributeTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KerberosInternalApplicationServicePrincipalName</maml:name> <maml:description> <maml:para>The internal application SPN of the application server. This ServicePrincipalName (SPN) needs to be in the list of services to which the Connector can present delegated credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique application ID of the application that needs different SSO settings. ObjectId can be found using the `Get-EntraBetaApplication` command. You can also find this in the Microsoft Portal by navigating to Microsoft Entra ID, Enterprise Applications, All Applications, Select your application, go to the properties tab, and use the ObjectId on that page.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SingleSignOnMode</maml:name> <maml:description> <maml:para>Choose the type of SSO you would like the application to use. Only three SSO settings are supported in PowerShell, for more options, please use the Microsoft Portal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SingleSignOnModeEnum</command:parameterValue> <dev:type> <maml:name>SingleSignOnModeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>System.Nullable`1[[Microsoft.Open.MSGraph.Model.OnPremisesPublishingSingleSignOnObject+SingleSignOnModeEnum, Microsoft.Open.MS.GraphV10.Client, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]] System.Nullable`1[[Microsoft.Open.MSGraph.Model.OnPremisesPublishingKerberosSignOnSettingsObject+KerberosSignOnMappingAttributeTypeEnum, Microsoft.Open.MS.GraphV10.Client, Version=2.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Assign an application to use Kerberos Constrained Delegation, and specify required parameters</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $params = @{ ObjectId = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' SingleSignOnMode = 'OnPremisesKerberos' KerberosInternalApplicationServicePrincipalName = 'https/www.adventure-works.com' KerberosDelegatedLoginIdentity = 'OnPremisesUserPrincipalName' } Set-EntraBetaApplicationProxyApplicationSingleSignOn @params</dev:code> <dev:remarks> <maml:para>This example assigns an application to use Kerberos Constrained Delegation, and specify required parameters.</maml:para> <maml:para>- `-ObjectId` parameter specifies the application ID.</maml:para> <maml:para>- `-SingleSignOnMode` parameter specifies the type of SSO.</maml:para> <maml:para>- `-KerberosInternalApplicationServicePrincipalName` parameter specifies the internal application ServicePrincipalName of the application server.</maml:para> <maml:para>- `-KerberosDelegatedLoginIdentity` parameter specifies the Connector group ID that assigned to this application.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2: Remove SSO from an application ----------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $params = @{ ObjectId = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' SingleSignOnMode = 'None' } Set-EntraBetaApplicationProxyApplicationSingleSignOn @params</dev:code> <dev:remarks> <maml:para>This example demonstrates how to remove SSO from an application.</maml:para> <maml:para>- `-ObjectId` parameter specifies the application ID.</maml:para> <maml:para>- `-SingleSignOnMode` parameter specifies the type of SSO.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaApplicationProxyApplicationSingleSignOn</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaApplicationProxyConnector</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaApplicationProxyConnector</command:noun> <maml:description> <maml:para>The `Set-EntraBetaApplicationProxyConnector` cmdlet allows reassignment of the connector to another connector group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaApplicationProxyConnector` cmdlet allows reassignment of the connector to another connector group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaApplicationProxyConnector</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The ID of the Connector being moved. Use the `Get-EntraBetaApplicationProxyConnectorGroup` command to find the Connector Group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ConnectorGroupId</maml:name> <maml:description> <maml:para>The unique identifer of the target application proxy connector group in Microsoft Entra ID. Find this value using the `Get-EntraBetaApplicationProxyConnectorGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>OnPremisesPublishingProfileId</maml:name> <maml:description> <maml:para>The ID of the Connector being moved. Use the `Get-EntraBetaApplicationProxyConnectorGroup` command to find the Connector Group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ConnectorGroupId</maml:name> <maml:description> <maml:para>The unique identifer of the target application proxy connector group in Microsoft Entra ID. Find this value using the `Get-EntraBetaApplicationProxyConnectorGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-- Example 1: Move a Connector to a different Connector Group --</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' $params = @{ OnPremisesPublishingProfileId = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' ConnectorGroupId = 'bbbbbbbb-1111-2222-3333-cccccccccccc' } Set-EntraBetaApplicationProxyConnector @params</dev:code> <dev:remarks> <maml:para>This example demonstrates how to move a Connector to a different Connector Group.</maml:para> <maml:para>- `-OnPremisesPublishingProfileId` parameter specifies the connector ID.</maml:para> <maml:para>- `-ConnectorGroupId` parameter specifies the application proxy connector group ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaApplicationProxyConnector</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationProxyConnector</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaApplicationProxyConnectorGroup</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaApplicationProxyConnectorGroup</command:noun> <maml:description> <maml:para>The `Set-EntraBetaApplicationProxyConnectorGroup` cmdlet allows you to change the name of a given Application Proxy connector group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaApplicationProxyConnectorGroup` cmdlet allows you to change the name of a given Application Proxy connector group. Specify `Id` and `Name` parameters to updates an connector group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaApplicationProxyConnectorGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of the Connector group that should be renamed. You can find the ID using the `Get-EntraBetaApplicationProxyConnectorGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name for the Connector group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Name</command:parameterValue> <dev:type> <maml:name>System.Name</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of the Connector group that should be renamed. You can find the ID using the `Get-EntraBetaApplicationProxyConnectorGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name for the Connector group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Name</command:parameterValue> <dev:type> <maml:name>System.Name</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Rename a Connector Group to "Offsite Application Servers"</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Set-EntraBetaApplicationProxyConnectorGroup -Id 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -Name 'Offsite Application Servers'</dev:code> <dev:remarks> <maml:para>This example rename a Connector Group to "Offsite Application Servers"</maml:para> <maml:para>- `Id` parameter specifies the connector group ID.</maml:para> <maml:para>- `Name` parameter specifies the name for connector group.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaApplicationProxyConnectorGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationProxyConnectorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaApplicationVerifiedPublisher</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaApplicationVerifiedPublisher</command:noun> <maml:description> <maml:para>Sets the verified publisher of an application to a verified Microsoft Partner Network (MPN) identifier.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the verified publisher of an application to a verified Microsoft Partner Network (MPN) identifier.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaApplicationVerifiedPublisher</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>AppObjectId</maml:name> <maml:description> <maml:para>The unique identifier of a Microsoft Entra ID Application object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SetVerifiedPublisherRequest</maml:name> <maml:description> <maml:para>A request body object containing the verifiedPublisherId property it's the MPNID value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SetVerifiedPublisherRequest</command:parameterValue> <dev:type> <maml:name>SetVerifiedPublisherRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>AppObjectId</maml:name> <maml:description> <maml:para>The unique identifier of a Microsoft Entra ID Application object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SetVerifiedPublisherRequest</maml:name> <maml:description> <maml:para>A request body object containing the verifiedPublisherId property it's the MPNID value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SetVerifiedPublisherRequest</command:parameterValue> <dev:type> <maml:name>SetVerifiedPublisherRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--- Example 1: Set the verified publisher of an application ---</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All' $application = Get-EntraBetaApplication -Filter "DisplayName eq 'Contoso Helpdesk Application'" $mpnId = '0433167' $req = @{verifiedPublisherId = $mpnId} Set-EntraBetaApplicationVerifiedPublisher -AppObjectId $application.Id -SetVerifiedPublisherRequest $req</dev:code> <dev:remarks> <maml:para>This command sets the verified publisher of an application.</maml:para> <maml:para>The Microsoft Partner Network ID (MPNID) of the verified publisher can be obtained from the publisher's Partner Center account.</maml:para> <maml:para>- `-AppObjectId` parameter specifies the unique identifier of a Microsoft Entra ID Application.</maml:para> <maml:para>- `-SetVerifiedPublisherRequest` parameter specifies the request body object containing the verifiedPublisherId property with it's the MPNID value.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaApplicationVerifiedPublisher</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaApplicationVerifiedPublisher</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaPasswordSingleSignOnCredential</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaPasswordSingleSignOnCredential</command:noun> <maml:description> <maml:para>Sets the password Single-Sign-On (SSO) credentials.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet enables users to set their Password Single-Sign-On credentials for an application that they're part of. Specify `ObjectId` and `PasswordSSOCredential` parameters to updates SSO credentials. Admin could set the group credentials as well.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaPasswordSingleSignOnCredential</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the object specific Microsoft Entra ID object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>PasswordSSOCredential</maml:name> <maml:description> <maml:para>User or group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.PasswordSSOCredentials</command:parameterValue> <dev:type> <maml:name>System.PasswordSSOCredentials</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ObjectId</maml:name> <maml:description> <maml:para>The unique identifier of the object specific Microsoft Entra ID object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>PasswordSSOCredential</maml:name> <maml:description> <maml:para>User or group ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.PasswordSSOCredentials</command:parameterValue> <dev:type> <maml:name>System.PasswordSSOCredentials</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Set password single-sign-on credentials ------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Directory.ReadWrite.All' $servicePrincipal = Get-EntraBetaservicePrincipal -SearchString '<service-principal-name>' $credentials = New-Object -TypeName Microsoft.Open.MSGraph.Model.PasswordSSOCredentials $credentials.Id = '<user-or-group-Id>' $creds1 = [Microsoft.Open.MSGraph.Model.PasswordSSOCredential]@{FieldId="param_emailOrUserName"; Value="foobar@ms.com"; Type="text"} $creds2 = [Microsoft.Open.MSGraph.Model.PasswordSSOCredential]@{FieldId="param_password"; Value="my-secret"; Type="password"} $credentials.Credentials = @($creds1, $creds2) $params = @{ ObjectId = $servicePrincipal.Id PasswordSSOCredential = $credentials } Set-EntraBetaPasswordSingleSignOnCredential @params</dev:code> <dev:remarks> <maml:para>This example demonstrates how to set the password SSO credentials for the given ObjectId and PasswordSSOObjectId.</maml:para> <maml:para>- `-PasswordSSOObjectId` parameter specifies the User or Group ID.</maml:para> <maml:para>- `-ObjectId` parameter specifies the object ID of a service principal.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaPasswordSingleSignOnCredential</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaPasswordSingleSignOnCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaServicePrincipal</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaServicePrincipal</command:noun> <maml:description> <maml:para>Updates a service principal.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaServicePrincipal` cmdlet updates a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaServicePrincipal</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccountEnabled</maml:name> <maml:description> <maml:para>Indicates whether the account is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlternativeNames</maml:name> <maml:description> <maml:para>The alternative names for this service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppId</maml:name> <maml:description> <maml:para>Specifies the application ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppRoleAssignmentRequired</maml:name> <maml:description> <maml:para>Indicates whether an application role assignment is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Homepage</maml:name> <maml:description> <maml:para>Specifies the home page or landing page of the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyCredentials</maml:name> <maml:description> <maml:para>Specifies key credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LogoutUrl</maml:name> <maml:description> <maml:para>Specifies the sign out URL.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Species the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredentials</maml:name> <maml:description> <maml:para>Specifies password credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreferredSingleSignOnMode</maml:name> <maml:description> <maml:para>Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the My Apps portal. The supported values are password, saml, notSupported, and oidc.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReplyUrls</maml:name> <maml:description> <maml:para>The URLs that user tokens are sent to for sign in with the associated application, or the redirect Uniform Resource Identifiers that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalNames</maml:name> <maml:description> <maml:para>Specifies service principal names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalType</maml:name> <maml:description> <maml:para>The service principal type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies an array of tags.</maml:para> <maml:para>If you intend for this service principal to show up in the All Applications list in the admin portal, you need to set this value to {WindowsAzureActiveDirectoryIntegratedApp}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccountEnabled</maml:name> <maml:description> <maml:para>Indicates whether the account is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlternativeNames</maml:name> <maml:description> <maml:para>The alternative names for this service principal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppId</maml:name> <maml:description> <maml:para>Specifies the application ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppRoleAssignmentRequired</maml:name> <maml:description> <maml:para>Indicates whether an application role assignment is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Homepage</maml:name> <maml:description> <maml:para>Specifies the home page or landing page of the application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>KeyCredentials</maml:name> <maml:description> <maml:para>Specifies key credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.KeyCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>LogoutUrl</maml:name> <maml:description> <maml:para>Specifies the sign out URL.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>Species the ID of a service principal in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PasswordCredentials</maml:name> <maml:description> <maml:para>Specifies password credentials.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.PasswordCredential]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreferredSingleSignOnMode</maml:name> <maml:description> <maml:para>Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the My Apps portal. The supported values are password, saml, notSupported, and oidc.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReplyUrls</maml:name> <maml:description> <maml:para>The URLs that user tokens are sent to for sign in with the associated application, or the redirect Uniform Resource Identifiers that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalNames</maml:name> <maml:description> <maml:para>Specifies service principal names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ServicePrincipalType</maml:name> <maml:description> <maml:para>The service principal type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Specifies an array of tags.</maml:para> <maml:para>If you intend for this service principal to show up in the All Applications list in the admin portal, you need to set this value to {WindowsAzureActiveDirectoryIntegratedApp}.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---- Example 1: Disable the account of a service principal ----</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Set-EntraBetaServicePrincipal -ServicePrincipalId $servicePrincipal.Id -AccountEnabled $false</dev:code> <dev:remarks> <maml:para>This example demonstrates how to update `AccountEnabled` of a service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> <maml:para>- `-AccountEnabled` parameter specifies indicates whether the account is enabled.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 2: Update Homepage of a service principal ------</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" $homePage = 'https://*.e-days.com/SSO/SAML2/SP/AssertionConsumer.aspx?metadata=e-days|ISV9.2|primary|z' Set-EntraBetaServicePrincipal -ServicePrincipalId $servicePrincipal.Id -Homepage $homePage</dev:code> <dev:remarks> <maml:para>This example demonstrates how to update `AppId` and Homepage of a service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> <maml:para>- `-AppId` parameter specifies the application ID.</maml:para> <maml:para>- `-Homepage` parameter specifies the home page or landing page of the application.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Update AlternativeNames and DisplayName of a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Set-EntraBetaServicePrincipal -ServicePrincipalId $servicePrincipal.Id -AlternativeNames 'Helpdesk Application Global' -DisplayName 'NewName'</dev:code> <dev:remarks> <maml:para>This example demonstrates how to update AlternativeNames and DisplayName of a service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Update LogoutUrl and ReplyUrls of a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" $logoutUrl = 'https://securescore.office.com/SignOut' $replyUrls = 'https://admin.contoso.com' Set-EntraBetaServicePrincipal -ServicePrincipalId $servicePrincipal.Id -LogoutUrl $logoutUrl -ReplyUrls $replyUrls</dev:code> <dev:remarks> <maml:para>This example demonstrates how to update LogoutUrl and ReplyUrls of a service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> <maml:para>- `-LogoutUrl` parameter specifies the sign out URL.</maml:para> <maml:para>- `-ReplyUrls` parameter specifies the URLs that user tokens are sent to for sign in with the associated application.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 5: Update ServicePrincipalType and AppRoleAssignmentRequired of a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Set-EntraBetaServicePrincipal -ServicePrincipalId $servicePrincipal.Id -ServicePrincipalType 'Application' -AppRoleAssignmentRequired $True</dev:code> <dev:remarks> <maml:para>This example demonstrates how to update `ServicePrincipalType` and `AppRoleAssignmentRequired` of a service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> <maml:para>- `-ServicePrincipalType` parameter specifies the service principal type.</maml:para> <maml:para>- `-AppRoleAssignmentRequired` parameter specifies indicates whether an application role assignment is required.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--- Example 6: Update KeyCredentials of a service principal ---</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" $creds = New-Object Microsoft.Open.AzureAD.Model.KeyCredential $creds.CustomKeyIdentifier = [System.Text.Encoding]::UTF8.GetBytes('Test') $startdate = Get-Date -Year 2024 -Month 10 -Day 10 $creds.StartDate = $startdate $creds.Type = 'Symmetric' $creds.Usage = 'Sign' $creds.Value = [System.Text.Encoding]::UTF8.GetBytes('A') $creds.EndDate = Get-Date -Year 2025 -Month 12 -Day 20 Set-EntraBetaServicePrincipal -ServicePrincipalId $servicePrincipal.ObjectId -KeyCredentials $creds</dev:code> <dev:remarks> <maml:para>This example demonstrates how to update KeyCredentials of a service principal in Microsoft Entra ID.</maml:para> <maml:para>Use the `New-EntraBetaServicePrincipalPasswordCredential` and `Remove-EntraBetaServicePrincipalPasswordCredential` cmdlets to update the password or secret for a servicePrincipal.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 7: Update PreferredSingleSignOnMode of a service principal</maml:title> <dev:code>Connect-Entra -Scopes 'Application.ReadWrite.All','Application.ReadWrite.OwnedBy' $servicePrincipal = Get-EntraBetaServicePrincipal -Filter "displayName eq 'Helpdesk Application'" Set-EntraBetaServicePrincipal -ServicePrincipalId $servicePrincipal.Id -PreferredSingleSignOnMode 'saml'</dev:code> <dev:remarks> <maml:para>This example demonstrates how to update `PreferredSingleSignOnMode` of a service principal in Microsoft Entra ID.</maml:para> <maml:para>- `-ServicePrincipalId` parameter specifies the ID of a service principal.</maml:para> <maml:para>- `-PreferredSingleSignOnMode` parameter specifies the single sign-on mode configured for this application.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaServicePrincipal</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaServicePrincipal</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |