New-CrmManagementApp

Reference

Module:: Microsoft.Xrm.OnlineManagementAPI

Registers an Azure Active Directory Web app/API to be used with the Microsoft.Xrm.OnlineManagementAPI PowerShell module.

Syntax

New-CrmManagementApp
   [-AppId] <Guid>
   [-ApiUrl] <Uri>
   [[-Credential] <PSCredential>]
   [-MaxCrmConnectionTimeOutMinutes <Int32>]

Description

The New-CrmManagementApp cmdlet registers an Azure Active Directory Web app/API based on the app Id so it can be used with the Microsoft.Xrm.OnlineManagementAPI PowerShell module.

Examples

Example 1

New-CrmManagementApp -AppId <Guid> -Enable -ApiUrl $connectionhost -Credential $cred

Registers and enables an Azure Active Directory Web app/API for use with the Microsoft.Xrm.OnlineManagementAPI PowerShell module.

Parameters

-ApiUrl

URL of the Dataverse root service endpoint. For information about this parameter see Establish your credentials and connection.

Type:	Uri
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-AppId

The application Id of the the Azure Active Directory Web app / API app. You can find the application Ids for Azure Active Directory Web app / API applications by running the Get-AzureADApplication Azure Active Directory PowerShell cmdlet or from the Azure Active Directory admin center.

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

-Credential

User credential for signing in to Dataverse. For information about this parameter see Establish your credentials and connection.

Type:	PSCredential
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Enable

Enables the app for use with the Microsoft.Xrm.OnlineManagmentAPI PowerShell module.

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

-MaxCrmConnectionTimeOutMinutes

Maximum number in minutes to wait before quitting the operation.

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

Inputs

Microsoft.Xrm.Services.Admin.Client.Models.TenantApplicationIdentity

System.Guid System.Management.Automation.SwitchParameter System.Uri System.Management.Automation.PSCredential System.Int32

Outputs

System.Object