IFsrmReportJob Interface

 

Used to configure a report job.

Namespace:   Microsoft.Storage
Assembly:  srmlib (in srmlib.dll)

Syntax

[GuidAttribute("38E87280-715C-4C7D-A280-EA1651A19FEF")]
public interface IFsrmReportJob : IFsrmObject

[GuidAttribute("38E87280-715C-4C7D-A280-EA1651A19FEF")]
public interface class IFsrmReportJob : IFsrmObject

[<GuidAttribute("38E87280-715C-4C7D-A280-EA1651A19FEF")>]
type IFsrmReportJob = 
    interface
        interface IFsrmObject
    end

<GuidAttribute("38E87280-715C-4C7D-A280-EA1651A19FEF")>
Public Interface IFsrmReportJob
    Inherits IFsrmObject

Properties

	Name	Description
	Description	Retrieves or sets the description of the object.
	Formats	Retrieves or sets an array of formats that determine the content format of the reports.
	id	Retrieves the identifier of the object.
	LastError	Retrieves the error message from the last time the reports were run.
	LastGeneratedInDirectory	Retrieves the local directory path where the reports were stored the last time the reports were run.
	LastRun	Retrieves the time stamp for when the reports were last run.
	MailTo	Retrieves or sets the email addresses of those that will receive the reports via email.
	NamespaceRoots	Retrieves or sets an array of local directory paths that will be scanned when the report job is run.
	RunningStatus	Retrieves the running status of the report job.
	Task	Retrieves or sets the name of the report job.

Methods

	Name	Description
	Cancel()	Cancels the running reports for this report job.
	Commit()	Saves the report job object in the server's list of objects.
	CreateReport(_FsrmReportType)	Creates a new report object of the specified type.
	Delete()	Removes the report job object from the server's list of objects.
	EnumReports()	Enumerates all the reports configured for this report job.
	Run(_FsrmReportGenerationContext)	Runs all the reports in the job.
	WaitForCompletion(Int32)	Waits for the reports in the job to complete.

Remarks

The job specifies a set of directories that will be scanned to generate one or more different type of reports. The reports help the administrator analyze how the storage is used. The job may also be associated with a scheduled task that will trigger report generation.

To create this interface, call the CreateReportJob method.

The following methods return this interface:

1. EnumReportJobs

2. GetReportJob

To commit the job, you must specify at least one report type, at least one namespace root, and the task name.

To run the job, you must specify at least one report type and namespace root.

See Also

Microsoft.Storage Namespace

Return to top