Dependencies/Assemblies/Microsoft365DSC.Reporting.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft365DSC.Reporting</name> </assembly> <members> <member name="T:Microsoft365DSC.Reporting.Configuration.ConfigurationReader"> <summary> Reads a configuration file and prepares its content for the DSC parser. </summary> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.ConfigurationReader.ReadContent(System.String)"> <summary> Reads a configuration file and escapes the curly quotes it carries. </summary> <param name="path">The path of the configuration file.</param> <returns>The content of the file, ready to be parsed.</returns> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.ConfigurationReader.EscapeCurlyQuotes(System.String)"> <summary> Escapes every curly quote that is not escaped yet, which the parser would otherwise read as the end of a string. </summary> <param name="content">The configuration content.</param> <returns>The content with every curly quote escaped.</returns> </member> <member name="T:Microsoft365DSC.Reporting.Configuration.IMandatoryPropertySource"> <summary> Supplies the properties that identify a resource instance, used to recognize duplicates. </summary> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.IMandatoryPropertySource.GetMandatoryProperties(System.String)"> <summary> Returns the mandatory properties of a resource type. </summary> <param name="resourceType">The resource type name.</param> <returns>The property names, empty when the type has none.</returns> </member> <member name="T:Microsoft365DSC.Reporting.Configuration.DictionaryMandatoryPropertySource"> <summary> Supplies mandatory properties from a dictionary that maps a resource type to its property names. </summary> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.DictionaryMandatoryPropertySource.#ctor(System.Collections.IDictionary)"> <summary> Creates a source over a dictionary of resource type to property names. </summary> <param name="propertiesByResourceType">The property names, keyed by resource type.</param> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.DictionaryMandatoryPropertySource.GetMandatoryProperties(System.String)"> <inheritdoc /> </member> <member name="T:Microsoft365DSC.Reporting.Configuration.ModuleMetadataSource"> <summary> Reads resource metadata from the files a Microsoft365DSC module installation ships. Those files are SchemaDefinition.json, ResourcePermissions.json and the readme of a resource. </summary> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.ModuleMetadataSource.#ctor(System.String)"> <summary> Creates a metadata source over a module installation. </summary> <param name="moduleRoot">The folder that holds SchemaDefinition.json.</param> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.ModuleMetadataSource.GetClass(System.String)"> <inheritdoc /> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.ModuleMetadataSource.GetDocumentation(System.String)"> <inheritdoc /> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.ModuleMetadataSource.GetPermissions(System.String)"> <inheritdoc /> </member> <member name="T:Microsoft365DSC.Reporting.Configuration.ResourceParameter"> <summary>A property of a resource class or of one of its embedded classes.</summary> </member> <member name="P:Microsoft365DSC.Reporting.Configuration.ResourceParameter.Name"> <summary>The property name.</summary> </member> <member name="P:Microsoft365DSC.Reporting.Configuration.ResourceParameter.Option"> <summary>The DSC attribute of the property, such as Key, Required or Write.</summary> </member> <member name="P:Microsoft365DSC.Reporting.Configuration.ResourceParameter.CimType"> <summary>The CIM type of the property, such as String or MSFT_Example[].</summary> </member> <member name="P:Microsoft365DSC.Reporting.Configuration.ResourceParameter.Description"> <summary>The description of the property.</summary> </member> <member name="P:Microsoft365DSC.Reporting.Configuration.ResourceParameter.ValueMap"> <summary>The values the property accepts, when it is restricted to a set of them.</summary> </member> <member name="T:Microsoft365DSC.Reporting.Configuration.ResourceClass"> <summary>A resource class or one of the complex types it embeds.</summary> </member> <member name="P:Microsoft365DSC.Reporting.Configuration.ResourceClass.ClassName"> <summary>The class name, including the MSFT_ prefix.</summary> </member> <member name="P:Microsoft365DSC.Reporting.Configuration.ResourceClass.Parameters"> <summary>The properties of the class, in schema order.</summary> </member> <member name="T:Microsoft365DSC.Reporting.Configuration.IResourceMetadataSource"> <summary> Supplies the resource metadata a converter needs to describe properties beyond their value. </summary> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.IResourceMetadataSource.GetClass(System.String)"> <summary> Returns the class of the given name, or null when the schema does not define it. </summary> <param name="className">The class name, including the MSFT_ prefix.</param> <returns>The class, or null.</returns> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.IResourceMetadataSource.GetDocumentation(System.String)"> <summary> Returns the documentation of a resource type as Markdown, or null when there is none. </summary> <param name="resourceType">The resource type name, without the MSFT_ prefix.</param> <returns>The documentation, or null.</returns> </member> <member name="M:Microsoft365DSC.Reporting.Configuration.IResourceMetadataSource.GetPermissions(System.String)"> <summary> Returns the permissions of a resource type, keyed by API name, or null when the type carries no permission information. </summary> <param name="resourceType">The resource type name, without the MSFT_ prefix.</param> <returns>The permissions, or null.</returns> </member> <member name="T:Microsoft365DSC.Reporting.IReportConverter"> <summary> Converts parsed configuration resources into one report format. Implement this interface and register it with <see cref="T:Microsoft365DSC.Reporting.ReportConverterRegistry"/> to add a format. </summary> </member> <member name="P:Microsoft365DSC.Reporting.IReportConverter.Format"> <summary>The name of the format this converter produces, as used by the callers.</summary> </member> <member name="M:Microsoft365DSC.Reporting.IReportConverter.Convert(Microsoft365DSC.Reporting.ReportRequest)"> <summary> Converts the resources of the request and returns the paths of the files written. </summary> <param name="request">The resources to convert and the options to convert them with.</param> <returns>The paths of the files that were written.</returns> </member> <member name="T:Microsoft365DSC.Reporting.Markdown.MarkdownReportConverter"> <summary> Writes the resource instances of a configuration as Markdown, either as a single document or as one document per instance in a folder per workload. </summary> </member> <member name="F:Microsoft365DSC.Reporting.Markdown.MarkdownReportConverter.FormatName"> <summary>The name of the format this converter produces.</summary> </member> <member name="P:Microsoft365DSC.Reporting.Markdown.MarkdownReportConverter.Format"> <inheritdoc /> </member> <member name="M:Microsoft365DSC.Reporting.Markdown.MarkdownReportConverter.Convert(Microsoft365DSC.Reporting.ReportRequest)"> <inheritdoc /> </member> <member name="T:Microsoft365DSC.Reporting.ReportConverterRegistry"> <summary> Holds the available report converters, keyed by format name. The Markdown converter is registered by default. Further formats register themselves through <see cref="M:Microsoft365DSC.Reporting.ReportConverterRegistry.Register(Microsoft365DSC.Reporting.IReportConverter)"/>. </summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportConverterRegistry.Formats"> <summary>The names of the formats that can be converted.</summary> </member> <member name="M:Microsoft365DSC.Reporting.ReportConverterRegistry.Register(Microsoft365DSC.Reporting.IReportConverter)"> <summary> Registers a converter, replacing the one previously registered for its format. </summary> <param name="converter">The converter to register.</param> </member> <member name="M:Microsoft365DSC.Reporting.ReportConverterRegistry.Resolve(System.String)"> <summary> Returns the converter registered for a format. </summary> <param name="format">The format name, compared without case sensitivity.</param> <returns>The converter for the format.</returns> </member> <member name="M:Microsoft365DSC.Reporting.ReportConverterRegistry.Convert(System.String,Microsoft365DSC.Reporting.ReportRequest)"> <summary> Converts a request with the converter registered for a format. </summary> <param name="format">The format name, compared without case sensitivity.</param> <param name="request">The resources to convert and the options to convert them with.</param> <returns>The paths of the files that were written.</returns> </member> <member name="T:Microsoft365DSC.Reporting.ReportRequest"> <summary> Describes a single report conversion. It names what to convert, where to write it and how much detail the output carries. </summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportRequest.Resources"> <summary>The parsed configuration resources, one dictionary per resource instance.</summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportRequest.OutputPath"> <summary>The folder the converter writes its output to.</summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportRequest.ModuleRoot"> <summary> The root of the Microsoft365DSC module, used to resolve the resource metadata a converter needs. Ignored when <see cref="P:Microsoft365DSC.Reporting.ReportRequest.Metadata"/> is supplied. </summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportRequest.Metadata"> <summary>The resource metadata source. Built from <see cref="P:Microsoft365DSC.Reporting.ReportRequest.ModuleRoot"/> when not set.</summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportRequest.OrganizationName"> <summary>The tenant domain name that is replaced by a portable token in every value.</summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportRequest.TenantGuid"> <summary>The tenant identifier that is replaced by a portable token in every value.</summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportRequest.IncludeAllInformation"> <summary> When false, the report carries the name, data type and value of every property the configuration sets. When true, it carries every property the resource supports, set or not, with its attribute, allowed values and description, and the resource permissions. </summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportRequest.SplitByResource"> <summary> When false, every resource instance lands in a single document. When true, each instance becomes its own document in a folder per workload. </summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportRequest.SuppressDuplicates"> <summary>Whether resource instances that repeat their mandatory properties are skipped.</summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportRequest.MandatoryProperties"> <summary>The mandatory properties per resource type, required for duplicate suppression.</summary> </member> <member name="P:Microsoft365DSC.Reporting.ReportRequest.Warn"> <summary>Receives the warnings raised while converting.</summary> </member> </members> </doc> |