Microsoft.PSRule.Types.xml
|
<?xml version="1.0"?> <doc> <assembly> <name>Microsoft.PSRule.Types</name> </assembly> <members> <member name="M:PSRule.Converters.TypeConverter.TryInt(System.Object,System.Boolean,System.Int32@)"> <summary> Try to get an int from the existing object. </summary> </member> <member name="T:PSRule.Converters.Yaml.StringArrayConverter"> <summary> A YAML converter for deserializing a string array. </summary> </member> <member name="M:PSRule.Converters.Yaml.StringArrayConverter.YamlDotNet#Serialization#IYamlTypeConverter#Accepts(System.Type)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringArrayConverter.YamlDotNet#Serialization#IYamlTypeConverter#ReadYaml(YamlDotNet.Core.IParser,System.Type)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringArrayConverter.YamlDotNet#Serialization#IYamlTypeConverter#WriteYaml(YamlDotNet.Core.IEmitter,System.Object,System.Type)"> <inheritdoc/> </member> <member name="T:PSRule.Converters.Yaml.StringArrayMapConverter"> <summary> A YAML converter for de/serializing <see cref="T:PSRule.Data.StringArrayMap"/>. </summary> </member> <member name="M:PSRule.Converters.Yaml.StringArrayMapConverter.YamlDotNet#Serialization#IYamlTypeConverter#Accepts(System.Type)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringArrayMapConverter.YamlDotNet#Serialization#IYamlTypeConverter#ReadYaml(YamlDotNet.Core.IParser,System.Type)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringArrayMapConverter.YamlDotNet#Serialization#IYamlTypeConverter#WriteYaml(YamlDotNet.Core.IEmitter,System.Object,System.Type)"> <inheritdoc/> </member> <member name="T:PSRule.Data.IDateVersionConstraint"> <summary> An date version constraint. </summary> </member> <member name="M:PSRule.Data.IDateVersionConstraint.Equals(PSRule.Data.DateVersion.Version)"> <summary> Determines if the date version meets the requirments of the constraint. </summary> </member> <member name="T:PSRule.Data.DateVersion"> <summary> A helper for comparing date version strings. An date version is represented as YYYY-MM-DD-prerelease. </summary> </member> <member name="T:PSRule.Data.DateVersion.ComparisonOperator"> <summary> A comparison operation for a version constraint. </summary> </member> <member name="F:PSRule.Data.DateVersion.ComparisonOperator.Equals"> <summary> YYYY-MM-DD bits must match. </summary> </member> <member name="T:PSRule.Data.DateVersion.VersionConstraint"> <summary> An date version constraint. </summary> </member> <member name="M:PSRule.Data.DateVersion.VersionConstraint.Equals(PSRule.Data.DateVersion.Version)"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.ConstraintExpression.GT(System.Int32,System.Int32,System.Int32,PSRule.Data.DateVersion.PR)"> <summary> Greater Than. </summary> </member> <member name="M:PSRule.Data.DateVersion.ConstraintExpression.LT(System.Int32,System.Int32,System.Int32,PSRule.Data.DateVersion.PR)"> <summary> Less Than. </summary> </member> <member name="M:PSRule.Data.DateVersion.ConstraintExpression.PR(PSRule.Data.DateVersion.PR)"> <summary> Compare pre-release. </summary> </member> <member name="T:PSRule.Data.DateVersion.Version"> <summary> An date version. </summary> </member> <member name="F:PSRule.Data.DateVersion.Version.Year"> <summary> The year part of the version. </summary> </member> <member name="F:PSRule.Data.DateVersion.Version.Month"> <summary> The month part of the version. </summary> </member> <member name="F:PSRule.Data.DateVersion.Version.Day"> <summary> The day part of the version. </summary> </member> <member name="F:PSRule.Data.DateVersion.Version.Prerelease"> <summary> The pre-release part of the version. </summary> </member> <member name="M:PSRule.Data.DateVersion.Version.ToString"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.Version.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.Version.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.Version.Equals(PSRule.Data.DateVersion.Version)"> <summary> Compare the version against another version. </summary> </member> <member name="M:PSRule.Data.DateVersion.Version.Equals(System.Int32,System.Int32,System.Int32)"> <summary> Compare the version against another version based on YYYY-MM-DD. </summary> </member> <member name="M:PSRule.Data.DateVersion.Version.CompareTo(PSRule.Data.DateVersion.Version)"> <summary> Compare the version against another version. </summary> </member> <member name="T:PSRule.Data.DateVersion.PR"> <summary> An date version pre-release identifier. </summary> </member> <member name="P:PSRule.Data.DateVersion.PR.Value"> <summary> The string value of a pre-release identifier. </summary> </member> <member name="P:PSRule.Data.DateVersion.PR.Stable"> <summary> Is the pre-release identifier empty, indicating a stable release. </summary> </member> <member name="M:PSRule.Data.DateVersion.PR.CompareTo(PSRule.Data.DateVersion.PR)"> <summary> Compare the pre-release identifer to another pre-release identifier. </summary> </member> <member name="M:PSRule.Data.DateVersion.PR.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.PR.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.PR.ToString"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.VersionStream.GetJoin"> <summary> 1.2.3 || 3.4.5 >=1.2.3 <3.4.5 </summary> </member> <member name="M:PSRule.Data.DateVersion.VersionStream.IsLetter(System.Char)"> <summary> Is the character within the reduced set of allowed characters. a-z or A-Z. </summary> </member> <member name="M:PSRule.Data.DateVersion.TryParseConstraint(System.String,PSRule.Data.IDateVersionConstraint@,System.Boolean)"> <summary> Try to parse a version constraint from the provided string. </summary> </member> <member name="M:PSRule.Data.DateVersion.TryParseVersion(System.String,PSRule.Data.DateVersion.Version@)"> <summary> Try to parse a version from the provided string. </summary> </member> <member name="T:PSRule.Data.IFileInfo"> <summary> An object with information about an input file. </summary> </member> <member name="P:PSRule.Data.IFileInfo.Path"> <summary> The full path to the file. </summary> </member> <member name="P:PSRule.Data.IFileInfo.Extension"> <summary> The extension for the file. </summary> </member> <member name="M:PSRule.Data.IFileInfo.GetFileStream"> <summary> Get a stream for the file. </summary> </member> <member name="T:PSRule.Data.IFileStream"> <summary> A stream associated with a file on disk. </summary> </member> <member name="M:PSRule.Data.IFileStream.AsTextReader"> <summary> Get the file stream as a text reader. </summary> <returns></returns> </member> <member name="P:PSRule.Data.IFileStream.Info"> <summary> Information about the file. </summary> </member> <member name="T:PSRule.Data.InputFileInfo"> <summary> An input file information structure. </summary> </member> <member name="P:PSRule.Data.InputFileInfo.FullName"> <summary> The fully qualified path to the file. </summary> </member> <member name="P:PSRule.Data.InputFileInfo.BasePath"> <summary> The path to the parent directory containing the file. </summary> </member> <member name="P:PSRule.Data.InputFileInfo.Name"> <summary> The file name. </summary> </member> <member name="P:PSRule.Data.InputFileInfo.Extension"> <summary> The file extension. </summary> </member> <member name="P:PSRule.Data.InputFileInfo.DirectoryName"> <summary> The name of the directory containing the file. </summary> </member> <member name="P:PSRule.Data.InputFileInfo.Path"> <summary> The normalized path to the file. </summary> </member> <member name="P:PSRule.Data.InputFileInfo.DisplayName"> <summary> The friendly display name for the file. </summary> </member> <member name="M:PSRule.Data.InputFileInfo.ToString"> <summary> Convert to string. </summary> </member> <member name="M:PSRule.Data.InputFileInfo.AsFileInfo"> <summary> Convert to FileInfo. </summary> </member> <member name="T:PSRule.Data.ISourceInfo"> <summary> Information about the source of an object. </summary> </member> <member name="T:PSRule.Data.ITargetInfo"> <summary> An interface implemented by objects that automatically provide binding and source information. </summary> </member> <member name="P:PSRule.Data.ITargetInfo.TargetName"> <summary> The target name provided by the object. </summary> </member> <member name="P:PSRule.Data.ITargetInfo.TargetType"> <summary> The target type provided by the object. </summary> </member> <member name="P:PSRule.Data.ITargetInfo.Source"> <summary> The source information provided by the object. </summary> </member> <member name="T:PSRule.Data.ITargetObject"> <summary> An instance of a target object. </summary> </member> <member name="P:PSRule.Data.ITargetObject.Source"> <summary> Sources for the target object. </summary> </member> <member name="P:PSRule.Data.ITargetObject.Name"> <summary> The target name of the object. </summary> </member> <member name="P:PSRule.Data.ITargetObject.Type"> <summary> The target type of the object. </summary> </member> <member name="P:PSRule.Data.ITargetObject.Path"> <summary> The path of the object. </summary> </member> <member name="T:PSRule.Data.ModuleConstraint"> <summary> A version constraint for a PSRule module. </summary> </member> <member name="M:PSRule.Data.ModuleConstraint.#ctor(System.String,PSRule.Data.ISemanticVersionConstraint)"> <summary> Create a version constraint for a PSRule module. </summary> <param name="module">The name of the module.</param> <param name="constraint">The version constraint of the module.</param> </member> <member name="P:PSRule.Data.ModuleConstraint.Module"> <summary> The name of the module. </summary> </member> <member name="P:PSRule.Data.ModuleConstraint.Constraint"> <summary> The version constraint of the module. </summary> </member> <member name="T:PSRule.Data.ISemanticVersionConstraint"> <summary> A semantic version constraint. </summary> </member> <member name="M:PSRule.Data.ISemanticVersionConstraint.Equals(PSRule.Data.SemanticVersion.Version)"> <summary> Determines if the semantic version meets the requirments of the constraint. </summary> </member> <member name="T:PSRule.Data.SemanticVersion"> <summary> A helper for comparing semantic version strings. </summary> </member> <member name="T:PSRule.Data.SemanticVersion.ComparisonOperator"> <summary> A comparison operation for a version constraint. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.ComparisonOperator.Equals"> <summary> Major.Minor.Patch bits must match. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.ComparisonOperator.PatchUplift"> <summary> Major.Minor bits must match, Patch can equal to or greater. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.ComparisonOperator.MinorUplift"> <summary> Major bit must match, Minor.Patch can be equal to or greater. </summary> </member> <member name="T:PSRule.Data.SemanticVersion.VersionConstraint"> <summary> A semantic version constraint. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.VersionConstraint.Equals(PSRule.Data.SemanticVersion.Version)"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.VersionConstraint.ToString"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.VersionConstraint.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.ConstraintExpression.GT(System.Int32,System.Int32,System.Int32,PSRule.Data.SemanticVersion.PR)"> <summary> Greater Than. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.ConstraintExpression.LT(System.Int32,System.Int32,System.Int32,PSRule.Data.SemanticVersion.PR)"> <summary> Less Than. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.ConstraintExpression.PR(PSRule.Data.SemanticVersion.PR)"> <summary> Compare pre-release. </summary> </member> <member name="T:PSRule.Data.SemanticVersion.Version"> <summary> A semantic version. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.Version.Major"> <summary> The major part of the version. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.Version.Minor"> <summary> The minor part of the version. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.Version.Patch"> <summary> The patch part of the version. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.Version.Prerelease"> <summary> The pre-release part of the version. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.Version.Build"> <summary> The build part of the version. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.Version.TryParse(System.String,PSRule.Data.SemanticVersion.Version@)"> <summary> Try to parse a semantic version from a string. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.Version.ToString"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.Version.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.Version.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.Version.op_Equality(PSRule.Data.SemanticVersion.Version,PSRule.Data.SemanticVersion.Version)"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.Version.op_Inequality(PSRule.Data.SemanticVersion.Version,PSRule.Data.SemanticVersion.Version)"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.Version.Equals(PSRule.Data.SemanticVersion.Version)"> <summary> Compare the version against another version. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.Version.Equals(System.Int32,System.Int32,System.Int32,System.String)"> <summary> Compare the version against another version based on major.minor.patch. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.Version.CompareTo(PSRule.Data.SemanticVersion.Version)"> <summary> Compare the version against another version. </summary> </member> <member name="T:PSRule.Data.SemanticVersion.PR"> <summary> A semantic version pre-release identifier. </summary> </member> <member name="P:PSRule.Data.SemanticVersion.PR.Value"> <summary> The string value of a pre-release identifier. </summary> </member> <member name="P:PSRule.Data.SemanticVersion.PR.Stable"> <summary> Is the pre-release identifier empty, indicating a stable release. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.PR.CompareTo(PSRule.Data.SemanticVersion.PR)"> <summary> Compare the pre-release identifer to another pre-release identifier. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.PR.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.PR.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.PR.ToString"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.VersionStream.GetJoin"> <summary> 1.2.3 || 3.4.5 >=1.2.3 <3.4.5 </summary> </member> <member name="M:PSRule.Data.SemanticVersion.VersionStream.IsLetter(System.Char)"> <summary> Is the character within the reduced set of allowed characters. a-z or A-Z. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.TryParseConstraint(System.String,PSRule.Data.ISemanticVersionConstraint@,System.Boolean)"> <summary> Try to parse a version constraint from the provided string. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.TryParseVersion(System.String,PSRule.Data.SemanticVersion.Version@)"> <summary> Try to parse a version from the provided string. </summary> </member> <member name="T:PSRule.Data.StringArrayMap"> <summary> A mapping of string to string arrays. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.#ctor"> <summary> Create an empty <see cref="T:PSRule.Data.StringArrayMap"/> instance. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.#ctor(PSRule.Data.StringArrayMap)"> <summary> Create an instance by copying an existing <see cref="T:PSRule.Data.StringArrayMap"/>. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.#ctor(System.Collections.Generic.Dictionary{System.String,System.String[]})"> <summary> Create an instance by copying mapped keys from a string dictionary. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.#ctor(System.Collections.Hashtable)"> <summary> Create an instance by copying mapped keys from a <seealso cref="T:System.Collections.Hashtable"/>. </summary> <param name="map"></param> </member> <member name="P:PSRule.Data.StringArrayMap.Count"> <summary> The number of mapped keys. </summary> </member> <member name="P:PSRule.Data.StringArrayMap.Item(System.String)"> <summary> Get or set mapping for a specified key. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.op_Implicit(System.Collections.Hashtable)~PSRule.Data.StringArrayMap"> <summary> </summary> <param name="hashtable"></param> </member> <member name="M:PSRule.Data.StringArrayMap.TryGetValue(System.String,System.String[]@)"> <summary> Try to get a mapping by key. </summary> <param name="key">The key.</param> <param name="value">Returns an array of mapped keys.</param> <returns>Returns <c>true</c> if the key was found. Otherwise <c>false</c> is returned.</returns> </member> <member name="M:PSRule.Data.StringArrayMap.Load(PSRule.Data.StringArrayMap,System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Load a key map from an existing dictionary. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.Data.StringArrayMap.System#Collections#IEnumerable#GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.Data.StringArrayMap.ToDictionary"> <summary> Convert the instance into a dictionary. </summary> <returns></returns> </member> <member name="M:PSRule.Data.StringArrayMap.FromHashtable(System.Collections.Hashtable)"> <summary> Convert a hashtable into a <see cref="T:PSRule.Data.StringArrayMap"/> instance. </summary> </member> <member name="T:PSRule.Data.TargetIssueInfo"> <summary> An issue reported by a downstream tool. </summary> </member> <member name="M:PSRule.Data.TargetIssueInfo.#ctor"> <summary> Create an empty issue. </summary> </member> <member name="P:PSRule.Data.TargetIssueInfo.Type"> <summary> The type of issue. </summary> </member> <member name="P:PSRule.Data.TargetIssueInfo.Name"> <summary> The name of the issue. </summary> </member> <member name="P:PSRule.Data.TargetIssueInfo.Path"> <summary> The object path reported by the issue. </summary> </member> <member name="P:PSRule.Data.TargetIssueInfo.Message"> <summary> A localized message describing the issue. </summary> </member> <member name="M:PSRule.Data.TargetIssueInfo.Equals(PSRule.Data.TargetIssueInfo)"> <inheritdoc/> </member> <member name="M:PSRule.Data.TargetIssueInfo.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Data.TargetIssueInfo.GetHashCode"> <inheritdoc/> </member> <member name="T:PSRule.Data.TargetSourceInfo"> <summary> An object source location reported by a downstream tool. </summary> </member> <member name="M:PSRule.Data.TargetSourceInfo.#ctor"> <summary> Creates an empty source information structure. </summary> </member> <member name="P:PSRule.Data.TargetSourceInfo.File"> <summary> The file path of the source file. </summary> </member> <member name="P:PSRule.Data.TargetSourceInfo.Line"> <summary> The first line of the object. </summary> </member> <member name="P:PSRule.Data.TargetSourceInfo.Position"> <summary> The first position of the object. </summary> </member> <member name="P:PSRule.Data.TargetSourceInfo.Type"> <summary> The type of source. </summary> </member> <member name="M:PSRule.Data.TargetSourceInfo.PSRule#Data#IFileInfo#GetFileStream"> <inheritdoc/> </member> <member name="M:PSRule.Data.TargetSourceInfo.Equals(PSRule.Data.TargetSourceInfo)"> <inheritdoc/> </member> <member name="M:PSRule.Data.TargetSourceInfo.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Data.TargetSourceInfo.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Data.TargetSourceInfo.ToString"> <inheritdoc/> </member> <member name="M:PSRule.Data.TargetSourceInfo.ToString(System.String,System.Boolean)"> <summary> Converts the souce information into a formatted string for display. </summary> <param name="defaultType">The default type to use if the type was not specified.</param> <param name="useRelativePath">Determine if a relative path is returned.</param> <returns>A formatted source string.</returns> </member> <member name="T:PSRule.DictionaryExtensions"> <summary> Extension methods for <see cref="T:System.Collections.Generic.IDictionary`2"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopValue(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Object@)"> <summary> Try to get a value and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopValue``1(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,``0@)"> <summary> Try to get a value and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopBool(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Boolean@)"> <summary> Try to get a <see cref="T:System.Boolean"/> and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopEnum``1(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,``0@)"> <summary> Try to get a <typeparamref name="TEnum"/> and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopString(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.String@)"> <summary> Try to get a <see cref="T:System.String"/> and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopStringArray(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.String[]@)"> <summary> Try to get an array of strings and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopStringArrayMap(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,PSRule.Data.StringArrayMap@)"> <summary> Try to get a <see cref="T:PSRule.Data.StringArrayMap"/> and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetBool(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Nullable{System.Boolean}@)"> <summary> Try to get the value as a <see cref="T:System.Boolean"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetLong(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Nullable{System.Int64}@)"> <summary> Try to get the value as a <see cref="T:System.Int64"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetInt(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Nullable{System.Int32}@)"> <summary> Try to get the value as a <see cref="T:System.Int32"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetChar(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Nullable{System.Char}@)"> <summary> Try to get the value as a <see cref="T:System.Char"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetString(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.String@)"> <summary> Try to get the value as a <see cref="T:System.String"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetEnumerable(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Collections.IEnumerable@)"> <summary> Try to get the value as an <see cref="T:System.Collections.IEnumerable"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetStringArray(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.String[]@)"> <summary> Try to get the value as an array of strings. </summary> </member> <member name="M:PSRule.DictionaryExtensions.AddUnique``1(System.Collections.Generic.IDictionary{System.String,``0},System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,``0}})"> <summary> Add unique keys to the dictionary. Duplicate keys are ignored. </summary> </member> <member name="M:PSRule.DictionaryExtensions.AddUnique(System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})"> <summary> Add unique keys to the dictionary. Duplicate keys are ignored. </summary> </member> <member name="T:PSRule.Environment"> <summary> A helper for accessing environment and runtime variables. </summary> </member> <member name="F:PSRule.Environment._GetWorkingPath"> <summary> A callback that is overridden by PowerShell so that the current working path can be retrieved. </summary> </member> <member name="F:PSRule.Environment._CurrentCulture"> <summary> Sets the current culture to use when processing rules unless otherwise specified. </summary> </member> <member name="T:PSRule.Environment.WorkingPathResolver"> <summary> A delegate to allow callback get current working path. </summary> </member> <member name="M:PSRule.Environment.UseCurrentCulture"> <summary> Configures PSRule to use the culture of the current thread at runtime. </summary> </member> <member name="M:PSRule.Environment.UseCurrentCulture(System.String)"> <summary> Configures PSRule to use the specified culture at runtime. </summary> <param name="culture">A valid culture.</param> </member> <member name="M:PSRule.Environment.UseCurrentCulture(System.Globalization.CultureInfo)"> <summary> Configures PSRule to use the specified culture at runtime. </summary> <param name="culture">A valid culture.</param> </member> <member name="M:PSRule.Environment.UseWorkingPathResolver(PSRule.Environment.WorkingPathResolver)"> <summary> Configures PSRule to use the specified resolver to determine the current working path. </summary> <param name="resolver">A method that can be used to resolve the current working path.</param> </member> <member name="M:PSRule.Environment.GetWorkingPath"> <summary> Gets the current working path being used by PSRule. </summary> <returns>The current working path.</returns> </member> <member name="M:PSRule.Environment.GetCurrentCulture"> <summary> Get the current culture being used by PSRule. </summary> <returns>The current culture.</returns> </member> <member name="M:PSRule.Environment.GetRootedPath(System.String,System.Boolean,System.String)"> <summary> Get a full path instead of a relative path that may be passed from PowerShell. </summary> <param name="path">A full or relative path.</param> <param name="normalize">When set to <c>true</c> the returned path uses forward slashes instead of backslashes.</param> <param name="basePath">The base path to use. When <c>null</c> of unspecified, the current working path will be used.</param> <returns>A absolute path.</returns> </member> <member name="M:PSRule.Environment.GetRootedBasePath(System.String,System.Boolean,System.String)"> <summary> Get a full base path instead of a relative path that may be passed from PowerShell. </summary> <param name="path">A full or relative path.</param> <param name="normalize">When set to <c>true</c> the returned path uses forward slashes instead of backslashes.</param> <param name="basePath">A base path to use if the <c>path</c> is relative.</param> <returns>A absolute base path.</returns> <remarks> A base path always includes a trailing <c>/</c>. </remarks> </member> <member name="M:PSRule.Environment.IsAzurePipelines"> <summary> Determine if the environment is running within Azure Pipelines. </summary> </member> <member name="M:PSRule.Environment.IsGitHubActions"> <summary> Determines if the environment is running within GitHub Actions. </summary> </member> <member name="M:PSRule.Environment.IsVisualStudioCode"> <summary> Determine if the environment is running within Visual Studio Code. </summary> </member> <member name="M:PSRule.Environment.GetRunId"> <summary> Get the run identifier for the current environment. </summary> </member> <member name="M:PSRule.Environment.TryString(System.String,System.String@)"> <summary> Try to get the environment variable as a <see cref="T:System.String"/>. </summary> </member> <member name="M:PSRule.Environment.TrySecureString(System.String,System.Security.SecureString@)"> <summary> Try to get the environment variable as a <see cref="T:System.Security.SecureString"/>. </summary> </member> <member name="M:PSRule.Environment.TryInt(System.String,System.Int32@)"> <summary> Try to get the environment variable as an <see cref="T:System.Int32"/>. </summary> </member> <member name="M:PSRule.Environment.TryBool(System.String,System.Nullable{System.Boolean}@)"> <summary> Try to get the environment variable as a <see cref="T:System.Boolean"/>. </summary> </member> <member name="M:PSRule.Environment.TryEnum``1(System.String,``0@)"> <summary> Try to get the environment variable as a enum of type <typeparamref name="TEnum"/>. </summary> </member> <member name="M:PSRule.Environment.TryStringArray(System.String,System.String[]@)"> <summary> Try to get the environment variable as an array of strings. </summary> </member> <member name="M:PSRule.Environment.TryStringArrayMap(System.String,PSRule.Data.StringArrayMap@)"> <summary> Try to get the environment variable as a <see cref="T:PSRule.Data.StringArrayMap"/>. </summary> </member> <member name="M:PSRule.Environment.TryPathEnvironmentVariable(System.String[]@)"> <summary> Try to get the PATH environment variable. </summary> </member> <member name="M:PSRule.Environment.TryPathEnvironmentVariable(System.String,System.String[]@)"> <summary> Try to get a PATH environment variable with a specific name. </summary> </member> <member name="M:PSRule.Environment.GetByPrefix(System.String)"> <summary> Try to get any environment variable with a specific prefix. </summary> </member> <member name="M:PSRule.Environment.IsPathSeparator(System.Char)"> <summary> Determine if the <seealso cref="T:System.Char"/> is a path separator character. </summary> <param name="c">The character to check.</param> <returns>Returns <c>true</c> if the character is a path separator. Otherwise <c>false</c> is returned.</returns> </member> <member name="T:PSRule.HashtableExtensions"> <summary> Extension methods for <see cref="T:System.Collections.Hashtable"/>. </summary> </member> <member name="M:PSRule.HashtableExtensions.IndexByString(System.Collections.Hashtable,System.Boolean)"> <summary> Map the hashtable into a dictionary string a string key. </summary> </member> <member name="T:PSRule.Options.IBaselineOption"> <summary> Options that configure baselines. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </member> <member name="P:PSRule.Options.IBaselineOption.Group"> <summary> A mapping of baseline group names to baselines. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options#baselinegroup"/>. </remarks> </member> <member name="T:PSRule.Options.BaselineOption"> <summary> Options that configure baselines. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </member> <member name="M:PSRule.Options.BaselineOption.#ctor"> <summary> Create an option instance. </summary> </member> <member name="M:PSRule.Options.BaselineOption.#ctor(PSRule.Options.BaselineOption)"> <summary> Create an option instance based on an existing object. </summary> <param name="option">The existing object to copy.</param> </member> <member name="M:PSRule.Options.BaselineOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Options.BaselineOption.Equals(PSRule.Options.BaselineOption)"> <inheritdoc/> </member> <member name="M:PSRule.Options.BaselineOption.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Options.BaselineOption.Combine(PSRule.Options.BaselineOption,PSRule.Options.BaselineOption)"> <summary> Combines two option instances into a new merged instance. The new instance uses any non-null values from <paramref name="o1"/>. Any null values from <paramref name="o1"/> are replaced with <paramref name="o2"/>. </summary> </member> <member name="P:PSRule.Options.BaselineOption.Group"> <inheritdoc/> </member> <member name="M:PSRule.Options.BaselineOption.Load"> <summary> Load from environment variables. </summary> </member> <member name="M:PSRule.Options.BaselineOption.Load(System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Load from a dictionary. </summary> </member> <member name="T:PSRule.Options.ExecutionActionPreference"> <summary> Determines the action to take for execution behaviors. See <see cref="T:PSRule.Options.ExecutionOption"/> for the specific behaviors that are configurable. </summary> </member> <member name="F:PSRule.Options.ExecutionActionPreference.None"> <summary> No preference. This will inherit from the default. </summary> </member> <member name="F:PSRule.Options.ExecutionActionPreference.Ignore"> <summary> Continue to execute silently. </summary> </member> <member name="F:PSRule.Options.ExecutionActionPreference.Warn"> <summary> Continue to execute but log a warning. </summary> </member> <member name="F:PSRule.Options.ExecutionActionPreference.Error"> <summary> Generate an error. </summary> </member> <member name="F:PSRule.Options.ExecutionActionPreference.Debug"> <summary> Continue to execute but write a debug log. </summary> </member> <member name="T:PSRule.Options.IExecutionOption"> <summary> Options that configure the execution sandbox. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </member> <member name="P:PSRule.Options.IExecutionOption.DuplicateResourceId"> <summary> Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.IExecutionOption.HashAlgorithm"> <summary> Configures the hashing algorithm used by the PSRule runtime. The default is <see cref="F:PSRule.Options.HashAlgorithm.SHA512"/>. </summary> </member> <member name="P:PSRule.Options.IExecutionOption.LanguageMode"> <summary> The language mode to execute PowerShell code with. The default is <see cref="F:PSRule.Options.LanguageMode.FullLanguage"/>. </summary> </member> <member name="P:PSRule.Options.IExecutionOption.InitialSessionState"> <summary> Determines how the initial session state for executing PowerShell code is created. The default is <see cref="F:PSRule.Options.SessionState.BuiltIn"/>. </summary> </member> <member name="P:PSRule.Options.IExecutionOption.RestrictScriptSource"> <summary> Configures where to allow PowerShell language features (such as rules and conventions) to run from. The default is <see cref="F:PSRule.Options.RestrictScriptSource.Unrestricted"/>. </summary> </member> <member name="P:PSRule.Options.IExecutionOption.SuppressionGroupExpired"> <summary> Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.IExecutionOption.RuleExcluded"> <summary> Determines how to handle rules that are excluded. By default, excluded rules do not generated any output. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log. </summary> </member> <member name="P:PSRule.Options.IExecutionOption.RuleSuppressed"> <summary> Determines how to handle rules that are suppressed. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.IExecutionOption.AliasReference"> <summary> Determines how to handle when an alias to a resource is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.IExecutionOption.RuleInconclusive"> <summary> Determines how to handle rules that generate inconclusive results. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.IExecutionOption.InvariantCulture"> <summary> Determines how to report when an invariant culture is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.IExecutionOption.UnprocessedObject"> <summary> Determines how to report objects that are not processed by any rule. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="T:PSRule.Options.ExecutionOption"> <summary> Options that configure the execution sandbox. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </member> <member name="M:PSRule.Options.ExecutionOption.#ctor"> <summary> Creates an empty execution option. </summary> </member> <member name="M:PSRule.Options.ExecutionOption.#ctor(PSRule.Options.ExecutionOption)"> <summary> Creates a execution option by copying an existing instance. </summary> <param name="option">The option instance to copy.</param> </member> <member name="M:PSRule.Options.ExecutionOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Options.ExecutionOption.Equals(PSRule.Options.ExecutionOption)"> <inheritdoc/> </member> <member name="M:PSRule.Options.ExecutionOption.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Options.ExecutionOption.Combine(PSRule.Options.ExecutionOption,PSRule.Options.ExecutionOption)"> <summary> Merge two option instances by replacing any unset properties from <paramref name="o1"/> with <paramref name="o2"/> values. Values from <paramref name="o1"/> that are set are not overridden. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.DuplicateResourceId"> <summary> Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By default, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.HashAlgorithm"> <summary> Configures the hashing algorithm used by the PSRule runtime. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.LanguageMode"> <summary> The language mode to execute PowerShell code with. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.InitialSessionState"> <summary> Determines how the initial session state for executing PowerShell code is created. The default is <see cref="F:PSRule.Options.SessionState.BuiltIn"/>. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.RestrictScriptSource"> <summary> Configures where to allow PowerShell language features (such as rules and conventions) to run from. The default is <see cref="F:PSRule.Options.RestrictScriptSource.Unrestricted"/>. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.SuppressionGroupExpired"> <summary> Determines how to handle expired suppression groups. Regardless of the value, an expired suppression group will be ignored. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.RuleExcluded"> <summary> Determines how to handle rules that are excluded. By default, excluded rules do not generated any output. When set to Error, an error is thrown. When set to Warn, a warning is generated. When set to Debug, a message is written to the debug log. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.RuleSuppressed"> <summary> Determines how to handle rules that are suppressed. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.AliasReference"> <summary> Determines how to handle when an alias to a resource is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.RuleInconclusive"> <summary> Determines how to handle rules that generate inconclusive results. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.InvariantCulture"> <summary> Determines how to report when an invariant culture is used. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Options.ExecutionOption.UnprocessedObject"> <summary> Determines how to report objects that are not processed by any rule. By default, a warning is generated. When set to Error, an error is thrown. When set to Debug, a message is written to the debug log. When set to Ignore, no output will be displayed. </summary> </member> <member name="M:PSRule.Options.ExecutionOption.Load"> <summary> Load from environment variables. </summary> </member> <member name="M:PSRule.Options.ExecutionOption.Load(System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Load from dictionary. </summary> </member> <member name="T:PSRule.Options.HashAlgorithm"> <summary> Configures the hashing algorithm used by the PSRule runtime. </summary> </member> <member name="F:PSRule.Options.HashAlgorithm.SHA256"> <summary> Use SHA256. </summary> </member> <member name="F:PSRule.Options.HashAlgorithm.SHA384"> <summary> Use SHA384. </summary> </member> <member name="F:PSRule.Options.HashAlgorithm.SHA512"> <summary> Use SHA512. </summary> </member> <member name="T:PSRule.Options.InputFormat"> <summary> The formats to convert input from. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Options/#inputformat"/> </summary> </member> <member name="F:PSRule.Options.InputFormat.None"> <summary> Treat strings as plain text and do not deserialize files. </summary> </member> <member name="F:PSRule.Options.InputFormat.Yaml"> <summary> Deserialize as one or more YAML objects. </summary> </member> <member name="F:PSRule.Options.InputFormat.Json"> <summary> Deserialize as one or more JSON objects. </summary> </member> <member name="F:PSRule.Options.InputFormat.Markdown"> <summary> Deserialize as a markdown object. </summary> </member> <member name="F:PSRule.Options.InputFormat.PowerShellData"> <summary> Deserialize as a PowerShell data object. </summary> </member> <member name="F:PSRule.Options.InputFormat.File"> <summary> Files are treated as objects and not deserialized. </summary> </member> <member name="F:PSRule.Options.InputFormat.Detect"> <summary> Detect format based on file extension. This is the default. </summary> </member> <member name="T:PSRule.Options.IOption"> <summary> An interface for an option. </summary> </member> <member name="T:PSRule.Options.IOptionContext"> <summary> An interface for getting the current options configured during runtime. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </member> <member name="P:PSRule.Options.IOptionContext.Execution"> <summary> Options that configure the execution sandbox. </summary> </member> <member name="P:PSRule.Options.IOptionContext.Baseline"> <summary> Options that configure baselines. </summary> </member> <member name="T:PSRule.Options.LanguageMode"> <summary> Configures the language mode PowerShell code executes as within PSRule runtime. Does not affect YAML or JSON expressions. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Options/#executionlanguagemode"/> </summary> </member> <member name="F:PSRule.Options.LanguageMode.FullLanguage"> <summary> Executes with all language features. </summary> </member> <member name="F:PSRule.Options.LanguageMode.ConstrainedLanguage"> <summary> Executes in constrained language mode that restricts the types and methods that can be used. </summary> </member> <member name="T:PSRule.Options.RestrictScriptSource"> <summary> Configures where to allow PowerShell language features (such as rules and conventions) to run from. </summary> </member> <member name="F:PSRule.Options.RestrictScriptSource.Unrestricted"> <summary> PowerShell language features are allowed from workspace and modules. </summary> </member> <member name="F:PSRule.Options.RestrictScriptSource.ModuleOnly"> <summary> PowerShell language features are allowed from loaded modules, but PowerShell files within the workspace are ignored. </summary> </member> <member name="F:PSRule.Options.RestrictScriptSource.DisablePowerShell"> <summary> No PowerShell language features are used during PSRule run. </summary> </member> <member name="T:PSRule.Options.SessionState"> <summary> Configures how the initial PowerShell sandbox for executing rules is created. </summary> </member> <member name="F:PSRule.Options.SessionState.BuiltIn"> <summary> Create the initial session state with all built-in cmdlets loaded. See <seealso href="https://docs.microsoft.com/en-us/powershell/scripting/developer/hosting/creating-an-initialsessionstate?view=powershell-7.2">CreateDefault</seealso>. </summary> </member> <member name="F:PSRule.Options.SessionState.Minimal"> <summary> Create the initial session state with only cmdlets loaded for hosting PowerShell. See <seealso href="https://docs.microsoft.com/en-us/powershell/scripting/developer/hosting/creating-an-initialsessionstate?view=powershell-7.2">CreateDefault2</seealso>. </summary> </member> <member name="T:PSRule.Resources.Messages"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSRule.Resources.Messages.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSRule.Resources.Messages.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="T:PSRule.StringExtensions"> <summary> Extension methods for strings. </summary> </member> <member name="M:PSRule.StringExtensions.IsURL(System.String)"> <summary> Determine if the string is a URL. </summary> <param name="s">The string to check.</param> <returns>Returns <c>true</c> if the string starts with a http:// or https://.</returns> </member> <member name="M:PSRule.StringExtensions.SplitSemantic(System.String,System.Int32)"> <summary> Split a string semantically based on a maximum width. </summary> <param name="s">The string to split.</param> <param name="width">The maximum width to split lines along.</param> <returns>Returns an array of strings that have been semantically split.</returns> </member> <member name="M:PSRule.StringExtensions.ToCamelCase(System.String)"> <summary> Convert a string to camel case. </summary> <param name="s">The input string to convert.</param> <returns>The converted string.</returns> </member> <member name="M:PSRule.StringExtensions.Contains(System.String,System.String,System.StringComparison)"> <summary> Determine if the string contains a specific substring. </summary> <param name="s"></param> <param name="value"></param> <param name="comparison"></param> <returns></returns> </member> <member name="M:PSRule.StringExtensions.Replace(System.String,System.String,System.String,System.Boolean)"> <summary> Replace an old string with a new string. </summary> <param name="s"></param> <param name="oldString"></param> <param name="newString"></param> <param name="caseSensitive"></param> <returns></returns> </member> <member name="M:PSRule.StringExtensions.IsSemanticStopChar(System.Char)"> <summary> </summary> <param name="c"></param> <returns></returns> </member> <member name="M:PSRule.StringExtensions.IsLineBreak(System.Char)"> <summary> </summary> <param name="c"></param> <returns></returns> </member> </members> </doc> |