Get-CrmInstanceType

  • Reference
Module:
Microsoft.Xrm.OnlineManagementAPI

Retrieves information about a Dataverse environment type.

Syntax

Get-CrmInstanceType
   -InstanceType <InstanceType>
   [-ApiUrl] <Uri>
   [[-Credential] <PSCredential>]
   [-MaxCrmConnectionTimeOutMinutes <Int32>]

Description

The Get-CrmInstanceType cmdlet retrieves information about a Dataverse environment type.

Examples

Example 1

PS C:\> Get-CrmInstanceType -ApiUrl $connectionhost -InstanceType Production -Credential $cred

Retrieves the total number of production environment that are provisioned and the total number available for provisioning.

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

-InstanceType

The environment type.The following are valid types:

  • Production
  • Sandbox
  • Support
  • Preview
  • Trial
Type:InstanceType
Accepted values:None, Production, Sandbox, Support, Preview, Trial
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

Microsoft.Xrm.Services.Admin.Client.Models.InstanceType

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

Outputs

System.Object