TestConnection Method
Tests connectivity of the IIS Transform Manager service to the Scheduler object.
Namespace: Microsoft.Web.Media.TransformManager
Assembly: Microsoft.Web.Media.TransformManager.ServiceLibrary (in Microsoft.Web.Media.TransformManager.ServiceLibrary.dll)
Syntax
'Declaration
<PrincipalPermissionAttribute(SecurityAction.Demand, Role := "Administrators")> _
Public Function TestConnection ( _
scheduler As JobScheduler, _
credential As Credential _
) As Boolean
'Usage
Dim instance As TransformManagerService
Dim scheduler As JobScheduler
Dim credential As Credential
Dim returnValue As Boolean
returnValue = instance.TestConnection(scheduler, _
credential)
[PrincipalPermissionAttribute(SecurityAction.Demand, Role = "Administrators")]
public bool TestConnection(
JobScheduler scheduler,
Credential credential
)
[PrincipalPermissionAttribute(SecurityAction::Demand, Role = L"Administrators")]
public:
virtual bool TestConnection(
JobScheduler^ scheduler,
Credential^ credential
) sealed
[<PrincipalPermissionAttribute(SecurityAction.Demand, Role = "Administrators")>]
abstract TestConnection :
scheduler:JobScheduler *
credential:Credential -> bool
[<PrincipalPermissionAttribute(SecurityAction.Demand, Role = "Administrators")>]
override TestConnection :
scheduler:JobScheduler *
credential:Credential -> bool
public final function TestConnection(
scheduler : JobScheduler,
credential : Credential
) : boolean
Parameters
- scheduler
Type: Microsoft.Web.Media.TransformManager. . :: . .JobScheduler
The Scheduler object to test.
- credential
Type: Microsoft.Web.Media.TransformManager. . :: . .Credential
The Credential object that is required in order to run jobs and access resources.
Return Value
Type: System. . :: . .Boolean
true if the IIS Transform Manager service can connect to the Scheduler object; otherwise, false.
Implements
IManagementService. . :: . .TestConnection(JobScheduler, Credential)
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | The test connection is not valid for the local scheduler. |
| FileNotFoundException | The HPC client utilities are not installed. |
| InvalidDataException | The scheduler is not responding. |
Remarks
By default, IIS Transform Manager uses the task scheduler on the local server, but it also supports using HPC. A credential is required in order to run jobs and access resources on the HPC cluster. That credential can be different from the credential that the IIS Transform Manager service is running under on the local server.