< Back
Register-TestSuite
Post
NAME Register-TestSuite
SYNOPSIS
Register a test suite.
SYNTAX
Register-TestSuite [-ApiUrl] <Uri> [-OrganizationId] <Guid> [[-ApiCredential] <PSCredential>]
-OrganizationUniqueName <string> -TestSuiteName <string> -TestSuiteUrl <string> -TestUserCredential <PSCredential>
[-CompletionCallbackUrl <string>] [-ConnectionTimeoutInMinutes <int>] [<CommonParameters>]
DESCRIPTION
Register a test suite on the specified organization
Returns True if successful
PARAMETERS
-TestSuiteName <string>
Test Suite Name
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Name <string>
Test Suite Name
This is an alias of the TestSuiteName parameter.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-OrganizationUniqueName <string>
Organization Unique Name
This value can be obtained from CRM -> Settings -> Customizations -> Developer Resources page
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-TestSuiteUrl <string>
The URL to the test suite ZIP file
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CompletionCallbackUrl <string>
The callback URL to be called at the completion of test suite runs
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TestUserCredential <PSCredential>
Credentials to be used by the test suite to call CRM endpoint
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ApiUrl <Uri>
URI for the Admin API server
Required? true
Position? 0
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ApiCredential <PSCredential>
Login credentials for the Admin API
Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-OrganizationId <Guid>
Organization Id against which the tests will need to run
This value can be obtained from CRM -> Settings -> Customizations -> Developer Resources page
Required? true
Position? 1
Default value 00000000-0000-0000-0000-000000000000
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ConnectionTimeoutInMinutes <int>
Amount of time that the client will wait till it times out
Required? false
Position? named
Default value 2
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Test Suite Name
System.String
Organization Unique Name
This value can be obtained from CRM -> Settings -> Customizations -> Developer Resources page
System.Management.Automation.PSCredential
Credentials to be used by the test suite to call CRM endpoint
System.Uri
URI for the Admin API server
System.Management.Automation.PSCredential
Login credentials for the Admin API
System.Guid
Organization Id against which the tests will need to run
This value can be obtained from CRM -> Settings -> Customizations -> Developer Resources page
System.Int32
Amount of time that the client will wait till it times out
OUTPUTS
System.Boolean
---------- EXAMPLE 1 ----------
$mycreds = New-Object System.Management.Automation.PSCredential ( "email address", (ConvertTo-SecureString "user
password" -AsPlainText -Force) )
$success = Register-TestSuite -ApiUrl "https://admin.services.crm.dynamics.com/" -ApiCredential $mycreds
-OrganizationId "org id" -OrganizationUniqueName "org unique name" -TestSuiteName "myTestName" -TestSuiteUrl
"https://url to an Internet accessible file (signate protection recommended)" -TestUserCredential $mycreds
RELATED LINKS
SYNOPSIS
Register a test suite.
SYNTAX
Register-TestSuite [-ApiUrl] <Uri> [-OrganizationId] <Guid> [[-ApiCredential] <PSCredential>]
-OrganizationUniqueName <string> -TestSuiteName <string> -TestSuiteUrl <string> -TestUserCredential <PSCredential>
[-CompletionCallbackUrl <string>] [-ConnectionTimeoutInMinutes <int>] [<CommonParameters>]
DESCRIPTION
Register a test suite on the specified organization
Returns True if successful
PARAMETERS
-TestSuiteName <string>
Test Suite Name
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Name <string>
Test Suite Name
This is an alias of the TestSuiteName parameter.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-OrganizationUniqueName <string>
Organization Unique Name
This value can be obtained from CRM -> Settings -> Customizations -> Developer Resources page
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-TestSuiteUrl <string>
The URL to the test suite ZIP file
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CompletionCallbackUrl <string>
The callback URL to be called at the completion of test suite runs
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TestUserCredential <PSCredential>
Credentials to be used by the test suite to call CRM endpoint
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ApiUrl <Uri>
URI for the Admin API server
Required? true
Position? 0
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ApiCredential <PSCredential>
Login credentials for the Admin API
Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-OrganizationId <Guid>
Organization Id against which the tests will need to run
This value can be obtained from CRM -> Settings -> Customizations -> Developer Resources page
Required? true
Position? 1
Default value 00000000-0000-0000-0000-000000000000
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ConnectionTimeoutInMinutes <int>
Amount of time that the client will wait till it times out
Required? false
Position? named
Default value 2
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Test Suite Name
System.String
Organization Unique Name
This value can be obtained from CRM -> Settings -> Customizations -> Developer Resources page
System.Management.Automation.PSCredential
Credentials to be used by the test suite to call CRM endpoint
System.Uri
URI for the Admin API server
System.Management.Automation.PSCredential
Login credentials for the Admin API
System.Guid
Organization Id against which the tests will need to run
This value can be obtained from CRM -> Settings -> Customizations -> Developer Resources page
System.Int32
Amount of time that the client will wait till it times out
OUTPUTS
System.Boolean
---------- EXAMPLE 1 ----------
$mycreds = New-Object System.Management.Automation.PSCredential ( "email address", (ConvertTo-SecureString "user
password" -AsPlainText -Force) )
$success = Register-TestSuite -ApiUrl "https://admin.services.crm.dynamics.com/" -ApiCredential $mycreds
-OrganizationId "org id" -OrganizationUniqueName "org unique name" -TestSuiteName "myTestName" -TestSuiteUrl
"https://url to an Internet accessible file (signate protection recommended)" -TestUserCredential $mycreds
RELATED LINKS