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="M:PSRule.Converters.TypeConverter.TryEnum``1(System.Object,System.Boolean,System.Nullable{``0}@)"> <summary> Try to get the environment variable as a enum of type <typeparamref name="T"/>. </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,YamlDotNet.Serialization.ObjectDeserializer)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringArrayConverter.YamlDotNet#Serialization#IYamlTypeConverter#WriteYaml(YamlDotNet.Core.IEmitter,System.Object,System.Type,YamlDotNet.Serialization.ObjectSerializer)"> <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,YamlDotNet.Serialization.ObjectDeserializer)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringArrayMapConverter.YamlDotNet#Serialization#IYamlTypeConverter#WriteYaml(YamlDotNet.Core.IEmitter,System.Object,System.Type,YamlDotNet.Serialization.ObjectSerializer)"> <inheritdoc/> </member> <member name="T:PSRule.Converters.Yaml.StringMapConverter`1"> <summary> A YAML converter for de/serializing <see cref="T:PSRule.Data.StringArrayMap"/>. </summary> </member> <member name="M:PSRule.Converters.Yaml.StringMapConverter`1.YamlDotNet#Serialization#IYamlTypeConverter#Accepts(System.Type)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringMapConverter`1.YamlDotNet#Serialization#IYamlTypeConverter#ReadYaml(YamlDotNet.Core.IParser,System.Type,YamlDotNet.Serialization.ObjectDeserializer)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringMapConverter`1.YamlDotNet#Serialization#IYamlTypeConverter#WriteYaml(YamlDotNet.Core.IEmitter,System.Object,System.Type,YamlDotNet.Serialization.ObjectSerializer)"> <inheritdoc/> </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="F:PSRule.Data.DateVersion.VersionConstraint.Any"> <summary> A version constraint that accepts any version including pre-releases. </summary> </member> <member name="F:PSRule.Data.DateVersion.VersionConstraint.AnyStable"> <summary> A version constraint that accepts any stable version. </summary> </member> <member name="M:PSRule.Data.DateVersion.VersionConstraint.Accepts(PSRule.Data.DateVersion.Version)"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.ConstraintExpression.Accepts(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="P:PSRule.Data.DateVersion.Version.Stable"> <summary> Determines if the version is stable or a pre-release. </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.EnumMap`1"> <summary> A mapping of string to string arrays. </summary> </member> <member name="M:PSRule.Data.EnumMap`1.#ctor"> <summary> Create an empty <see cref="T:PSRule.Data.EnumMap`1"/> instance. </summary> </member> <member name="M:PSRule.Data.EnumMap`1.#ctor(PSRule.Data.EnumMap{`0})"> <summary> Create an instance by copying an existing <see cref="T:PSRule.Data.EnumMap`1"/>. </summary> </member> <member name="M:PSRule.Data.EnumMap`1.#ctor(System.Collections.Generic.IDictionary{System.String,`0})"> <summary> Create an instance by copying mapped keys from a string dictionary. </summary> </member> <member name="M:PSRule.Data.EnumMap`1.#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="M:PSRule.Data.EnumMap`1.op_Implicit(System.Collections.Hashtable)~PSRule.Data.EnumMap{`0}"> <summary> </summary> <param name="hashtable"></param> </member> <member name="M:PSRule.Data.EnumMap`1.FromHashtable(System.Collections.Hashtable)"> <summary> Convert a hashtable into a <see cref="T:PSRule.Data.EnumMap`1"/> instance. </summary> </member> <member name="M:PSRule.Data.EnumMap`1.TryConvertValue(System.Object,`0@)"> <summary> </summary> <param name="o"></param> <param name="value"></param> <returns></returns> </member> <member name="T:PSRule.Data.IDateVersionConstraint"> <summary> An date version constraint. </summary> </member> <member name="M:PSRule.Data.IDateVersionConstraint.Accepts(PSRule.Data.DateVersion.Version)"> <summary> Determines if the date version meets the requirments of the constraint. </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.ISemanticVersionConstraint"> <summary> A semantic version constraint. </summary> </member> <member name="M:PSRule.Data.ISemanticVersionConstraint.Accepts(PSRule.Data.SemanticVersion.Version)"> <summary> Determines if the semantic version meets the requirments of the constraint. </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.SourceMap"> <summary> A source may for the target object. </summary> <remarks> This is a placeholder for future implementation and should currently be null. </remarks> </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="P:PSRule.Data.ITargetObject.Value"> <summary> The value of the object. </summary> </member> <member name="T:PSRule.Data.ITargetSourceMap"> <summary> A source map for a target object. </summary> <remarks> This is a interface placeholder reserved for future implementation. </remarks> </member> <member name="T:PSRule.Data.KeyMap`1"> <summary> A mapping of string to string arrays. </summary> </member> <member name="M:PSRule.Data.KeyMap`1.#ctor"> <summary> Create an empty <see cref="T:PSRule.Data.StringArrayMap"/> instance. </summary> </member> <member name="M:PSRule.Data.KeyMap`1.#ctor(PSRule.Data.KeyMap{`0})"> <summary> Create an instance by copying an existing <see cref="T:PSRule.Data.StringArrayMap"/>. </summary> </member> <member name="M:PSRule.Data.KeyMap`1.#ctor(System.Collections.Generic.IDictionary{System.String,`0})"> <summary> Create an instance by copying mapped keys from a string dictionary. </summary> </member> <member name="M:PSRule.Data.KeyMap`1.#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.KeyMap`1.Count"> <summary> The number of mapped keys. </summary> </member> <member name="P:PSRule.Data.KeyMap`1.Item(System.String)"> <summary> Get or set mapping for a specified key. </summary> </member> <member name="M:PSRule.Data.KeyMap`1.TryGetValue(System.String,`0@)"> <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.KeyMap`1.Add(System.String,`0)"> <summary> </summary> <param name="key"></param> <param name="value"></param> </member> <member name="M:PSRule.Data.KeyMap`1.GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.Data.KeyMap`1.System#Collections#IEnumerable#GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.Data.KeyMap`1.ToDictionary"> <summary> Convert the instance into a dictionary. </summary> <returns></returns> </member> <member name="M:PSRule.Data.KeyMap`1.GetValueDefault"> <summary> Get the default for the type. </summary> </member> <member name="M:PSRule.Data.KeyMap`1.TryConvertValue(System.Object,`0@)"> <summary> Convert the type. </summary> </member> <member name="M:PSRule.Data.KeyMap`1.FromDictionary(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Func{System.String,System.String})"> <summary> Load a key map from an existing dictionary. </summary> </member> <member name="M:PSRule.Data.KeyMap`1.FromEnvironment(System.String,System.Func{System.String,System.String})"> <summary> Load values from environment variables into the option. Keys that appear in both will replaced by environment variable values. </summary> <exception cref="T:System.ArgumentNullException">Is raised if the environment helper is null.</exception> </member> <member name="M:PSRule.Data.KeyMap`1.TryKeyPrefix(System.String,System.String,System.String@)"> <summary> Try a key prefix. </summary> </member> <member name="T:PSRule.Data.ModuleConstraint"> <summary> 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> <exception cref="T:System.ArgumentNullException">Both <paramref name="module"/> and <paramref name="constraint"/> must not be null or empty.</exception> </member> <member name="M:PSRule.Data.ModuleConstraint.#ctor(System.String,PSRule.Data.ISemanticVersionConstraint)"> <summary> 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> <exception cref="T:System.ArgumentNullException">Both <paramref name="module"/> and <paramref name="constraint"/> must not be null or empty.</exception> </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="M:PSRule.Data.ModuleConstraint.Accepts(PSRule.Data.SemanticVersion.Version)"> <inheritdoc/> </member> <member name="M:PSRule.Data.ModuleConstraint.Any(System.String,System.Boolean)"> <summary> Get a constraint that accepts any version of the specified module. </summary> <param name="module"></param> <param name="includePrerelease">Determines if pre-releases are accepted or only stable versions.</param> <returns>A <see cref="T:PSRule.Data.ModuleConstraint"/>.</returns> </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="F:PSRule.Data.SemanticVersion.VersionConstraint.Any"> <summary> A version constraint that accepts any version including pre-releases. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.VersionConstraint.AnyStable"> <summary> A version constraint that accepts any stable version. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.VersionConstraint.Accepts(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.Accepts(PSRule.Data.SemanticVersion.Version)"> <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="P:PSRule.Data.SemanticVersion.Version.Stable"> <summary> Determines if the version is stable or a pre-release. </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"> <summary> Get the version as a string. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.Version.ToShortString"> <summary> Get the version as a string returning only the major.minor.patch part of the version. </summary> </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="M:PSRule.Data.SemanticVersion.Version.GetVersionString(System.Boolean)"> <summary> Returns a version string. </summary> <param name="simple">When <c>true</c>, only return the major.minor.patch version.</param> </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(PSRule.Data.SemanticVersion.PR)"> <inheritdoc/> </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.PR.Compare(PSRule.Data.SemanticVersion.PR,PSRule.Data.SemanticVersion.PR)"> <summary> Compare two <see cref="T:PSRule.Data.SemanticVersion.PR"/> instances. </summary> </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.Data.WildcardMap`1"> <summary> </summary> <typeparam name="T"></typeparam> </member> <member name="M:PSRule.Data.WildcardMap`1.#ctor"> <summary> </summary> </member> <member name="M:PSRule.Data.WildcardMap`1.#ctor(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,`0}})"> <summary> </summary> <param name="values"></param> </member> <member name="M:PSRule.Data.WildcardMap`1.TryGetValue(System.String,`0@)"> <summary> </summary> <param name="key"></param> <param name="value"></param> <returns></returns> </member> <member name="T:PSRule.Definitions.ILanguageBlock"> <summary> A language block. </summary> </member> <member name="P:PSRule.Definitions.ILanguageBlock.Id"> <summary> The unique identifier for the block. </summary> </member> <member name="P:PSRule.Definitions.ILanguageBlock.Source"> <summary> The source location for the block. </summary> </member> <member name="T:PSRule.Definitions.InfoString"> <summary> A string formatted with plain text and/ or markdown. </summary> </member> <member name="P:PSRule.Definitions.InfoString.HasValue"> <summary> Determine if the information string is empty. </summary> </member> <member name="P:PSRule.Definitions.InfoString.Text"> <summary> A plain text representation. </summary> </member> <member name="P:PSRule.Definitions.InfoString.Markdown"> <summary> A markdown formatted representation if set. Otherwise this is the same as <see cref="P:PSRule.Definitions.InfoString.Text"/>. </summary> </member> <member name="M:PSRule.Definitions.InfoString.Create(System.String,System.String)"> <summary> Create an info string when not null or empty. </summary> </member> <member name="T:PSRule.Definitions.IResource"> <summary> A resource language block. </summary> </member> <member name="P:PSRule.Definitions.IResource.Kind"> <summary> The type of resource. </summary> </member> <member name="P:PSRule.Definitions.IResource.ApiVersion"> <summary> The API version of the resource. </summary> </member> <member name="P:PSRule.Definitions.IResource.Name"> <summary> The name of the resource. </summary> </member> <member name="P:PSRule.Definitions.IResource.Ref"> <summary> An optional reference identifier for the resource. </summary> </member> <member name="P:PSRule.Definitions.IResource.Alias"> <summary> Any additional aliases for the resource. </summary> </member> <member name="P:PSRule.Definitions.IResource.Tags"> <summary> Any resource tags. </summary> </member> <member name="P:PSRule.Definitions.IResource.Labels"> <summary> Any taxonomy references. </summary> </member> <member name="P:PSRule.Definitions.IResource.Flags"> <summary> Flags for the resource. </summary> </member> <member name="P:PSRule.Definitions.IResource.Extent"> <summary> The source location of the resource. </summary> </member> <member name="P:PSRule.Definitions.IResource.Info"> <summary> Additional information about the resource. </summary> </member> <member name="T:PSRule.Definitions.IResourceAnnotations"> <summary> </summary> </member> <member name="T:PSRule.Definitions.IResourceHelpInfo"> <summary> Metadata about a PSRule resource. </summary> </member> <member name="P:PSRule.Definitions.IResourceHelpInfo.Name"> <summary> The name of the resource. </summary> </member> <member name="P:PSRule.Definitions.IResourceHelpInfo.DisplayName"> <summary> A display name of the resource if set. </summary> </member> <member name="P:PSRule.Definitions.IResourceHelpInfo.Synopsis"> <summary> A short description of the resource if set. </summary> </member> <member name="P:PSRule.Definitions.IResourceHelpInfo.Description"> <summary> A long description of the resource if set. </summary> </member> <member name="T:PSRule.Definitions.IResourceLabels"> <summary> </summary> </member> <member name="M:PSRule.Definitions.IResourceLabels.Contains(System.String,System.String[])"> <summary> Check if the resource label matches. </summary> <param name="key"></param> <param name="value"></param> <returns></returns> </member> <member name="T:PSRule.Definitions.IResourceMetadata"> <summary> Additional resource metadata. </summary> </member> <member name="P:PSRule.Definitions.IResourceMetadata.Annotations"> <summary> Annotations on the resource. </summary> </member> <member name="T:PSRule.Definitions.IResourceTags"> <summary> </summary> </member> <member name="M:PSRule.Definitions.IResourceTags.ToHashtable"> <summary> </summary> <returns></returns> </member> <member name="M:PSRule.Definitions.IResourceTags.Contains(System.Object,System.Object)"> <summary> Check if a specific resource tag exists. </summary> <param name="key"></param> <param name="value"></param> <returns></returns> </member> <member name="T:PSRule.Definitions.ISourceExtent"> <summary> A source location for a PSRule expression. </summary> </member> <member name="P:PSRule.Definitions.ISourceExtent.File"> <summary> The source file path. </summary> </member> <member name="P:PSRule.Definitions.ISourceExtent.Line"> <summary> The first line of the expression. </summary> </member> <member name="P:PSRule.Definitions.ISourceExtent.Position"> <summary> The first position of the expression. </summary> </member> <member name="T:PSRule.Definitions.ISourceFile"> <summary> A source file containing resources that will be loaded and interpreted by PSRule. </summary> </member> <member name="P:PSRule.Definitions.ISourceFile.Path"> <summary> The file path to the source. </summary> </member> <member name="P:PSRule.Definitions.ISourceFile.Module"> <summary> The name of the module if the source was loaded from a module. </summary> </member> <member name="P:PSRule.Definitions.ISourceFile.Type"> <summary> The type of source file. </summary> </member> <member name="P:PSRule.Definitions.ISourceFile.HelpPath"> <summary> The base path to use for loading help content. </summary> </member> <member name="M:PSRule.Definitions.ISourceFile.Exists"> <summary> Determines if the source file exists. </summary> <returns>Returns <c>true</c> when the source file exists.</returns> </member> <member name="M:PSRule.Definitions.ISourceFile.IsDependency"> <summary> Determines if the source file is a dependency. </summary> <returns>Returns <c>true</c> when the source file is a dependency.</returns> </member> <member name="T:PSRule.Definitions.IStringMap`1"> <summary> A map of <typeparamref name="TValue"/> index by string. </summary> <typeparam name="TValue">The type indexed by string.</typeparam> </member> <member name="P:PSRule.Definitions.IStringMap`1.Count"> <summary> The number of key/ value pairs set in the map. </summary> </member> <member name="M:PSRule.Definitions.IStringMap`1.TryGetValue(System.String,`0@)"> <summary> Find a value by it's corresponding key. </summary> <param name="key">The key of a value in the index.</param> <param name="value">A return value from the index.</param> <returns>Returns <c>true</c> if the key was found in the map.</returns> </member> <member name="T:PSRule.Definitions.ResourceAnnotations"> <summary> Additional resource annotations. </summary> </member> <member name="T:PSRule.Definitions.ResourceFlags"> <summary> Additional flags that indicate the status of the resource. </summary> </member> <member name="F:PSRule.Definitions.ResourceFlags.None"> <summary> No flags are set. </summary> </member> <member name="F:PSRule.Definitions.ResourceFlags.Obsolete"> <summary> The resource is obsolete. </summary> </member> <member name="M:PSRule.Definitions.ResourceHelper.GetRuleId(System.String,System.String[],PSRule.Definitions.ResourceIdKind)"> <summary> Checks each resource name and converts each into a full qualified <seealso cref="T:PSRule.Definitions.ResourceId"/>. </summary> <param name="defaultScope">The default scope to use if the resource name if not fully qualified.</param> <param name="name">An array of names. Qualified names (RuleIds) supplied are left intact.</param> <param name="kind">The <seealso cref="T:PSRule.Definitions.ResourceIdKind"/> of the <seealso cref="T:PSRule.Definitions.ResourceId"/>.</param> <returns>An array of RuleIds.</returns> </member> <member name="P:PSRule.Definitions.ResourceHelpInfo.Name"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.ResourceHelpInfo.DisplayName"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.ResourceHelpInfo.Synopsis"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.ResourceHelpInfo.Description"> <inheritdoc/> </member> <member name="T:PSRule.Definitions.ResourceId"> <summary> A unique identifier for a resource. </summary> </member> <member name="P:PSRule.Definitions.ResourceId.Value"> <summary> A string representation of the resource identifier. </summary> </member> <member name="P:PSRule.Definitions.ResourceId.Scope"> <summary> The scope of the resource. </summary> </member> <member name="P:PSRule.Definitions.ResourceId.Name"> <summary> A unique name for the resource within the specified <see cref="P:PSRule.Definitions.ResourceId.Scope"/>. </summary> </member> <member name="P:PSRule.Definitions.ResourceId.Kind"> <summary> The type of resource identifier. </summary> </member> <member name="M:PSRule.Definitions.ResourceId.ToString"> <summary> Converts the resource identifier to a string. </summary> <remarks> This is the same as <see cref="P:PSRule.Definitions.ResourceId.Value"/>. </remarks> <returns>A string representation of the resource identifier.</returns> </member> <member name="M:PSRule.Definitions.ResourceId.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Definitions.ResourceId.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Definitions.ResourceId.Equals(PSRule.Definitions.ResourceId)"> <inheritdoc/> </member> <member name="M:PSRule.Definitions.ResourceId.Equals(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Definitions.ResourceId.op_Equality(PSRule.Definitions.ResourceId,PSRule.Definitions.ResourceId)"> <summary> Compare two resource identifiers to determine if they are equal. </summary> </member> <member name="M:PSRule.Definitions.ResourceId.op_Inequality(PSRule.Definitions.ResourceId,PSRule.Definitions.ResourceId)"> <summary> Compare two resource identifiers to determine if they are not equal. </summary> </member> <member name="T:PSRule.Definitions.ResourceIdEqualityComparer"> <summary> Compares two resource identifiers to determine if they are equal. </summary> </member> <member name="T:PSRule.Definitions.ResourceIdKind"> <summary> Additional information about the type of identifier if available. </summary> </member> <member name="F:PSRule.Definitions.ResourceIdKind.None"> <summary> Not specified. </summary> </member> <member name="F:PSRule.Definitions.ResourceIdKind.Unknown"> <summary> Unknown. </summary> </member> <member name="F:PSRule.Definitions.ResourceIdKind.Id"> <summary> The identifier is a primary resource identifier. </summary> </member> <member name="F:PSRule.Definitions.ResourceIdKind.Ref"> <summary> The identifier is a opaque reference resource identifier. </summary> </member> <member name="F:PSRule.Definitions.ResourceIdKind.Alias"> <summary> The identifier is an alias resource identifier. </summary> </member> <member name="T:PSRule.Definitions.ResourceKind"> <summary> The type of resource. </summary> </member> <member name="F:PSRule.Definitions.ResourceKind.None"> <summary> Unknown or empty. </summary> </member> <member name="F:PSRule.Definitions.ResourceKind.Rule"> <summary> A rule resource. </summary> </member> <member name="F:PSRule.Definitions.ResourceKind.Baseline"> <summary> A baseline resource. </summary> </member> <member name="F:PSRule.Definitions.ResourceKind.ModuleConfig"> <summary> A module configuration resource. </summary> </member> <member name="F:PSRule.Definitions.ResourceKind.Selector"> <summary> A selector resource. </summary> </member> <member name="F:PSRule.Definitions.ResourceKind.Convention"> <summary> A convention. </summary> </member> <member name="F:PSRule.Definitions.ResourceKind.SuppressionGroup"> <summary> A suppression group. </summary> </member> <member name="T:PSRule.Definitions.Rules.SeverityLevel"> <summary> If the rule fails, how serious is the result. </summary> </member> <member name="F:PSRule.Definitions.Rules.SeverityLevel.None"> <summary> Severity is unset. </summary> </member> <member name="F:PSRule.Definitions.Rules.SeverityLevel.Error"> <summary> A failure generates an error. </summary> </member> <member name="F:PSRule.Definitions.Rules.SeverityLevel.Warning"> <summary> A failure generates a warning. </summary> </member> <member name="F:PSRule.Definitions.Rules.SeverityLevel.Information"> <summary> A failure generate an informational message. </summary> </member> <member name="T:PSRule.Definitions.SourceType"> <summary> The type of source file. </summary> </member> <member name="F:PSRule.Definitions.SourceType.Script"> <summary> PowerShell script file. </summary> </member> <member name="F:PSRule.Definitions.SourceType.Yaml"> <summary> YAML file. </summary> </member> <member name="F:PSRule.Definitions.SourceType.Json"> <summary> JSON or JSON with comments file. </summary> </member> <member name="T:PSRule.Definitions.StringMap`1"> <summary> A string index map for child values. </summary> <typeparam name="TValue">The type of child values assigned for each map key.</typeparam> </member> <member name="M:PSRule.Definitions.StringMap`1.#ctor"> <summary> Create an empty map. </summary> </member> <member name="M:PSRule.Definitions.StringMap`1.#ctor(System.Collections.Generic.IDictionary{System.String,`0})"> <summary> Create a map with items. </summary> </member> <member name="M:PSRule.Definitions.StringMap`1.#ctor(PSRule.Definitions.StringMap{`0})"> <summary> Create a map based on an existing map. </summary> </member> <member name="P:PSRule.Definitions.StringMap`1.Count"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.StringMap`1.Item(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Definitions.StringMap`1.Add(System.String,`0)"> <inheritdoc/> </member> <member name="M:PSRule.Definitions.StringMap`1.TryGetValue(System.String,`0@)"> <inheritdoc/> </member> <member name="M:PSRule.Definitions.StringMap`1.Clear"> <summary> Clear the map of all keys and values. </summary> </member> <member name="M:PSRule.Definitions.StringMap`1.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Definitions.StringMap`1.Combine(PSRule.Definitions.StringMap{`0})"> <summary> Add unique keys from another map. </summary> </member> <member name="M:PSRule.Definitions.StringMap`1.ImportFromDictionary(System.String,System.Collections.Generic.IDictionary{System.String,System.Object},System.Func{System.Collections.Generic.KeyValuePair{System.String,System.Object},System.Nullable{System.Collections.Generic.KeyValuePair{System.String,`0}}})"> <summary> Load values from a key/ value dictionary into the option. Keys that appear in both will replaced by dictionary values. </summary> <exception cref="T:System.ArgumentNullException">Is raised if the dictionary is null.</exception> </member> <member name="M:PSRule.Definitions.StringMap`1.ImportFromEnvironmentVariables(System.String,System.Func{System.Collections.Generic.KeyValuePair{System.String,System.Object},System.Nullable{System.Collections.Generic.KeyValuePair{System.String,`0}}})"> <summary> Import values from environment variables. </summary> </member> <member name="M:PSRule.Definitions.StringMap`1.TryKeyPrefix(System.String,System.String,System.String@)"> <summary> Try a key prefix. </summary> </member> <member name="M:PSRule.Definitions.StringMap`1.GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.Definitions.StringMap`1.System#Collections#IEnumerable#GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.Definitions.StringMap`1.YamlDotNet#Serialization#IYamlConvertible#Read(YamlDotNet.Core.IParser,System.Type,YamlDotNet.Serialization.ObjectDeserializer)"> <summary> Deserialize the string map. </summary> </member> <member name="M:PSRule.Definitions.StringMap`1.YamlDotNet#Serialization#IYamlConvertible#Write(YamlDotNet.Core.IEmitter,YamlDotNet.Serialization.ObjectSerializer)"> <summary> Serialize the string map. </summary> </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.Emitters.BaseEmitter"> <summary> A base class for implementing an emitter. </summary> </member> <member name="M:PSRule.Emitters.BaseEmitter.Visit(PSRule.Emitters.IEmitterContext,System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Emitters.BaseEmitter.Accepts(PSRule.Emitters.IEmitterContext,System.Type)"> <inheritdoc/> </member> <member name="M:PSRule.Emitters.BaseEmitter.Dispose(System.Boolean)"> <summary> Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. </summary> <param name="disposing">Determines if a dispose is occuring.</param> </member> <member name="M:PSRule.Emitters.BaseEmitter.Dispose"> <inheritdoc/> </member> <member name="T:PSRule.Emitters.EmptyEmitterConfiguration"> <summary> An empty configuration for an emitter. </summary> </member> <member name="F:PSRule.Emitters.EmptyEmitterConfiguration.Instance"> <summary> An default instance of the empty configuration. </summary> </member> <member name="M:PSRule.Emitters.EmptyEmitterConfiguration.GetFormatTypes(System.String,System.String[])"> <inheritdoc/> </member> <member name="M:PSRule.Emitters.EmptyEmitterConfiguration.GetBoolOrDefault(System.String,System.Nullable{System.Boolean})"> <inheritdoc/> </member> <member name="M:PSRule.Emitters.EmptyEmitterConfiguration.GetIntegerOrDefault(System.String,System.Nullable{System.Int32})"> <inheritdoc/> </member> <member name="M:PSRule.Emitters.EmptyEmitterConfiguration.GetStringOrDefault(System.String,System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Emitters.EmptyEmitterConfiguration.GetStringValues(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Emitters.EmptyEmitterConfiguration.GetValueOrDefault(System.String,System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Emitters.EmptyEmitterConfiguration.IsEnabled(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Emitters.EmptyEmitterConfiguration.TryConfigurationValue(System.String,System.Object@)"> <inheritdoc/> </member> <member name="T:PSRule.Emitters.FileEmitter"> <summary> An emitter that implements emitting objects from file streams. </summary> </member> <member name="M:PSRule.Emitters.FileEmitter.Accepts(PSRule.Emitters.IEmitterContext,System.Type)"> <inheritdoc/> </member> <member name="M:PSRule.Emitters.FileEmitter.Visit(PSRule.Emitters.IEmitterContext,System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Emitters.FileEmitter.AcceptsFilePath(PSRule.Emitters.IEmitterContext,PSRule.Data.IFileInfo)"> <summary> Determines if the emitter accepts a file based on it's path. </summary> <param name="context"></param> <param name="info"></param> <returns></returns> </member> <member name="M:PSRule.Emitters.FileEmitter.AcceptsString(PSRule.Emitters.IEmitterContext)"> <summary> Determines if the emitter accepts an input string as content. </summary> <param name="context"></param> <returns></returns> </member> <member name="M:PSRule.Emitters.FileEmitter.VisitFile(PSRule.Emitters.IEmitterContext,PSRule.Data.IFileStream)"> <summary> Visit a specific file. </summary> <param name="context"></param> <param name="stream"></param> <returns></returns> </member> <member name="M:PSRule.Emitters.FileEmitter.VisitString(PSRule.Emitters.IEmitterContext,System.String)"> <summary> Visit a string. </summary> <param name="context"></param> <param name="content"></param> <returns></returns> </member> <member name="T:PSRule.Emitters.IEmitter"> <summary> An emitter for processing input. </summary> </member> <member name="M:PSRule.Emitters.IEmitter.Visit(PSRule.Emitters.IEmitterContext,System.Object)"> <summary> Visit an object and emit any input objects for processing. </summary> <param name="context">A context object for the emitter.</param> <param name="o">The object to visit.</param> <returns>Returns <c>true</c> when the emitter processed the object and <c>false</c> when it did not.</returns> </member> <member name="M:PSRule.Emitters.IEmitter.Accepts(PSRule.Emitters.IEmitterContext,System.Type)"> <summary> Determines if the emitter accepts the specified object type. </summary> <param name="context"></param> <param name="type"></param> <returns></returns> </member> <member name="T:PSRule.Emitters.IEmitterConfiguration"> <summary> Scoped configuration for an emitter. </summary> </member> <member name="M:PSRule.Emitters.IEmitterConfiguration.GetFormatTypes(System.String,System.String[])"> <summary> Get the types that are configured for the format. </summary> <param name="format">The name of the format that will be referenced.</param> <param name="defaultTypes">Configures the default types that are used if the format is not set.</param> </member> <member name="T:PSRule.Emitters.IEmitterContext"> <summary> Contains context for an <see cref="T:PSRule.Emitters.IEmitter"/>. </summary> </member> <member name="P:PSRule.Emitters.IEmitterContext.Format"> <summary> The format that will be used to convert string types. </summary> </member> <member name="P:PSRule.Emitters.IEmitterContext.ShouldEmitFile"> <summary> Determines if file are emitted for processing. This is for backwards compatibility and will be removed for v4. </summary> </member> <member name="M:PSRule.Emitters.IEmitterContext.Emit(PSRule.Data.ITargetObject)"> <summary> Emit a target object to the pipeline. </summary> <param name="value">The <seealso cref="T:PSRule.Data.ITargetObject"/> to emit.</param> </member> <member name="M:PSRule.Emitters.IEmitterContext.ShouldQueue(System.String)"> <summary> Determine if a specified path should be queued for processing. </summary> </member> <member name="T:PSRule.Emitters.IEmitterContextExtensions"> <summary> </summary> </member> <member name="M:PSRule.Emitters.IEmitterContextExtensions.Emit(PSRule.Emitters.IEmitterContext,System.Collections.Generic.IEnumerable{PSRule.Data.ITargetObject})"> <summary> Emit each target object in a collection. </summary> <param name="context">An <seealso cref="T:PSRule.Emitters.IEmitter"/> context.</param> <param name="value">A collection of <seealso cref="T:PSRule.Data.ITargetObject"/>.</param> </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.CombineEnvironmentVariable(System.String[])"> <summary> Combines one or more environment variables into a single string. </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.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.Import(System.Collections.Generic.IDictionary{System.String,System.Object})"> <inheritdoc/> </member> <member name="T:PSRule.Options.BreakLevel"> <summary> Determine the rule severity level at which to break the pipeline. </summary> </member> <member name="F:PSRule.Options.BreakLevel.None"> <summary> No preference. Inherits the default of <c>OnError</c>. </summary> </member> <member name="F:PSRule.Options.BreakLevel.Never"> <summary> Continue even if a rule fails regardless of rule severity. </summary> </member> <member name="F:PSRule.Options.BreakLevel.OnError"> <summary> Only break on error. </summary> </member> <member name="F:PSRule.Options.BreakLevel.OnWarning"> <summary> Break if any rule of warning or error severity fails. </summary> </member> <member name="F:PSRule.Options.BreakLevel.OnInformation"> <summary> Break if any rule fails. </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.ExecutionOption"> <summary> Options that configure the execution sandbox. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </member> <member name="F:PSRule.Options.ExecutionOption.Default"> <summary> The default execution option. </summary> </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.Break"> <summary> Determines the minimum rule severity level that breaks the pipeline. By default, the pipeline will break if a rule of error severity fails. </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.Import(System.Collections.Generic.IDictionary{System.String,System.Object})"> <inheritdoc/> </member> <member name="T:PSRule.Options.FormatOption"> <summary> Options that configure format types. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </member> <member name="M:PSRule.Options.FormatOption.#ctor"> <summary> Creates an empty format option. </summary> </member> <member name="M:PSRule.Options.FormatOption.#ctor(PSRule.Options.FormatOption)"> <summary> Creates a format option by copying an existing instance. </summary> </member> <member name="M:PSRule.Options.FormatOption.Combine(PSRule.Options.FormatOption,PSRule.Options.FormatOption)"> <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="M:PSRule.Options.FormatOption.Import(System.Collections.Generic.IDictionary{System.String,System.Object})"> <inheritdoc/> </member> <member name="M:PSRule.Options.FormatOption.Load"> <inheritdoc/> </member> <member name="T:PSRule.Options.FormatType"> <summary> A format type. </summary> </member> <member name="P:PSRule.Options.FormatType.Type"> <summary> Configures the types to process as this format. </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.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.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.Break"> <summary> Determines the minimum rule severity level that breaks the pipeline. By default, the pipeline will break if a rule of error severity fails. </summary> </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 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.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.IFormatOption"> <summary> Options that configure format types. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </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="T:PSRule.Options.IOption"> <summary> An interface for an option. </summary> </member> <member name="M:PSRule.Options.IOption.Import(System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Import from a dictionary index by a string key. </summary> <param name="dictionary">A dictionary of key value pairs to load the option from.</param> </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.IOverrideOption"> <summary> Options that configure additional rule overrides. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </member> <member name="P:PSRule.Options.IOverrideOption.Level"> <summary> A mapping of rule severity levels to override. </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.OverrideOption"> <summary> Options that configure additional rule overrides. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </member> <member name="M:PSRule.Options.OverrideOption.#ctor"> <summary> Create an option instance. </summary> </member> <member name="M:PSRule.Options.OverrideOption.#ctor(PSRule.Options.OverrideOption)"> <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.OverrideOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Options.OverrideOption.Equals(PSRule.Options.OverrideOption)"> <inheritdoc/> </member> <member name="M:PSRule.Options.OverrideOption.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Options.OverrideOption.Combine(PSRule.Options.OverrideOption,PSRule.Options.OverrideOption)"> <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.OverrideOption.Level"> <inheritdoc/> </member> <member name="M:PSRule.Options.OverrideOption.Load"> <summary> Load from environment variables. </summary> </member> <member name="M:PSRule.Options.OverrideOption.Import(System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Load from a dictionary. </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.Runtime.EventId"> <summary> Identifies a logging event. The primary identifier is the "Id" property, with the "Name" property providing a short description of this type of event. </summary> </member> <member name="M:PSRule.Runtime.EventId.op_Implicit(System.Int32)~PSRule.Runtime.EventId"> <summary> Implicitly creates an EventId from the given <see cref="T:System.Int32"/>. </summary> <param name="i">The <see cref="T:System.Int32"/> to convert to an EventId.</param> </member> <member name="M:PSRule.Runtime.EventId.op_Equality(PSRule.Runtime.EventId,PSRule.Runtime.EventId)"> <summary> Checks if two specified <see cref="T:PSRule.Runtime.EventId"/> instances have the same value. They are equal if they have the same Id. </summary> <param name="left">The first <see cref="T:PSRule.Runtime.EventId"/>.</param> <param name="right">The second <see cref="T:PSRule.Runtime.EventId"/>.</param> <returns><see langword="true" /> if the objects are equal.</returns> </member> <member name="M:PSRule.Runtime.EventId.op_Inequality(PSRule.Runtime.EventId,PSRule.Runtime.EventId)"> <summary> Checks if two specified <see cref="T:PSRule.Runtime.EventId"/> instances have different values. </summary> <param name="left">The first <see cref="T:PSRule.Runtime.EventId"/>.</param> <param name="right">The second <see cref="T:PSRule.Runtime.EventId"/>.</param> <returns><see langword="true" /> if the objects are not equal.</returns> </member> <member name="M:PSRule.Runtime.EventId.#ctor(System.Int32,System.String)"> <summary> Initializes an instance of the <see cref="T:PSRule.Runtime.EventId"/> struct. </summary> <param name="id">The numeric identifier for this event.</param> <param name="name">The name of this event.</param> </member> <member name="P:PSRule.Runtime.EventId.Id"> <summary> Gets the numeric identifier for this event. </summary> </member> <member name="P:PSRule.Runtime.EventId.Name"> <summary> Gets the name of this event. </summary> </member> <member name="M:PSRule.Runtime.EventId.ToString"> <inheritdoc /> </member> <member name="M:PSRule.Runtime.EventId.Equals(PSRule.Runtime.EventId)"> <summary> Indicates whether the current object is equal to another object of the same type. Two events are equal if they have the same id. </summary> <param name="other">An object to compare with this object.</param> <returns><see langword="true" /> if the current object is equal to the other parameter; otherwise, <see langword="false" />.</returns> </member> <member name="M:PSRule.Runtime.EventId.Equals(System.Object)"> <inheritdoc /> </member> <member name="M:PSRule.Runtime.EventId.GetHashCode"> <inheritdoc /> </member> <member name="T:PSRule.Runtime.FormattedLogValues"> <summary> Enable formatted log values in diagnostic messages. </summary> </member> <member name="T:PSRule.Runtime.IConfiguration"> <summary> Access configuration values at runtime. </summary> </member> <member name="M:PSRule.Runtime.IConfiguration.GetValueOrDefault(System.String,System.Object)"> <summary> Try to the configuration item if it exists. </summary> <param name="configurationKey">The name of the configuration item.</param> <param name="defaultValue">The default value to use if the configuration item does not exist.</param> <returns>Returns the configuration item or the specified default value.</returns> </member> <member name="M:PSRule.Runtime.IConfiguration.TryConfigurationValue(System.String,System.Object@)"> <summary> Try to get the configuration item if it exists. </summary> <param name="configurationKey">The name of the configuration item.</param> <param name="value">The value of the configuration item if it exists, otherwise this is <c>null</c>.</param> <returns>Returns <c>true</c> if the configuration value exists.</returns> </member> <member name="T:PSRule.Runtime.IConfigurationExtensions"> <summary> Extensions for <see cref="T:PSRule.Runtime.IConfiguration"/> instances. </summary> </member> <member name="M:PSRule.Runtime.IConfigurationExtensions.GetStringOrDefault(PSRule.Runtime.IConfiguration,System.String,System.String)"> <summary> Get the specified configuration item as a string if it exists. </summary> <param name="configuration">The <see cref="T:PSRule.Runtime.IConfiguration"/> instance.</param> <param name="configurationKey">The name of the configuration item.</param> <param name="defaultValue">The default value to use if the configuration item does not exist.</param> <returns>Returns the configuration item or the specified default value.</returns> </member> <member name="M:PSRule.Runtime.IConfigurationExtensions.GetBoolOrDefault(PSRule.Runtime.IConfiguration,System.String,System.Nullable{System.Boolean})"> <summary> Get the specified configuration item as a boolean if it exists. </summary> <param name="configuration">The <see cref="T:PSRule.Runtime.IConfiguration"/> instance.</param> <param name="configurationKey">The name of the configuration item.</param> <param name="defaultValue">The default value to use if the configuration item does not exist.</param> <returns>Returns the configuration item or the specified default value.</returns> </member> <member name="M:PSRule.Runtime.IConfigurationExtensions.GetIntegerOrDefault(PSRule.Runtime.IConfiguration,System.String,System.Nullable{System.Int32})"> <summary> Get the specified configuration item as an integer if it exists. </summary> <param name="configuration">The <see cref="T:PSRule.Runtime.IConfiguration"/> instance.</param> <param name="configurationKey">The name of the configuration item.</param> <param name="defaultValue">The default value to use if the configuration item does not exist.</param> <returns>Returns the configuration item or the specified default value.</returns> </member> <member name="M:PSRule.Runtime.IConfigurationExtensions.GetStringValues(PSRule.Runtime.IConfiguration,System.String)"> <summary> Get the specified configuration item as a string array. </summary> <param name="configuration">The <see cref="T:PSRule.Runtime.IConfiguration"/> instance.</param> <param name="configurationKey">The name of the configuration item.</param> <returns> Returns an array of strings. If the configuration key does not exist and empty array is returned. If the configuration key is a string, an array with a single element is returned. </returns> </member> <member name="M:PSRule.Runtime.IConfigurationExtensions.IsEnabled(PSRule.Runtime.IConfiguration,System.String)"> <summary> Check if specified configuration item is enabled. </summary> <remarks> Use this method to check if a feature is enabled. </remarks> <param name="configuration">The <see cref="T:PSRule.Runtime.IConfiguration"/> instance.</param> <param name="configurationKey">The name of the configuration item.</param> <returns>Returns <c>true</c> when the configuration item exists and it set to <c>true</c>. Otherwise <c>false</c> is returned.</returns> </member> <member name="T:PSRule.Runtime.IConfigurationFactory"> <summary> A factory that creates configuration instances. </summary> </member> <member name="T:PSRule.Runtime.ILogger"> <summary> Log diagnostic messages at runtime. </summary> </member> <member name="M:PSRule.Runtime.ILogger.IsEnabled(PSRule.Runtime.LogLevel)"> <summary> Determine if the specified type of diagnostic message should be logged. </summary> <param name="logLevel">The type of the diagnostic message.</param> <returns>Returns <c>true</c> if the <see cref="T:PSRule.Runtime.LogLevel"/> should be logged.</returns> </member> <member name="M:PSRule.Runtime.ILogger.Log``1(PSRule.Runtime.LogLevel,PSRule.Runtime.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})"> <summary> Log a diagnostic message. </summary> <typeparam name="TState">Additional information that describes the diagnostic state to log.</typeparam> <param name="logLevel">The type of the diagnostic message.</param> <param name="eventId">An event identifier for the diagnostic message.</param> <param name="state">Additional information that describes the diagnostic state to log.</param> <param name="exception">An optional exception which the diagnostic message is related to.</param> <param name="formatter">A function to format the diagnostic message for the outpuyt stream.</param> </member> <member name="T:PSRule.Runtime.ILoggerFactory"> <summary> A factory that creates loggers. </summary> </member> <member name="M:PSRule.Runtime.ILoggerFactory.Create(System.String)"> <summary> A factory for creating loggers. </summary> <param name="categoryName">The category name for messages produced by the logger.</param> <returns>Create an instance of an <see cref="T:PSRule.Runtime.ILogger"/> with the specified category name.</returns> </member> <member name="T:PSRule.Runtime.ILogger`1"> <summary> Log diagnostic messages at runtime. </summary> <typeparam name="TCategoryName">The type name to use for the logger category.</typeparam> </member> <member name="T:PSRule.Runtime.LoggerExtensions"> <summary> Extension for <see cref="T:PSRule.Runtime.ILogger"/> to log diagnostic messages. </summary> </member> <member name="M:PSRule.Runtime.LoggerExtensions.LogWarning(PSRule.Runtime.ILogger,PSRule.Runtime.EventId,System.String,System.Object[])"> <summary> Log a warning message. </summary> <param name="logger">A valid <see cref="T:PSRule.Runtime.ILogger"/> instance.</param> <param name="eventId">An event identifier for the warning.</param> <param name="message">The format message text.</param> <param name="args">Additional arguments to use within the format message.</param> </member> <member name="M:PSRule.Runtime.LoggerExtensions.LogError(PSRule.Runtime.ILogger,PSRule.Runtime.EventId,System.Exception,System.String,System.Object[])"> <summary> Log an error message. </summary> <param name="logger">A valid <see cref="T:PSRule.Runtime.ILogger"/> instance.</param> <param name="eventId">An event identifier for the error.</param> <param name="exception">An optional exception which the error message is related to.</param> <param name="message">The format message text.</param> <param name="args">Additional arguments to use within the format message.</param> </member> <member name="M:PSRule.Runtime.LoggerExtensions.Log(PSRule.Runtime.ILogger,PSRule.Runtime.LogLevel,PSRule.Runtime.EventId,System.Exception,System.String,System.Object[])"> <summary> Log a diagnostic message. </summary> <param name="logger">A valid <see cref="T:PSRule.Runtime.ILogger"/> instance.</param> <param name="logLevel">The type of diagnostic message.</param> <param name="eventId">An event identifier for the diagnostic message.</param> <param name="exception">An optional exception which the diagnostic message is related to.</param> <param name="message">The format message text.</param> <param name="args">Additional arguments to use within the format message.</param> </member> <member name="M:PSRule.Runtime.LoggerExtensions.MessageFormatter(PSRule.Runtime.FormattedLogValues,System.Exception)"> <summary> Format log messages with values. </summary> </member> <member name="T:PSRule.Runtime.Logger`1"> <summary> Log diagnostic messages at runtime. </summary> <typeparam name="T">The type name to use for the logger category.</typeparam> </member> <member name="M:PSRule.Runtime.Logger`1.#ctor(PSRule.Runtime.ILoggerFactory)"> <summary> Log diagnostic messages at runtime. </summary> <typeparam name="T">The type name to use for the logger category.</typeparam> </member> <member name="P:PSRule.Runtime.Logger`1.CategoryName"> <summary> The name of the category. </summary> </member> <member name="M:PSRule.Runtime.Logger`1.IsEnabled(PSRule.Runtime.LogLevel)"> <inheritdoc/> </member> <member name="M:PSRule.Runtime.Logger`1.Log``1(PSRule.Runtime.LogLevel,PSRule.Runtime.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})"> <inheritdoc/> </member> <member name="T:PSRule.Runtime.LogLevel"> <summary> A set of log levels which indicate different types of diagnostic messages. </summary> </member> <member name="F:PSRule.Runtime.LogLevel.Trace"> <summary> </summary> </member> <member name="F:PSRule.Runtime.LogLevel.Debug"> <summary> </summary> </member> <member name="F:PSRule.Runtime.LogLevel.Information"> <summary> </summary> </member> <member name="F:PSRule.Runtime.LogLevel.Warning"> <summary> </summary> </member> <member name="F:PSRule.Runtime.LogLevel.Error"> <summary> </summary> </member> <member name="F:PSRule.Runtime.LogLevel.Critical"> <summary> </summary> </member> <member name="F:PSRule.Runtime.LogLevel.None"> <summary> </summary> </member> <member name="T:PSRule.Runtime.NullLogger"> <summary> A logger that sinks all logs. </summary> </member> <member name="F:PSRule.Runtime.NullLogger.Instance"> <summary> An default instance of the null logger. </summary> </member> <member name="M:PSRule.Runtime.NullLogger.IsEnabled(PSRule.Runtime.LogLevel)"> <inheritdoc/> </member> <member name="M:PSRule.Runtime.NullLogger.Log``1(PSRule.Runtime.LogLevel,PSRule.Runtime.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})"> <inheritdoc/> </member> <member name="T:PSRule.Runtime.NullLogger`1"> <summary> A logger that sinks all logs. </summary> </member> <member name="F:PSRule.Runtime.NullLogger`1.Instance"> <summary> An default instance of the null logger. </summary> </member> <member name="M:PSRule.Runtime.NullLogger`1.IsEnabled(PSRule.Runtime.LogLevel)"> <inheritdoc/> </member> <member name="M:PSRule.Runtime.NullLogger`1.Log``1(PSRule.Runtime.LogLevel,PSRule.Runtime.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})"> <inheritdoc/> </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> |