Share via

Get-CrmInstance

  • Reference
Module:
Microsoft.Xrm.OnlineManagementAPI

Retrieves a Dataverse environment in your Office 365 tenant.

Syntax

Get-CrmInstance
   -Id <Guid>
   [-ApiUrl] <Uri>
   [[-Credential] <PSCredential>]
   [-MaxCrmConnectionTimeOutMinutes <Int32>]

Description

The Get-CrmInstance cmdlet retrieves a Dataverse environment in your Office 365 tenant.

Examples

Example 1

PS C:\> Get-CrmInstance -Id <Guid> -ApiUrl $connectionhost -Credential $cred

Retrieves details about a specific instance as specified by using the -Id parameter.

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

-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

-Id

Id for the specific Dataverse environment. Use the Get-CrmInstances cmdlet to find all Ids within the same tenant.

Type:Guid
Position:Named
Default value:None
Required:True
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

System.Guid

System.Uri System.Management.Automation.PSCredential System.Int32

Outputs

System.Object