Microsoft.PSRule.Core.xml
|
<?xml version="1.0"?> <doc> <assembly> <name>Microsoft.PSRule.Core</name> </assembly> <members> <member name="T:PSRule.Annotations.CommentMetadata"> <summary> Metadata properties that can be exposed by comment help. </summary> </member> <member name="T:PSRule.Badges.BadgeType"> <summary> The type of badge. </summary> </member> <member name="F:PSRule.Badges.BadgeType.Unknown"> <summary> A badge that reports an unknown state. </summary> </member> <member name="F:PSRule.Badges.BadgeType.Success"> <summary> A badge reporting a successful state. </summary> </member> <member name="F:PSRule.Badges.BadgeType.Failure"> <summary> A bagde reporting a failed state. </summary> </member> <member name="T:PSRule.Badges.IBadge"> <summary> An instance of a badge created by the badge API. </summary> </member> <member name="M:PSRule.Badges.IBadge.ToSvg"> <summary> Get the badge as SVG text content. </summary> </member> <member name="M:PSRule.Badges.IBadge.ToFile(System.String)"> <summary> Write the SVG badge content directly to disk. </summary> </member> <member name="T:PSRule.Badges.IBadgeBuilder"> <summary> A builder for the badge API. </summary> </member> <member name="M:PSRule.Badges.IBadgeBuilder.Create(PSRule.Pipeline.InvokeResult)"> <summary> Create a badge for the worst case of an analyzed object. </summary> <param name="result">A single result. The worst case for all records of an object is used for the badge.</param> <returns>An instance of a badge.</returns> </member> <member name="M:PSRule.Badges.IBadgeBuilder.Create(System.Collections.Generic.IEnumerable{PSRule.Pipeline.InvokeResult})"> <summary> Create a badge for the worst case of all analyzed objects. </summary> <param name="result">A enumeration of results. The worst case from all results is used for the badge.</param> <returns>An instance of a badge.</returns> </member> <member name="M:PSRule.Badges.IBadgeBuilder.Create(System.String,PSRule.Badges.BadgeType,System.String)"> <summary> Create a custom badge. </summary> <param name="title">The left badge text.</param> <param name="type">Determines if the result is Unknown, Success, or Failure.</param> <param name="label">The right badge text.</param> <returns>An instance of a badge.</returns> </member> <member name="T:PSRule.Badges.Badge"> <summary> An instance of a badge created by the Badge API. </summary> </member> <member name="M:PSRule.Badges.Badge.ToString"> <inheritdoc/> </member> <member name="M:PSRule.Badges.Badge.ToSvg"> <inheritdoc/> </member> <member name="M:PSRule.Badges.Badge.ToFile(System.String)"> <inheritdoc/> </member> <member name="T:PSRule.Badges.BadgeBuilder"> <summary> A badge builder that implements the Badge API within PSRule. </summary> </member> <member name="M:PSRule.Badges.BadgeBuilder.Create(System.String,PSRule.Badges.BadgeType,System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Badges.BadgeBuilder.Create(PSRule.Pipeline.InvokeResult)"> <inheritdoc/> </member> <member name="M:PSRule.Badges.BadgeBuilder.Create(System.Collections.Generic.IEnumerable{PSRule.Pipeline.InvokeResult})"> <inheritdoc/> </member> <member name="T:PSRule.Commands.AssertAllOfCommand"> <summary> The AllOf keyword. </summary> </member> <member name="T:PSRule.Commands.AssertAnyOfCommand"> <summary> The AnyOf keyword. </summary> </member> <member name="T:PSRule.Commands.AssertExistsCommand"> <summary> The Exists keyword. </summary> </member> <member name="T:PSRule.Commands.AssertMatchCommand"> <summary> The Match keyword. </summary> </member> <member name="T:PSRule.Commands.AssertTypeOfCommand"> <summary> The TypeOf keyword. </summary> </member> <member name="T:PSRule.Commands.AssertWithinCommand"> <summary> The Within keyword. </summary> </member> <member name="P:PSRule.Commands.ExportConventionCommand.Initialize"> <summary> A script block to call once before any objects are processed. </summary> </member> <member name="P:PSRule.Commands.ExportConventionCommand.Begin"> <summary> A script block to call once per object before being processed by any rule. </summary> </member> <member name="P:PSRule.Commands.ExportConventionCommand.Process"> <summary> A script block to call once per object after rules are processed. </summary> </member> <member name="P:PSRule.Commands.ExportConventionCommand.End"> <summary> A script block to call once after all rules and all objects are processed. </summary> </member> <member name="P:PSRule.Commands.ExportConventionCommand.If"> <summary> An optional pre-condition before the convention is evaluated. </summary> </member> <member name="T:PSRule.Commands.InvokeRuleBlockCommand"> <summary> An internal langauge command used to evaluate a rule script block. </summary> </member> <member name="T:PSRule.Commands.LanguageBlock"> <summary> A base class for language blocks. </summary> </member> <member name="T:PSRule.Commands.NewRuleDefinitionCommand"> <summary> A Rule language block. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.Name"> <summary> The name of the rule. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.Level"> <summary> If the rule fails, how serious is the result. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.Body"> <summary> The definition of the deployment. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.Tag"> <summary> A set of tags with additional metadata for the rule. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.If"> <summary> An optional script precondition before the rule is evaluated. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.Type"> <summary> An optional type precondition before the rule is evaluated. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.With"> <summary> An optional selector precondition before the rule is evaluated. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.DependsOn"> <summary> Deployments that this deployment depends on. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.Configure"> <summary> A set of default configuration values. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.Alias"> <summary> Any aliases for the rule. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.Ref"> <summary> An optional reference identifer for the resource. </summary> </member> <member name="P:PSRule.Commands.NewRuleDefinitionCommand.Labels"> <summary> Any taxonomy references. </summary> </member> <member name="T:PSRule.Commands.RuleKeyword"> <summary> A base class for Rule keywords. </summary> </member> <member name="T:PSRule.Commands.WriteReasonCommand"> <summary> The Reason keyword. </summary> </member> <member name="T:PSRule.Commands.WriteRecommendationCommand"> <summary> The Recommend keyword. </summary> </member> <member name="M:PSRule.BaselineJsonSerializationMapper.MapProperty``1(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonSerializer,System.String,System.Collections.Generic.IDictionary{System.String,``0})"> <summary> Map a dictionary property. </summary> </member> <member name="M:PSRule.BaselineJsonSerializationMapper.MapProperty(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonSerializer,System.String,System.Nullable{System.Boolean})"> <summary> Map a nullable boolean property. </summary> </member> <member name="M:PSRule.BaselineJsonSerializationMapper.MapProperty``1(Newtonsoft.Json.JsonWriter,System.String,``0)"> <summary> Map an enum property. </summary> </member> <member name="M:PSRule.BaselineJsonSerializationMapper.MapProperty(Newtonsoft.Json.JsonWriter,System.String,System.String[])"> <summary> Map a string array property. </summary> </member> <member name="M:PSRule.BaselineJsonSerializationMapper.MapProperty(Newtonsoft.Json.JsonWriter,System.String,System.String)"> <summary> Map a string property. </summary> </member> <member name="M:PSRule.BaselineJsonSerializationMapper.MapProperty(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonSerializer,System.String,PSRule.Configuration.BindingOption)"> <summary> Map a BindingOption property. </summary> </member> <member name="M:PSRule.BaselineJsonSerializationMapper.MapProperty(Newtonsoft.Json.JsonWriter,System.String,PSRule.Configuration.ConventionOption)"> <summary> Map a ConventionOption property. </summary> </member> <member name="M:PSRule.BaselineJsonSerializationMapper.MapProperty(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonSerializer,System.String,PSRule.Configuration.RuleOption)"> <summary> Map a RuleOption property. </summary> </member> <member name="M:PSRule.BaselineYamlSerializationMapper.MapProperty``1(YamlDotNet.Core.IEmitter,System.String,System.Collections.Generic.IDictionary{System.String,``0})"> <summary> Map a dictionary property. </summary> </member> <member name="M:PSRule.BaselineYamlSerializationMapper.MapProperty(YamlDotNet.Core.IEmitter,System.String,System.Nullable{System.Boolean})"> <summary> Map a nullable boolean property. </summary> </member> <member name="M:PSRule.BaselineYamlSerializationMapper.MapProperty``1(YamlDotNet.Core.IEmitter,System.String,``0)"> <summary> Map an enum property. </summary> </member> <member name="M:PSRule.BaselineYamlSerializationMapper.MapProperty(YamlDotNet.Core.IEmitter,System.String,System.String[])"> <summary> Map a string array property. </summary> </member> <member name="M:PSRule.BaselineYamlSerializationMapper.MapProperty(YamlDotNet.Core.IEmitter,System.String,System.String)"> <summary> Map a string property. </summary> </member> <member name="M:PSRule.BaselineYamlSerializationMapper.MapProperty(YamlDotNet.Core.IEmitter,System.String,PSRule.Configuration.BindingOption)"> <summary> Map a BindingOption property. </summary> </member> <member name="M:PSRule.BaselineYamlSerializationMapper.MapProperty(YamlDotNet.Core.IEmitter,System.String,PSRule.Configuration.ConventionOption)"> <summary> Map a ConventionOption property. </summary> </member> <member name="M:PSRule.BaselineYamlSerializationMapper.MapProperty(YamlDotNet.Core.IEmitter,System.String,PSRule.Configuration.RuleOption)"> <summary> Map a RuleOption property. </summary> </member> <member name="M:PSRule.ExpressionHelpers.TryInt(System.Object,System.Boolean,System.Int32@)"> <summary> Try to get an int from the existing object. </summary> </member> <member name="M:PSRule.ExpressionHelpers.TryPipelineCache``1(System.String,System.String,``0@)"> <summary> Try to retrieve the cached key from the pipeline cache. </summary> </member> <member name="M:PSRule.ExpressionHelpers.GetBaseObject(System.Object)"> <summary> Get the base object. </summary> </member> <member name="T:PSRule.GitHelper"> <summary> Helper for working with Git and CI tools. </summary> <remarks> Docs for <seealso href="https://docs.microsoft.com/azure/devops/pipelines/build/variables">Azure Pipelines</seealso> and <seealso href="https://docs.github.com/actions/learn-github-actions/environment-variables#default-environment-variables">GitHub Actions</seealso>. </remarks> </member> <member name="M:PSRule.GitHelper.TryHeadRef(System.String@,System.String)"> <summary> The get HEAD ref. </summary> </member> <member name="M:PSRule.GitHelper.TryHeadBranch(System.String@,System.String)"> <summary> Get the HEAD branch name. </summary> </member> <member name="M:PSRule.GitHelper.TryBaseRef(System.String@,System.String)"> <summary> Get the target ref. </summary> </member> <member name="T:PSRule.PSObjectBaseConverter"> <summary> A base <seealso cref="T:System.Management.Automation.PSObject"/> converter. </summary> </member> <member name="M:PSRule.PSObjectBaseConverter.SkipComments(Newtonsoft.Json.JsonReader)"> <summary> Skip JSON comments. </summary> </member> <member name="T:PSRule.PSObjectJsonConverter"> <summary> A custom serializer to correctly convert PSObject properties to JSON instead of CLIXML. </summary> </member> <member name="M:PSRule.PSObjectJsonConverter.WriteFileSystemInfo(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary> Serialize a file system info object. </summary> </member> <member name="M:PSRule.PSObjectJsonConverter.WriteBaseObject(Newtonsoft.Json.JsonWriter,System.Management.Automation.PSObject,Newtonsoft.Json.JsonSerializer)"> <summary> Serialize the base object. </summary> </member> <member name="T:PSRule.PSObjectArrayJsonConverter"> <summary> A custom serializer to convert PSObjects that may or maynot be in a JSON array to an a PSObject array. </summary> </member> <member name="T:PSRule.ErrorCategoryJsonConverter"> <summary> A custom serializer to convert ErrorCategory to a string. </summary> </member> <member name="T:PSRule.BaselineJsonConverter"> <summary> A custom serializer to convert Baseline object to JSON </summary> </member> <member name="T:PSRule.OrderedPropertiesContractResolver"> <summary> A contract resolver to order properties alphabetically </summary> </member> <member name="T:PSRule.ResourceObjectJsonConverter"> <summary> A custom deserializer to convert JSON into a <see cref="T:PSRule.Definitions.ResourceObject"/>. </summary> </member> <member name="T:PSRule.FieldMapJsonConverter"> <summary> A JSON converter for de/serializing a field map. </summary> </member> <member name="M:PSRule.FieldMapJsonConverter.SkipComments(Newtonsoft.Json.JsonReader)"> <summary> Skip JSON comments. </summary> </member> <member name="T:PSRule.StringArrayJsonConverter"> <summary> A JSON converter that handles string to string array. </summary> </member> <member name="T:PSRule.LanguageExpressionJsonConverter"> <summary> A custom converter for deserializing JSON into a language expression. </summary> </member> <member name="M:PSRule.LanguageExpressionJsonConverter.MapOperator(System.String,PSRule.Definitions.Expressions.LanguageExpression.PropertyBag,PSRule.Definitions.Expressions.LanguageExpression,Newtonsoft.Json.JsonReader)"> <summary> Map an operator. </summary> </member> <member name="M:PSRule.JsonReaderExtensions.SkipComments(Newtonsoft.Json.JsonReader,System.Boolean@)"> <summary> Skip JSON comments. </summary> </member> <member name="T:PSRule.KeyMapDictionary`1"> <summary> A dictionary of key/ value pairs indexed by a string key that is case-insensitive. </summary> <typeparam name="TValue"></typeparam> </member> <member name="M:PSRule.KeyMapDictionary`1.#ctor"> <summary> Create an empty map. </summary> </member> <member name="M:PSRule.KeyMapDictionary`1.#ctor(PSRule.KeyMapDictionary{`0})"> <summary> Create a map intially populated with values copied from an existing instance. </summary> <param name="map">An existing instance to copy key/ values from.</param> <exception cref="T:System.ArgumentNullException">Is raised if the map is null.</exception> </member> <member name="M:PSRule.KeyMapDictionary`1.#ctor(System.Collections.Generic.IDictionary{System.String,`0})"> <summary> Create a map intially populated with values copied from a dictionary. </summary> <param name="dictionary">An existing dictionary to copy key/ values from.</param> </member> <member name="M:PSRule.KeyMapDictionary`1.#ctor(System.Collections.Hashtable)"> <summary> Create a map intially populated with values copied from a hashtable. </summary> <param name="hashtable">An existing hashtable to copy key/ values from.</param> </member> <member name="P:PSRule.KeyMapDictionary`1.Item(System.String)"> <inheritdoc/> </member> <member name="P:PSRule.KeyMapDictionary`1.Keys"> <inheritdoc/> </member> <member name="P:PSRule.KeyMapDictionary`1.Values"> <inheritdoc/> </member> <member name="P:PSRule.KeyMapDictionary`1.Count"> <inheritdoc/> </member> <member name="P:PSRule.KeyMapDictionary`1.IsReadOnly"> <inheritdoc/> </member> <member name="M:PSRule.KeyMapDictionary`1.Add(System.String,`0)"> <inheritdoc/> </member> <member name="M:PSRule.KeyMapDictionary`1.Add(System.Collections.Generic.KeyValuePair{System.String,`0})"> <inheritdoc/> </member> <member name="M:PSRule.KeyMapDictionary`1.Clear"> <summary> Clear the map of all keys and values. </summary> </member> <member name="M:PSRule.KeyMapDictionary`1.Contains(System.Collections.Generic.KeyValuePair{System.String,`0})"> <inheritdoc/> </member> <member name="M:PSRule.KeyMapDictionary`1.ContainsKey(System.String)"> <summary> Determines if a specified key exists in the map. </summary> <param name="key">The key map.</param> <returns></returns> </member> <member name="M:PSRule.KeyMapDictionary`1.CopyTo(System.Collections.Generic.KeyValuePair{System.String,`0}[],System.Int32)"> <inheritdoc/> </member> <member name="M:PSRule.KeyMapDictionary`1.GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.KeyMapDictionary`1.Remove(System.String)"> <summary> Remove the key/ value from the map by key. </summary> <param name="key">The key of the key/ value to remove.</param> <returns>Returns <c>true</c> if the element was found and removed.</returns> </member> <member name="M:PSRule.KeyMapDictionary`1.Remove(System.Collections.Generic.KeyValuePair{System.String,`0})"> <inheritdoc/> </member> <member name="M:PSRule.KeyMapDictionary`1.TryGetValue(System.String,`0@)"> <summary> Try to get the value from the specified key. </summary> <param name="key">The specific key to find in the map.</param> <param name="value">The value of the specific key.</param> <returns>Returns <c>true</c> if the key was found and <paramref name="value"/> returned.</returns> </member> <member name="M:PSRule.KeyMapDictionary`1.System#Collections#IEnumerable#GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.KeyMapDictionary`1.Load(System.Collections.Hashtable)"> <summary> Load options from a hashtable. </summary> <exception cref="T:System.ArgumentNullException">Is raised if the hashtable is null.</exception> </member> <member name="M:PSRule.KeyMapDictionary`1.Load(System.String,PSRule.EnvironmentHelper,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.KeyMapDictionary`1.Load(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})"> <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.KeyMapDictionary`1.TryKeyPrefix(System.String,System.String,System.String@)"> <summary> Try a key prefix. </summary> </member> <member name="M:PSRule.KeyMapDictionary`1.TryGetMember(System.Dynamic.GetMemberBinder,System.Object@)"> <summary> Get the value of a dynamic object member. </summary> <param name="binder">A dynamic binder object.</param> <param name="result">The value of the member.</param> <returns>Returns <c>true</c> if the member was found and <c>false</c> if the member was not.</returns> <exception cref="T:System.ArgumentNullException">Is raised if the binder is null.</exception> </member> <member name="M:PSRule.OutputOptionExtensions.GetEncoding(PSRule.Configuration.OutputOption)"> <summary> Get the character encoding for the specified output encoding. </summary> </member> <member name="M:PSRule.PSObjectExtensions.HasNoteProperty(System.Management.Automation.PSObject)"> <summary> Determines if the PSObject has any note properties. </summary> </member> <member name="T:PSRule.ReadOnlyHashtable"> <summary> Defined a readonly hashtable. </summary> </member> <member name="P:PSRule.ReadOnlyHashtable.IsReadOnly"> <inheritdoc/> </member> <member name="T:PSRule.SuppressionRuleYamlTypeConverter"> <summary> A YAML converter that allows short and full notation of suppression rules. </summary> </member> <member name="T:PSRule.FieldMapYamlTypeConverter"> <summary> A YAML converter for de/serializing a field map. </summary> </member> <member name="T:PSRule.StringArrayYamlTypeConverter"> <summary> A YAML converter that handles string to string array. </summary> </member> <member name="T:PSRule.PSObjectYamlTypeConverter"> <summary> A YAML converter to deserialize a map/ object as a PSObject. </summary> </member> <member name="T:PSRule.PSObjectYamlTypeResolver"> <summary> A YAML resolver to convert any dictionary types to PSObjects instead. </summary> </member> <member name="T:PSRule.OrderedPropertiesTypeInspector"> <summary> A YAML type inspector to order properties alphabetically </summary> </member> <member name="T:PSRule.FieldYamlTypeInspector"> <summary> A YAML type inspector to read fields and properties from a type for serialization. </summary> </member> <member name="T:PSRule.ResourceNodeDeserializer"> <summary> A custom deserializer to convert YAML into a <see cref="T:PSRule.Definitions.ResourceObject"/>. </summary> </member> <member name="T:PSRule.LanguageExpressionDeserializer"> <summary> A custom deserializer to convert YAML into a language expression. </summary> </member> <member name="M:PSRule.LanguageExpressionDeserializer.MapOperator(System.String,PSRule.Definitions.Expressions.LanguageExpression.PropertyBag,PSRule.Definitions.Expressions.LanguageExpression,YamlDotNet.Core.IParser,System.Func{YamlDotNet.Core.IParser,System.Type,System.Object})"> <summary> Map an operator. </summary> </member> <member name="T:PSRule.Configuration.BannerFormat"> <summary> The information displayed for Assert-PSRule banner. See <seealso href="https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputbanner">help</seealso>. </summary> </member> <member name="F:PSRule.Configuration.BannerFormat.None"> <summary> No banner is shown. </summary> </member> <member name="F:PSRule.Configuration.BannerFormat.Title"> <summary> The PSRule title ASCII text is shown. </summary> </member> <member name="F:PSRule.Configuration.BannerFormat.Source"> <summary> The rules module versions used in this run are shown. </summary> </member> <member name="F:PSRule.Configuration.BannerFormat.SupportLinks"> <summary> Supporting links for PSRule and rules modules are shown. </summary> </member> <member name="F:PSRule.Configuration.BannerFormat.RepositoryInfo"> <summary> Information about the repository where PSRule is being run from. </summary> </member> <member name="F:PSRule.Configuration.BannerFormat.Default"> <summary> The default information shown in the assert banner. </summary> </member> <member name="F:PSRule.Configuration.BannerFormat.Minimal"> <summary> A minimal set of information shown in the assert banner. </summary> </member> <member name="T:PSRule.Configuration.BaselineOption"> <summary> A subset of options that can be defined within a baseline. These options can be passes as a baseline for use within a pipeline. </summary> </member> <member name="M:PSRule.Configuration.BaselineOption.op_Implicit(System.Collections.Hashtable)~PSRule.Configuration.BaselineOption"> <summary> Creates a baseline option from a hashtable of key/ values. </summary> <param name="hashtable">A hashtable of key/ values.</param> <returns>A baseline option composed of provided key/ values.</returns> </member> <member name="M:PSRule.Configuration.BaselineOption.op_Implicit(System.String)~PSRule.Configuration.BaselineOption"> <summary> Creates a reference to a baseline by name which is resolved at runtime. </summary> <param name="value">The name of the baseline.</param> <returns>A reference to a baseline option.</returns> </member> <member name="M:PSRule.Configuration.BaselineOption.FromHashtable(System.Collections.Hashtable)"> <summary> Creates a baseline option from a hashtable of key/ values. </summary> <param name="hashtable">A hashtable of key/ values.</param> <returns>A baseline option composed of provided key/ values.</returns> </member> <member name="M:PSRule.Configuration.BaselineOption.FromString(System.String)"> <summary> Creates a reference to a baseline by name which is resolved at runtime. </summary> <param name="value">The name of the baseline.</param> <returns>A reference to a baseline option.</returns> </member> <member name="M:PSRule.Configuration.BaselineOption.Load(PSRule.Definitions.Baselines.IBaselineV1Spec,System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Load matching values </summary> <param name="option">A baseline options object to load.</param> <param name="properties">One or more indexed properties.</param> </member> <member name="T:PSRule.Configuration.BindingOption"> <summary> Options that affect property binding of TargetName and TargetType. </summary> </member> <member name="M:PSRule.Configuration.BindingOption.#ctor"> <summary> Creates an empty binding option. </summary> </member> <member name="M:PSRule.Configuration.BindingOption.#ctor(PSRule.Configuration.BindingOption)"> <summary> Creates a binding option by copying an existing instance. </summary> <param name="option">The option instance to copy.</param> </member> <member name="M:PSRule.Configuration.BindingOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.BindingOption.Equals(PSRule.Configuration.BindingOption)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.BindingOption.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.BindingOption.Combine(PSRule.Configuration.BindingOption,PSRule.Configuration.BindingOption)"> <summary> Merge two option instances by repacing 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.Configuration.BindingOption.Field"> <summary> One or more custom fields to bind. </summary> </member> <member name="P:PSRule.Configuration.BindingOption.IgnoreCase"> <summary> Determines if custom binding uses ignores case when matching properties. </summary> </member> <member name="P:PSRule.Configuration.BindingOption.NameSeparator"> <summary> Configures the separator to use for building a qualified name. </summary> </member> <member name="P:PSRule.Configuration.BindingOption.PreferTargetInfo"> <summary> Determines if binding prefers target info provided by the object over custom configuration. </summary> </member> <member name="P:PSRule.Configuration.BindingOption.TargetName"> <summary> Property names to use to bind TargetName. </summary> </member> <member name="P:PSRule.Configuration.BindingOption.TargetType"> <summary> Property names to use to bind TargetType. </summary> </member> <member name="P:PSRule.Configuration.BindingOption.UseQualifiedName"> <summary> Determines if a qualified TargetName is used. </summary> </member> <member name="T:PSRule.Configuration.ConfigurationOption"> <summary> A set of configuration values that can be used within rule definitions. </summary> </member> <member name="M:PSRule.Configuration.ConfigurationOption.#ctor"> <summary> Creates an empty configuration option. </summary> </member> <member name="M:PSRule.Configuration.ConfigurationOption.#ctor(PSRule.Configuration.ConfigurationOption)"> <summary> Creates a configuration option by copying an existing instance. </summary> <param name="option">The option instance to copy.</param> </member> <member name="M:PSRule.Configuration.ConfigurationOption.#ctor(System.Collections.Hashtable)"> <summary> Creates a configuration option from a hashtable. </summary> </member> <member name="M:PSRule.Configuration.ConfigurationOption.op_Implicit(System.Collections.Hashtable)~PSRule.Configuration.ConfigurationOption"> <summary> Convert a hashtable (commonly used in PowerShell) to a configuration option. </summary> <param name="hashtable">The hashtable to convert.</param> </member> <member name="M:PSRule.Configuration.ConfigurationOption.Combine(PSRule.Configuration.ConfigurationOption,PSRule.Configuration.ConfigurationOption)"> <summary> Merge two option instances by repacing 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.Configuration.ConfigurationOption.Load(PSRule.EnvironmentHelper)"> <summary> Load values from environment variables into the configuration option. Keys that appear in both will replaced by environment variable values. </summary> </member> <member name="M:PSRule.Configuration.ConfigurationOption.Load(System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Load values from a key/ value dictionary into the configuration option. Keys that appear in both will replaced by dictionary values. </summary> </member> <member name="T:PSRule.Configuration.ConventionOption"> <summary> Options that configure conventions. </summary> </member> <member name="M:PSRule.Configuration.ConventionOption.#ctor"> <summary> Creates an empty convention option. </summary> </member> <member name="M:PSRule.Configuration.ConventionOption.#ctor(PSRule.Configuration.ConventionOption)"> <summary> Creates a convertion option by copying an existing instance. </summary> <param name="option">The option instance to copy.</param> </member> <member name="M:PSRule.Configuration.ConventionOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.ConventionOption.Equals(PSRule.Configuration.ConventionOption)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.ConventionOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Configuration.ConventionOption.Include"> <summary> Conventions by name to use when executing PSRule. </summary> </member> <member name="T:PSRule.Configuration.ExecutionActionPreference"> <summary> Determines the action to take for execution behaviors. See <see cref="T:PSRule.Configuration.ExecutionOption"/> for the specific behaviors that are configurable. </summary> </member> <member name="F:PSRule.Configuration.ExecutionActionPreference.None"> <summary> No preference. This will inherit from the default. </summary> </member> <member name="F:PSRule.Configuration.ExecutionActionPreference.Ignore"> <summary> Continue to execute silently. </summary> </member> <member name="F:PSRule.Configuration.ExecutionActionPreference.Warn"> <summary> Continue to execute but log a warning. </summary> </member> <member name="F:PSRule.Configuration.ExecutionActionPreference.Error"> <summary> Generate an error. </summary> </member> <member name="T:PSRule.Configuration.ExecutionOption"> <summary> Options that configure the execution sandbox. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </member> <member name="M:PSRule.Configuration.ExecutionOption.#ctor"> <summary> Creates an empty execution option. </summary> </member> <member name="M:PSRule.Configuration.ExecutionOption.#ctor(PSRule.Configuration.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.Configuration.ExecutionOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.ExecutionOption.Equals(PSRule.Configuration.ExecutionOption)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.ExecutionOption.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.ExecutionOption.Combine(PSRule.Configuration.ExecutionOption,PSRule.Configuration.ExecutionOption)"> <summary> Merge two option instances by repacing 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.Configuration.ExecutionOption.AliasReferenceWarning"> <summary> Determines if a warning is raised when an alias to a resource is used. </summary> </member> <member name="P:PSRule.Configuration.ExecutionOption.DuplicateResourceId"> <summary> Determines how to handle duplicate resources identifiers during execution. Regardless of the value, only the first resource will be used. By defaut, an error is thrown. When set to Warn, a warning is generated. When set to Ignore, no output will be displayed. </summary> </member> <member name="P:PSRule.Configuration.ExecutionOption.LanguageMode"> <summary> The langauge mode to execute PowerShell code with. </summary> </member> <member name="P:PSRule.Configuration.ExecutionOption.InconclusiveWarning"> <summary> Determines if a warning is raised when a rule does not return pass or fail. </summary> </member> <member name="P:PSRule.Configuration.ExecutionOption.NotProcessedWarning"> <summary> Determines if a warning is raised when an object is not processed by any rule. </summary> </member> <member name="P:PSRule.Configuration.ExecutionOption.SuppressedRuleWarning"> <summary> Determines if a warning is raised when a rule is suppressed. </summary> </member> <member name="P:PSRule.Configuration.ExecutionOption.InvariantCultureWarning"> <summary> Determines if warning is raised when invariant culture is used. </summary> </member> <member name="P:PSRule.Configuration.ExecutionOption.InitialSessionState"> <summary> Determines how the initial session state for executing PowerShell code is created. The default is <see cref="F:PSRule.Configuration.SessionState.BuiltIn"/>. </summary> </member> <member name="T:PSRule.Configuration.FieldMap"> <summary> A mapping of fields to property names. </summary> </member> <member name="T:PSRule.Configuration.FooterFormat"> <summary> The information displayed for Assert-PSRule footer. </summary> </member> <member name="F:PSRule.Configuration.FooterFormat.None"> <summary> No footer is shown. </summary> </member> <member name="F:PSRule.Configuration.FooterFormat.RuleCount"> <summary> A summary of rules processed. </summary> </member> <member name="F:PSRule.Configuration.FooterFormat.RunInfo"> <summary> Information about the run. </summary> </member> <member name="F:PSRule.Configuration.FooterFormat.OutputFile"> <summary> Information about the output file if an output path is set. </summary> </member> <member name="F:PSRule.Configuration.FooterFormat.Default"> <summary> The default footer output. </summary> </member> <member name="T:PSRule.Configuration.IncludeOption"> <summary> Options that affect source locations imported for execution. </summary> </member> <member name="M:PSRule.Configuration.IncludeOption.#ctor"> <summary> Create an empty include option. </summary> </member> <member name="M:PSRule.Configuration.IncludeOption.#ctor(PSRule.Configuration.IncludeOption)"> <summary> Create an include option by copying an existing instance. </summary> <param name="option">The option instance to copy.</param> </member> <member name="M:PSRule.Configuration.IncludeOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.IncludeOption.Equals(PSRule.Configuration.IncludeOption)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.IncludeOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Configuration.IncludeOption.Path"> <summary> Include additional module sources. </summary> </member> <member name="P:PSRule.Configuration.IncludeOption.Module"> <summary> Include additional standalone sources. </summary> </member> <member name="T:PSRule.Configuration.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.Configuration.InputFormat.None"> <summary> Treat strings as plain text and do not deserialize files. </summary> </member> <member name="F:PSRule.Configuration.InputFormat.Yaml"> <summary> Deserialize as one or more YAML objects. </summary> </member> <member name="F:PSRule.Configuration.InputFormat.Json"> <summary> Deserialize as one or more JSON objects. </summary> </member> <member name="F:PSRule.Configuration.InputFormat.Markdown"> <summary> Deserialize as a markdown object. </summary> </member> <member name="F:PSRule.Configuration.InputFormat.PowerShellData"> <summary> Deserialize as a PowerShell data object. </summary> </member> <member name="F:PSRule.Configuration.InputFormat.File"> <summary> Files are treated as objects and not deserialized. </summary> </member> <member name="F:PSRule.Configuration.InputFormat.Detect"> <summary> Detect format based on file extension. This is the default. </summary> </member> <member name="T:PSRule.Configuration.InputOption"> <summary> Options that affect how input types are processed. </summary> </member> <member name="M:PSRule.Configuration.InputOption.#ctor"> <summary> Creates an empty input option. </summary> </member> <member name="M:PSRule.Configuration.InputOption.#ctor(PSRule.Configuration.InputOption)"> <summary> Creates a input option by copying an existing instance. </summary> <param name="option">The option instance to copy.</param> </member> <member name="M:PSRule.Configuration.InputOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.InputOption.Equals(PSRule.Configuration.InputOption)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.InputOption.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.InputOption.Combine(PSRule.Configuration.InputOption,PSRule.Configuration.InputOption)"> <summary> Merge two option instances by repacing 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.Configuration.InputOption.Format"> <summary> The input string format. </summary> </member> <member name="P:PSRule.Configuration.InputOption.IgnoreGitPath"> <summary> Determine if files within the .git path are ignored. </summary> </member> <member name="P:PSRule.Configuration.InputOption.IgnoreObjectSource"> <summary> Determines if objects are ignored based on their file source path. </summary> </member> <member name="P:PSRule.Configuration.InputOption.IgnoreRepositoryCommon"> <summary> Determine if common repository files are ignored. </summary> </member> <member name="P:PSRule.Configuration.InputOption.IgnoreUnchangedPath"> <summary> Determine if unchanged files are ignored. </summary> </member> <member name="P:PSRule.Configuration.InputOption.ObjectPath"> <summary> The object path to a property to use instead of the pipeline object. </summary> </member> <member name="P:PSRule.Configuration.InputOption.PathIgnore"> <summary> Ignores input files that match the path spec. </summary> </member> <member name="P:PSRule.Configuration.InputOption.TargetType"> <summary> Only process objects that match one of the included types. </summary> </member> <member name="T:PSRule.Configuration.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.Configuration.LanguageMode.FullLanguage"> <summary> PowerShell code executes unconstrained. </summary> </member> <member name="F:PSRule.Configuration.LanguageMode.ConstrainedLanguage"> <summary> PowerShell code executes in constrained language mode that restricts the types and methods that can be used. </summary> </member> <member name="T:PSRule.Configuration.LoggingOption"> <summary> Options for logging outcomes to a informational streams. </summary> </member> <member name="M:PSRule.Configuration.LoggingOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.LoggingOption.Equals(PSRule.Configuration.LoggingOption)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.LoggingOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Configuration.LoggingOption.LimitDebug"> <summary> Limits debug messages to a list of named debug scopes. </summary> </member> <member name="P:PSRule.Configuration.LoggingOption.LimitVerbose"> <summary> Limits verbose messages to a list of named verbose scopes. </summary> </member> <member name="P:PSRule.Configuration.LoggingOption.RuleFail"> <summary> Log fail outcomes for each rule to a specific informational stream. </summary> </member> <member name="P:PSRule.Configuration.LoggingOption.RulePass"> <summary> Log pass outcomes for each rule to a specific informational stream. </summary> </member> <member name="T:PSRule.Configuration.OutcomeLogStream"> <summary> The PowerShell informational stream to log specific outcomes to. </summary> </member> <member name="F:PSRule.Configuration.OutcomeLogStream.None"> <summary> Outcomes will not be logged to an informational stream. </summary> </member> <member name="F:PSRule.Configuration.OutcomeLogStream.Error"> <summary> Log to Error stream. </summary> </member> <member name="F:PSRule.Configuration.OutcomeLogStream.Warning"> <summary> Log to Warning stream. </summary> </member> <member name="F:PSRule.Configuration.OutcomeLogStream.Information"> <summary> Log to Information stream. </summary> </member> <member name="T:PSRule.Configuration.OutputEncoding"> <summary> The encoding format to convert output to. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Options/#outputencoding"/> </summary> </member> <member name="F:PSRule.Configuration.OutputEncoding.Default"> <summary> UTF-8 with Byte Order Mark (BOM). This is the default. </summary> </member> <member name="F:PSRule.Configuration.OutputEncoding.UTF8"> <summary> UTF-8 without Byte Order Mark (BOM). </summary> </member> <member name="F:PSRule.Configuration.OutputEncoding.UTF7"> <summary> UTF-7. </summary> </member> <member name="F:PSRule.Configuration.OutputEncoding.Unicode"> <summary> Unicode. Same as UTF-16. </summary> </member> <member name="F:PSRule.Configuration.OutputEncoding.UTF32"> <summary> UTF-32. </summary> </member> <member name="F:PSRule.Configuration.OutputEncoding.ASCII"> <summary> ASCII. </summary> </member> <member name="T:PSRule.Configuration.OutputFormat"> <summary> The formats to return results in. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Options/#outputformat"/> </summary> </member> <member name="F:PSRule.Configuration.OutputFormat.None"> <summary> Output is presented as an object using PowerShell defaults. This is the default. </summary> </member> <member name="F:PSRule.Configuration.OutputFormat.Yaml"> <summary> Output is serialized as YAML. </summary> </member> <member name="F:PSRule.Configuration.OutputFormat.Json"> <summary> Output is serialized as JSON. </summary> </member> <member name="F:PSRule.Configuration.OutputFormat.NUnit3"> <summary> Output is serialized as NUnit3 (XML). </summary> </member> <member name="F:PSRule.Configuration.OutputFormat.Csv"> <summary> Output is serialized as a comma-separated values (CSV). </summary> </member> <member name="F:PSRule.Configuration.OutputFormat.Wide"> <summary> Output is presented using the wide table format, which includes reason and wraps columns. </summary> </member> <member name="F:PSRule.Configuration.OutputFormat.Markdown"> <summary> Output is serialized as Markdown. </summary> </member> <member name="F:PSRule.Configuration.OutputFormat.Sarif"> <summary> Output is serialized as SARIF. </summary> </member> <member name="T:PSRule.Configuration.OutputOption"> <summary> Options for generating and formatting output. </summary> </member> <member name="M:PSRule.Configuration.OutputOption.#ctor"> <summary> Creates an empty output option. </summary> </member> <member name="M:PSRule.Configuration.OutputOption.#ctor(PSRule.Configuration.OutputOption)"> <summary> Creates a output option by copying an existing instance. </summary> <param name="option">The option instance to copy.</param> </member> <member name="M:PSRule.Configuration.OutputOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.OutputOption.Equals(PSRule.Configuration.OutputOption)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.OutputOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Configuration.OutputOption.As"> <summary> The type of result to produce. </summary> </member> <member name="P:PSRule.Configuration.OutputOption.Banner"> <summary> The information displayed for Assert-PSRule banner. </summary> </member> <member name="P:PSRule.Configuration.OutputOption.Culture"> <summary> One or more cultures to use for generating output. </summary> </member> <member name="P:PSRule.Configuration.OutputOption.Encoding"> <summary> The encoding to use when writing results to file. </summary> </member> <member name="P:PSRule.Configuration.OutputOption.Footer"> <summary> The information displayed for Assert-PSRule footer. </summary> </member> <member name="P:PSRule.Configuration.OutputOption.Format"> <summary> The output format. </summary> </member> <member name="P:PSRule.Configuration.OutputOption.Outcome"> <summary> The outcome of rule results to return. </summary> </member> <member name="P:PSRule.Configuration.OutputOption.Path"> <summary> The file path location to save results. </summary> </member> <member name="P:PSRule.Configuration.OutputOption.Style"> <summary> The style that results will be presented in. </summary> </member> <member name="P:PSRule.Configuration.OutputOption.JsonIndent"> <summary> The indentation for JSON output </summary> </member> <member name="P:PSRule.Configuration.OutputOption.SarifProblemsOnly"> <summary> Determines if SARIF output only includes rules with fail or error outcomes. </summary> </member> <member name="T:PSRule.Configuration.OutputStyle"> <summary> The style to present assert output in. </summary> </member> <member name="F:PSRule.Configuration.OutputStyle.Client"> <summary> Formatted text written to host. </summary> </member> <member name="F:PSRule.Configuration.OutputStyle.Plain"> <summary> Plain text written to output stream. </summary> </member> <member name="F:PSRule.Configuration.OutputStyle.AzurePipelines"> <summary> Text written to output stream, with fails marked for Azure Pipelines. </summary> </member> <member name="F:PSRule.Configuration.OutputStyle.GitHubActions"> <summary> Text written to output stream, with fails marked for GitHub Actions. </summary> </member> <member name="F:PSRule.Configuration.OutputStyle.VisualStudioCode"> <summary> Text is written to output stream formatted for Visual Studio Code. </summary> </member> <member name="F:PSRule.Configuration.OutputStyle.Detect"> <summary> Automatically detect the style to use. </summary> </member> <member name="T:PSRule.Configuration.BindTargetName"> <summary> Used by custom binding functions. </summary> </member> <member name="T:PSRule.Configuration.PipelineHook"> <summary> Hooks that provide customize pipeline execution. </summary> </member> <member name="M:PSRule.Configuration.PipelineHook.#ctor"> <summary> Create an empty set of pipeline hooks. </summary> </member> <member name="M:PSRule.Configuration.PipelineHook.#ctor(PSRule.Configuration.PipelineHook)"> <summary> Create pipeline hooks based on an existing option instance. </summary> <param name="option">An existing pipeline hook option.</param> </member> <member name="P:PSRule.Configuration.PipelineHook.BindTargetName"> <summary> One or more custom functions to use to bind TargetName of a pipeline object. </summary> </member> <member name="P:PSRule.Configuration.PipelineHook.BindTargetType"> <summary> One or more custom functions to use to bind TargetType of a pipeline object. </summary> </member> <member name="T:PSRule.Configuration.PathDelegate"> <summary> A delgate to allow callback to PowerShell to get current working path. </summary> </member> <member name="T:PSRule.Configuration.PSRuleOption"> <summary> A structure that stores PSRule configuration options. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options"/>. </remarks> </member> <member name="F:PSRule.Configuration.PSRuleOption._SourcePath"> <summary> The original source path the options were loaded from if applicable. </summary> </member> <member name="F:PSRule.Configuration.PSRuleOption._GetWorkingPath"> <summary> A callback that is overridden by PowerShell so that the current working path can be retrieved. </summary> </member> <member name="F:PSRule.Configuration.PSRuleOption._CurrentCulture"> <summary> Sets the current culture to use when processing rules unless otherwise specified. </summary> </member> <member name="M:PSRule.Configuration.PSRuleOption.#ctor"> <summary> Create an empty PSRule options object. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Binding"> <summary> Options that affect property binding. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Configuration"> <summary> Allows configuration key/ values to be specified that can be used within rule definitions. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Convention"> <summary> Options that configure conventions. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Execution"> <summary> Options that configure the execution sandbox. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Include"> <summary> Options that affect source locations imported for execution. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Input"> <summary> Options that affect how input types are processed. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Logging"> <summary> Options for logging outcomes to a informational streams. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Output"> <summary> Options that affect how output is generated. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Pipeline"> <summary> Configures pipeline hooks. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Repository"> <summary> Options for repository properties that are used by PSRule. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Requires"> <summary> Specifies the required version of a module to use. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Rule"> <summary> Options for that affect which rules are executed by including and filtering discovered rules. </summary> </member> <member name="P:PSRule.Configuration.PSRuleOption.Suppression"> <summary> A set of suppression rules. </summary> </member> <member name="M:PSRule.Configuration.PSRuleOption.ToYaml"> <summary> Return options as YAML. </summary> <returns>PSRule options serialized as YAML.</returns> <remarks> Called from PowerShell. </remarks> </member> <member name="M:PSRule.Configuration.PSRuleOption.Clone"> <summary> Create a new object instance with the same options set. </summary> <returns>A new <see cref="T:PSRule.Configuration.PSRuleOption"/> instance.</returns> </member> <member name="M:PSRule.Configuration.PSRuleOption.FromDefault"> <summary> Create a <see cref="T:PSRule.Configuration.PSRuleOption"/> instance from PSRule defaults. </summary> <returns>A new <see cref="T:PSRule.Configuration.PSRuleOption"/> instance.</returns> </member> <member name="M:PSRule.Configuration.PSRuleOption.Combine(PSRule.Configuration.PSRuleOption,PSRule.Configuration.PSRuleOption)"> <summary> Merge two option instances by repacing any unset properties from <paramref name="o1"/> with <paramref name="o2"/> values. Values from <paramref name="o1"/> that are set are not overridden. </summary> <returns>A new <see cref="T:PSRule.Configuration.PSRuleOption"/> instance combining options from both instances.</returns> </member> <member name="M:PSRule.Configuration.PSRuleOption.ToFile(System.String)"> <summary> Save the PSRuleOption to disk as YAML. </summary> <param name="path">The file or directory path to save the YAML file.</param> </member> <member name="M:PSRule.Configuration.PSRuleOption.FromFile(System.String)"> <summary> Load a YAML formatted PSRuleOption object from disk. </summary> <param name="path">A file or directory to read options from.</param> <returns>An options object.</returns> <remarks> This method is called from PowerShell. </remarks> </member> <member name="M:PSRule.Configuration.PSRuleOption.FromFileOrEmpty(System.String)"> <summary> Load a YAML formatted PSRuleOption object from disk. </summary> <param name="path">A file or directory to read options from.</param> <returns>An options object.</returns> <remarks> This method is called from PowerShell. </remarks> </member> <member name="M:PSRule.Configuration.PSRuleOption.FromFileOrEmpty"> <summary> Load a YAML formatted PSRuleOption object from disk. </summary> <returns>An options object.</returns> <remarks> This method is called from PowerShell. </remarks> </member> <member name="M:PSRule.Configuration.PSRuleOption.FromFileOrEmpty(PSRule.Configuration.PSRuleOption,System.String)"> <summary> Load a YAML formatted PSRuleOption object from disk. </summary> <param name="option"></param> <param name="path">A file or directory to read options from.</param> <returns>An options object.</returns> <remarks> This method is called from PowerShell. </remarks> </member> <member name="M:PSRule.Configuration.PSRuleOption.FromEnvironment(PSRule.Configuration.PSRuleOption)"> <summary> Read PSRule options from environment variables. </summary> <param name="option">An existing options object to set. If <c>null</c> an empty options object is used.</param> <returns>An options object.</returns> <remarks> Any environment variables that are set will override options set in the specified <paramref name="option"/> object. </remarks> </member> <member name="M:PSRule.Configuration.PSRuleOption.FromHashtable(System.Collections.Hashtable)"> <summary> Read PSRule options from a hashtable. </summary> <param name="hashtable">A hashtable to read options from.</param> <returns>An options object.</returns> <remarks> A null or empty hashtable will return an empty options object. </remarks> </member> <member name="M:PSRule.Configuration.PSRuleOption.UseExecutionContext(System.Management.Automation.EngineIntrinsics)"> <summary> Set working path from PowerShell host environment. </summary> <param name="executionContext">An $ExecutionContext object.</param> <remarks> Called from PowerShell. </remarks> </member> <member name="M:PSRule.Configuration.PSRuleOption.UseCurrentCulture"> <summary> Configures PSRule to use the culture of the current thread at runtime. </summary> </member> <member name="M:PSRule.Configuration.PSRuleOption.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.Configuration.PSRuleOption.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.Configuration.PSRuleOption.GetWorkingPath"> <summary> Gets the current working path being used by PSRule. </summary> <returns>The current working path.</returns> </member> <member name="M:PSRule.Configuration.PSRuleOption.GetCurrentCulture"> <summary> Get the current culture being used by PSRule. </summary> <returns>The current culture.</returns> </member> <member name="M:PSRule.Configuration.PSRuleOption.op_Implicit(System.Collections.Hashtable)~PSRule.Configuration.PSRuleOption"> <summary> Convert from hashtable to options by processing key values. This enables -Option @{ } from PowerShell. </summary> <param name="hashtable">A hashtable to read options from.</param> <returns>An options object.</returns> </member> <member name="M:PSRule.Configuration.PSRuleOption.op_Implicit(System.String)~PSRule.Configuration.PSRuleOption"> <summary> Convert from string to options by loading the yaml file from disk. This enables -Option '.\ps-rule.yaml' from PowerShell. </summary> <param name="path">A file or directory to read options from.</param> <returns>An options object.</returns> </member> <member name="M:PSRule.Configuration.PSRuleOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.PSRuleOption.Equals(PSRule.Configuration.PSRuleOption)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.PSRuleOption.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.PSRuleOption.GetFilePath(System.String)"> <summary> Get a fully qualified file path. </summary> <param name="path">A file or directory path.</param> <returns></returns> </member> <member name="M:PSRule.Configuration.PSRuleOption.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.Configuration.PSRuleOption.GetRootedBasePath(System.String,System.Boolean)"> <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> <returns>A absolute base path.</returns> <remarks> A base path always includes a trailing <c>/</c>. </remarks> </member> <member name="M:PSRule.Configuration.PSRuleOption.BuildIndex(System.Collections.Hashtable)"> <summary> Build index to allow mapping values. </summary> </member> <member name="M:PSRule.Configuration.PSRuleOption.IsCaseSentitive"> <summary> Determines if the working path file system is case sensitive. </summary> </member> <member name="M:PSRule.Configuration.PSRuleOption.UseFilePath(System.String,System.String)"> <summary> Determine if the combined file path is exists. </summary> <param name="path">A directory path where a options file may be stored.</param> <param name="name">A file name of an options file.</param> <returns>Returns a file path if the file exists or null if the file does not exist.</returns> </member> <member name="T:PSRule.Configuration.RepositoryOption"> <summary> Options for repository properties that are used by PSRule. </summary> </member> <member name="M:PSRule.Configuration.RepositoryOption.#ctor"> <summary> Create an empty repository option. </summary> </member> <member name="M:PSRule.Configuration.RepositoryOption.#ctor(PSRule.Configuration.RepositoryOption)"> <summary> Create a repository option by copying an existing instance. </summary> <param name="option">The option instance to copy.</param> </member> <member name="M:PSRule.Configuration.RepositoryOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.RepositoryOption.Equals(PSRule.Configuration.RepositoryOption)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.RepositoryOption.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.RepositoryOption.Combine(PSRule.Configuration.RepositoryOption,PSRule.Configuration.RepositoryOption)"> <summary> Merge two option instances by repacing 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.Configuration.RepositoryOption.BaseRef"> <summary> Sets the repository base ref used for comparisons of changed files. </summary> </member> <member name="P:PSRule.Configuration.RepositoryOption.Url"> <summary> Configures the repository URL to report in output. </summary> </member> <member name="M:PSRule.Configuration.RepositoryOption.Load(PSRule.EnvironmentHelper)"> <summary> Load options from environment variables into repository option. Options that appear in both will replaced by environment variable values. </summary> </member> <member name="M:PSRule.Configuration.RepositoryOption.Load(System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Load options from a key/ value dictionary into the repository options. Options that appear in both will replaced by dictionary values. </summary> </member> <member name="T:PSRule.Configuration.RequiresOption"> <summary> Specifies module version constraints for running PSRule. When set, PSRule will error if a module version is used that does not satisfy the requirements. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Options/#requires"/> </summary> </member> <member name="M:PSRule.Configuration.RequiresOption.#ctor"> <summary> Creates an empty requires option. </summary> </member> <member name="M:PSRule.Configuration.RequiresOption.#ctor(PSRule.Configuration.RequiresOption)"> <summary> Creates a requires option by copying an existing instance. </summary> <param name="option">The option instance to copy.</param> </member> <member name="M:PSRule.Configuration.RequiresOption.ToArray"> <summary> Returns an array of Key/Values. </summary> </member> <member name="M:PSRule.Configuration.RequiresOption.Load(PSRule.EnvironmentHelper)"> <summary> Load Requires option from environment variables. </summary> </member> <member name="M:PSRule.Configuration.RequiresOption.Load(System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Load Requires option from a dictionary. </summary> </member> <member name="M:PSRule.Configuration.RequiresOption.ConvertUnderscore(System.String)"> <summary> Convert module names with underscores to dots. </summary> </member> <member name="T:PSRule.Configuration.ResultFormat"> <summary> The format to return to the pipeline after executing rules. See <seealso href="https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputas">help</seealso>. </summary> </member> <member name="F:PSRule.Configuration.ResultFormat.Detail"> <summary> Return a record per rule per object. </summary> </member> <member name="F:PSRule.Configuration.ResultFormat.Summary"> <summary> Return summary results. </summary> </member> <member name="T:PSRule.Configuration.RuleOption"> <summary> Options for that affect which rules are executed by including and filtering discovered rules. </summary> </member> <member name="M:PSRule.Configuration.RuleOption.#ctor"> <summary> Create an empty rule option. </summary> </member> <member name="M:PSRule.Configuration.RuleOption.#ctor(PSRule.Configuration.RuleOption)"> <summary> Create a rule option by copying an existing instance. </summary> <param name="option">The option instance to copy.</param> </member> <member name="M:PSRule.Configuration.RuleOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.RuleOption.Equals(PSRule.Configuration.RuleOption)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.RuleOption.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.RuleOption.Combine(PSRule.Configuration.RuleOption,PSRule.Configuration.RuleOption)"> <summary> Merge two option instances by repacing 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.Configuration.RuleOption.Baseline"> <summary> The name of a baseline to use. </summary> </member> <member name="P:PSRule.Configuration.RuleOption.Exclude"> <summary> A set of rules to exclude for execution. </summary> </member> <member name="P:PSRule.Configuration.RuleOption.IncludeLocal"> <summary> Automatically include all local rules in the search path unless they have been explicitly excluded. </summary> </member> <member name="P:PSRule.Configuration.RuleOption.Include"> <summary> A set of rules to include for execution. </summary> </member> <member name="P:PSRule.Configuration.RuleOption.Tag"> <summary> A set of rule tags to include for execution. </summary> </member> <member name="P:PSRule.Configuration.RuleOption.Labels"> <summary> A set of taxonomy references. </summary> </member> <member name="T:PSRule.Configuration.SessionState"> <summary> Configures how the initial PowerShell sandbox for executing rules is created. </summary> </member> <member name="F:PSRule.Configuration.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.Configuration.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.Configuration.SuppressionOption"> <summary> Options that affect rule suppression during execution. </summary> </member> <member name="M:PSRule.Configuration.SuppressionOption.#ctor"> <summary> Creates an empty suppression option. </summary> </member> <member name="M:PSRule.Configuration.SuppressionOption.#ctor(System.Collections.Generic.IDictionary{System.String,PSRule.Configuration.SuppressionRule})"> <summary> Creates a suppression option by loading <see cref="T:PSRule.Configuration.SuppressionRule"/> from a dictionary. </summary> <param name="rules">A dictionary of <see cref="T:PSRule.Configuration.SuppressionRule"/>.</param> </member> <member name="P:PSRule.Configuration.SuppressionOption.Item(System.String)"> <summary> Get a <see cref="T:PSRule.Configuration.SuppressionRule"/> indexed by rule name. </summary> <param name="key">The name of the rule.</param> <returns>A matching <see cref="T:PSRule.Configuration.SuppressionRule"/>.</returns> </member> <member name="P:PSRule.Configuration.SuppressionOption.Keys"> <inheritdoc/> </member> <member name="P:PSRule.Configuration.SuppressionOption.Values"> <inheritdoc/> </member> <member name="P:PSRule.Configuration.SuppressionOption.Count"> <inheritdoc/> </member> <member name="P:PSRule.Configuration.SuppressionOption.IsReadOnly"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.SuppressionOption.Add(System.String,PSRule.Configuration.SuppressionRule)"> <summary> Add a suppression rule to the option by rule name. </summary> <param name="key">The name of the rule to apply the suppression rule to.</param> <param name="value">A <see cref="T:PSRule.Configuration.SuppressionRule"/> to map to the rule.</param> </member> <member name="M:PSRule.Configuration.SuppressionOption.Add(System.Collections.Generic.KeyValuePair{System.String,PSRule.Configuration.SuppressionRule})"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.SuppressionOption.Clear"> <summary> Clear all suppression rules. </summary> </member> <member name="M:PSRule.Configuration.SuppressionOption.Contains(System.Collections.Generic.KeyValuePair{System.String,PSRule.Configuration.SuppressionRule})"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.SuppressionOption.ContainsKey(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.SuppressionOption.CopyTo(System.Collections.Generic.KeyValuePair{System.String,PSRule.Configuration.SuppressionRule}[],System.Int32)"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.SuppressionOption.GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.SuppressionOption.Remove(System.String)"> <summary> Remove a specific <see cref="T:PSRule.Configuration.SuppressionRule"/> by rule name. </summary> <param name="key">The name of the rule.</param> <returns>Returns <c>true</c> if the element was found and removed.</returns> </member> <member name="M:PSRule.Configuration.SuppressionOption.Remove(System.Collections.Generic.KeyValuePair{System.String,PSRule.Configuration.SuppressionRule})"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.SuppressionOption.TryGetValue(System.String,PSRule.Configuration.SuppressionRule@)"> <summary> Try to get a <see cref="T:PSRule.Configuration.SuppressionRule"/> from the specified rule name. </summary> <param name="key">The name of the rule.</param> <param name="value">A <see cref="T:PSRule.Configuration.SuppressionRule"/> if any match the specified rule name.</param> <returns>Returns <c>true</c> if the key was found and <paramref name="value"/> returned.</returns> </member> <member name="M:PSRule.Configuration.SuppressionOption.System#Collections#IEnumerable#GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.Configuration.SuppressionOption.op_Implicit(System.Collections.Hashtable)~PSRule.Configuration.SuppressionOption"> <summary> Convert a hashtable to suppression options. </summary> <param name="hashtable">A hashtable of <see cref="T:PSRule.Configuration.SuppressionRule"/> indexed by rule name.</param> </member> <member name="T:PSRule.Configuration.SuppressionRule"> <summary> A suppression rule, that specifies TargetNames that will not be processed by individual rules. </summary> </member> <member name="P:PSRule.Configuration.SuppressionRule.TargetName"> <summary> One of more target names to suppress. </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.IInputFileInfoCollection"> <summary> A collection of <see cref="T:PSRule.Data.InputFileInfo"/>. </summary> </member> <member name="M:PSRule.Data.IInputFileInfoCollection.WithExtension(System.String)"> <summary> Filters the collection to only include <see cref="T:PSRule.Data.InputFileInfo"/> with a specific file extension. </summary> <param name="extension">A file extension to filter the collection to.</param> <returns>A filtered collection.</returns> </member> <member name="T:PSRule.Data.InputFileInfoCollection"> <summary> A collection of <see cref="T:PSRule.Data.InputFileInfo"/>. </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.ITargetIssueCollection"> <summary> A collection of issues reported by a downstream tool. </summary> </member> <member name="M:PSRule.Data.ITargetIssueCollection.Get(System.String)"> <summary> Get any issues from the collection that match the specified type. </summary> <param name="type">The type of the issue.</param> <returns>Returns issues that match the specified <paramref name="type"/>.</returns> </member> <member name="M:PSRule.Data.ITargetIssueCollection.Any(System.String)"> <summary> Check if the collection contains any of the specified issue type. </summary> <param name="type">The type of the issue.</param> <returns>Returns <c>true</c> if any the collection contains any issues matching the specified <paramref name="type"/>.</returns> </member> <member name="T:PSRule.Data.TargetIssueCollection"> <summary> A collection of issues reported by a downstream tool. </summary> </member> <member name="M:PSRule.Data.TargetIssueCollection.Any(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Data.TargetIssueCollection.Get(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Data.TargetIssueCollection.AddRange(PSRule.Data.TargetIssueInfo[])"> <summary> Add one or more issues into the collection. </summary> <param name="issueInfo">An array of <see cref="T:PSRule.Data.TargetIssueInfo"/> instance to add to the collection.</param> </member> <member name="T:PSRule.Data.RepositoryInfo"> <summary> Repository target information. </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="M:PSRule.Data.TargetIssueInfo.Create(System.Object)"> <summary> Create an issue from a structured object. </summary> </member> <member name="M:PSRule.Data.TargetIssueInfo.Create(System.Management.Automation.PSObject)"> <summary> Create an issue from a structured object. </summary> </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.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="M:PSRule.Data.TargetSourceInfo.Create(System.Object)"> <summary> Create source information from a structured object. </summary> </member> <member name="M:PSRule.Data.TargetSourceInfo.Create(System.Management.Automation.PSObject)"> <summary> Create source information from a structured object. </summary> </member> <member name="T:PSRule.Definitions.Baselines.IBaselineV1Spec"> <summary> A specification for a V1 baseline resource. </summary> </member> <member name="P:PSRule.Definitions.Baselines.IBaselineV1Spec.Binding"> <summary> Options that affect property binding. </summary> </member> <member name="P:PSRule.Definitions.Baselines.IBaselineV1Spec.Configuration"> <summary> Allows configuration key/ values to be specified that can be used within rule definitions. </summary> </member> <member name="P:PSRule.Definitions.Baselines.IBaselineV1Spec.Convention"> <summary> Options that configure conventions. </summary> </member> <member name="P:PSRule.Definitions.Baselines.IBaselineV1Spec.Rule"> <summary> Options for that affect which rules are executed by including and filtering discovered rules. </summary> </member> <member name="T:PSRule.Definitions.Baselines.Baseline"> <summary> A baseline resource V1. </summary> </member> <member name="M:PSRule.Definitions.Baselines.Baseline.#ctor(System.String,PSRule.Pipeline.SourceFile,PSRule.Definitions.ResourceMetadata,PSRule.Definitions.IResourceHelpInfo,PSRule.Definitions.ISourceExtent,PSRule.Definitions.Baselines.BaselineSpec)"> <summary> Create a baseline instance. </summary> </member> <member name="P:PSRule.Definitions.Baselines.Baseline.BaselineId"> <summary> The unique identifier for the baseline. </summary> </member> <member name="P:PSRule.Definitions.Baselines.Baseline.Synopsis"> <summary> A human readable block of text, used to identify the purpose of the rule. </summary> </member> <member name="T:PSRule.Definitions.Baselines.BaselineSpec"> <summary> A specification for a V1 baseline resource. </summary> </member> <member name="P:PSRule.Definitions.Baselines.BaselineSpec.Binding"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Baselines.BaselineSpec.Configuration"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Baselines.BaselineSpec.Convention"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Baselines.BaselineSpec.Rule"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Conventions.BaseConvention.Name"> <summary> The name of the convetion. </summary> </member> <member name="T:PSRule.Definitions.Conventions.ConventionComparer"> <summary> Orders conventions by the order they are specified. </summary> </member> <member name="T:PSRule.Definitions.Expressions.SelectorException"> <summary> A base class for runtime exceptions. </summary> </member> <member name="T:PSRule.Definitions.Expressions.FunctionDescriptor"> <summary> A structure describing a specific function. </summary> </member> <member name="P:PSRule.Definitions.Expressions.FunctionDescriptor.Name"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Expressions.FunctionDescriptor.Fn"> <inheritdoc/> </member> <member name="T:PSRule.Definitions.Expressions.IFunctionDescriptor"> <summary> A structure describing a specific function. </summary> </member> <member name="P:PSRule.Definitions.Expressions.IFunctionDescriptor.Name"> <summary> The name of the function. </summary> </member> <member name="P:PSRule.Definitions.Expressions.IFunctionDescriptor.Fn"> <summary> The function delegate. </summary> </member> <member name="T:PSRule.Definitions.Expressions.Functions"> <summary> Implementation of Azure Resource Manager template functions as ExpressionFn. </summary> </member> <member name="F:PSRule.Definitions.Expressions.Functions.Builtin"> <summary> The available built-in functions. </summary> </member> <member name="T:PSRule.Definitions.Expressions.LanguageExpressions"> <summary> Expressions that can be used with selectors. </summary> </member> <member name="M:PSRule.Definitions.Expressions.LanguageExpressions.NotHasField(PSRule.Definitions.Expressions.IExpressionContext,System.String)"> <summary> Reason: The field '{0}' does not exist. </summary> </member> <member name="M:PSRule.Definitions.Expressions.LanguageExpressions.NullOrEmpty(PSRule.Definitions.Expressions.ExpressionContext,PSRule.Runtime.IOperand)"> <summary> Reason: Is null or empty. </summary> </member> <member name="M:PSRule.Definitions.Expressions.LanguageExpressions.NotString(PSRule.Definitions.Expressions.ExpressionContext,PSRule.Runtime.IOperand)"> <summary> Reason: The value '{0}' is not a string. </summary> </member> <member name="M:PSRule.Definitions.Expressions.LanguageExpressions.Value(PSRule.Definitions.Expressions.IExpressionContext,PSRule.Runtime.IOperand)"> <summary> Unwrap a function delegate or a literal value. </summary> </member> <member name="M:PSRule.Definitions.Expressions.LanguageExpressions.Value(PSRule.Definitions.Expressions.IExpressionContext,System.Object)"> <summary> Unwrap a function delegate or a literal value. </summary> </member> <member name="M:PSRule.Definitions.Expressions.LanguageExpressions.TryFieldNotExists(PSRule.Definitions.Expressions.ExpressionContext,System.Object,PSRule.Definitions.Expressions.LanguageExpression.PropertyBag)"> <summary> Returns true when the field properties is specified and the specified field does not exist. </summary> </member> <member name="P:PSRule.Definitions.IDependencyTarget.DependsOn"> <summary> Resources this target depends on. </summary> </member> <member name="P:PSRule.Definitions.IDependencyTarget.Dependency"> <summary> Determines if the source was imported as a dependency. </summary> </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.SourcePath"> <summary> Obsolete. The source file path. Replaced by <see cref="P:PSRule.Definitions.ILanguageBlock.Source"/>. </summary> </member> <member name="P:PSRule.Definitions.ILanguageBlock.Module"> <summary> Obsolete. The source module. Replaced by <see cref="P:PSRule.Definitions.ILanguageBlock.Source"/>. </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="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="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.IRuleResultV2"> <summary> Rule results for PSRule V2. </summary> </member> <member name="P:PSRule.Definitions.IRuleResultV2.RunId"> <summary> A unique identifier for the run. </summary> </member> <member name="P:PSRule.Definitions.IRuleResultV2.Info"> <summary> Help info for the rule. </summary> </member> <member name="P:PSRule.Definitions.IRuleResultV2.Outcome"> <summary> The outcome after the rule processes an object. </summary> </member> <member name="P:PSRule.Definitions.IRuleResultV2.Level"> <summary> If the rule fails, how serious is the result. </summary> </member> <member name="P:PSRule.Definitions.IRuleResultV2.Tag"> <summary> Tags set for the rule. </summary> </member> <member name="P:PSRule.Definitions.IRuleResultV2.Time"> <summary> The execution time of the rule in millisecond. </summary> </member> <member name="P:PSRule.Definitions.IDetailedRuleResultV2.Data"> <summary> Custom data set by the rule for this target object. </summary> </member> <member name="P:PSRule.Definitions.IDetailedRuleResultV2.Detail"> <summary> Detailed information about the rule result. </summary> </member> <member name="P:PSRule.Definitions.IDetailedRuleResultV2.Field"> <summary> A set of custom fields bound for the target object. </summary> </member> <member name="T:PSRule.Definitions.IResultDetailV2"> <summary> Detailed information about the rule result. </summary> </member> <member name="P:PSRule.Definitions.IResultDetailV2.Reason"> <summary> Any reasons for the result. </summary> </member> <member name="T:PSRule.Definitions.IResultReasonV2"> <summary> A reason for the rule result. </summary> </member> <member name="P:PSRule.Definitions.IResultReasonV2.Path"> <summary> The object path that failed. </summary> </member> <member name="P:PSRule.Definitions.IResultReasonV2.FullPath"> <summary> The object path including the path of the parent object. </summary> </member> <member name="T:PSRule.Definitions.ISuppressionInfo"> <summary> Information related to suppression of a rule. </summary> </member> <member name="T:PSRule.Definitions.ModuleConfigs.ModuleConfigV1"> <summary> A module configuration resource. </summary> </member> <member name="P:PSRule.Definitions.ModuleConfigs.ModuleConfigV1.Synopsis"> <summary> A human readable block of text, used to identify the purpose of the module config. </summary> </member> <member name="T:PSRule.Definitions.ModuleConfigs.ModuleConfigV1Spec"> <summary> A specification for a module configuration. </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.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="T:PSRule.Definitions.IResource"> <summary> A resource langange 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 identifer 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.ResourceAnnotation"> <summary> A base resource annotation. </summary> </member> <member name="T:PSRule.Definitions.ValidateResourceAnnotation"> <summary> Annotation used to flag validation issues. </summary> </member> <member name="T:PSRule.Definitions.ResourceObject"> <summary> A resource object. </summary> </member> <member name="T:PSRule.Definitions.ResourceAnnotations"> <summary> Additional resource annotations. </summary> </member> <member name="T:PSRule.Definitions.ResourceLabels"> <summary> Additional resource taxonomy references. </summary> </member> <member name="M:PSRule.Definitions.ResourceLabels.#ctor"> <summary> Create an empty set of resource labels. </summary> </member> <member name="M:PSRule.Definitions.ResourceLabels.FromHashtable(System.Collections.Hashtable)"> <summary> Convert from a hashtable to resource labels. </summary> </member> <member name="T:PSRule.Definitions.ResourceTags"> <summary> Additional resource tags. </summary> </member> <member name="M:PSRule.Definitions.ResourceTags.#ctor"> <summary> Create an empty set of resource tags. </summary> </member> <member name="M:PSRule.Definitions.ResourceTags.FromHashtable(System.Collections.Hashtable)"> <summary> Convert from a hashtable to resource tags. </summary> </member> <member name="M:PSRule.Definitions.ResourceTags.FromDictionary(System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Convert from a dictionary of string pairs to resource tags. </summary> </member> <member name="M:PSRule.Definitions.ResourceTags.ToHashtable"> <summary> Convert resource tags to a hashtable. </summary> </member> <member name="M:PSRule.Definitions.ResourceTags.Contains(System.Object,System.Object)"> <summary> Check if a specific resource tag exists. </summary> </member> <member name="M:PSRule.Definitions.ResourceTags.ToViewString"> <summary> Convert the resourecs tags to a display string for PowerShell views. </summary> <returns></returns> </member> <member name="T:PSRule.Definitions.ResourceMetadata"> <summary> Additional resource metadata. </summary> </member> <member name="M:PSRule.Definitions.ResourceMetadata.#ctor"> <summary> Create an empty set of metadata. </summary> </member> <member name="P:PSRule.Definitions.ResourceMetadata.Name"> <summary> The name of the resource. </summary> </member> <member name="P:PSRule.Definitions.ResourceMetadata.Ref"> <summary> A opaque reference for the resource. </summary> </member> <member name="P:PSRule.Definitions.ResourceMetadata.Alias"> <summary> Additional aliases for the resource. </summary> </member> <member name="P:PSRule.Definitions.ResourceMetadata.Annotations"> <summary> Any resource annotations. </summary> </member> <member name="P:PSRule.Definitions.ResourceMetadata.Tags"> <summary> Any resource tags. </summary> </member> <member name="P:PSRule.Definitions.ResourceMetadata.Labels"> <summary> Any taxonomy references. </summary> </member> <member name="T:PSRule.Definitions.ResourceExtent"> <summary> The source location of the resource. </summary> </member> <member name="P:PSRule.Definitions.ResourceExtent.File"> <summary> The file where the resource is located. </summary> </member> <member name="P:PSRule.Definitions.ResourceExtent.Module"> <summary> The name of the module if the resource is contained within a module. </summary> </member> <member name="T:PSRule.Definitions.Resource`1"> <summary> A base class for resources. </summary> <typeparam name="TSpec">The type for the resource specification.</typeparam> </member> <member name="M:PSRule.Definitions.Resource`1.#ctor(PSRule.Definitions.ResourceKind,System.String,PSRule.Pipeline.SourceFile,PSRule.Definitions.ResourceMetadata,PSRule.Definitions.IResourceHelpInfo,PSRule.Definitions.ISourceExtent,`0)"> <summary> Create a resource. </summary> </member> <member name="P:PSRule.Definitions.Resource`1.Id"> <summary> The resource identifier for the resource. </summary> </member> <member name="P:PSRule.Definitions.Resource`1.Name"> <summary> The name of the resource. </summary> </member> <member name="P:PSRule.Definitions.Resource`1.Source"> <summary> The file path where the resource is defined. </summary> </member> <member name="P:PSRule.Definitions.Resource`1.Info"> <summary> Information about the resource. </summary> </member> <member name="P:PSRule.Definitions.Resource`1.Metadata"> <summary> Resource metadata details. </summary> </member> <member name="P:PSRule.Definitions.Resource`1.Kind"> <summary> The type of resource. </summary> </member> <member name="P:PSRule.Definitions.Resource`1.ApiVersion"> <summary> The API version of the resource. </summary> </member> <member name="P:PSRule.Definitions.Resource`1.Spec"> <summary> The child specification of the resource. </summary> </member> <member name="P:PSRule.Definitions.Resource`1.Extent"> <summary> The source location of the resource. </summary> </member> <member name="T:PSRule.Definitions.InternalResource`1"> <summary> A base class for built-in resource types. </summary> <typeparam name="TSpec">The type of the related <seealso cref="T:PSRule.Definitions.Spec"/> for the resource.</typeparam> </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="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.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.ResourceValidator"> <summary> A helper class to help validate a resource object. </summary> </member> <member name="P:PSRule.Definitions.ResultReason.Path"> <summary> The object path that failed. </summary> </member> <member name="P:PSRule.Definitions.ResultReason.Prefix"> <summary> A prefix to add to the object path that failed. </summary> </member> <member name="P:PSRule.Definitions.ResultReason.FullPath"> <summary> The object path including the path of the parent object. </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.Rules.IRuleV1"> <summary> A rule resource V1. </summary> </member> <member name="P:PSRule.Definitions.Rules.IRuleV1.RuleName"> <summary> Obsolete. The name of the rule. Replaced by <see cref="P:PSRule.Definitions.IResource.Name"/>. </summary> </member> <member name="P:PSRule.Definitions.Rules.IRuleV1.Level"> <summary> If the rule fails, how serious is the result. </summary> </member> <member name="P:PSRule.Definitions.Rules.IRuleV1.Synopsis"> <summary> A short description of the rule. </summary> </member> <member name="P:PSRule.Definitions.Rules.IRuleV1.Description"> <summary> Obsolete. A short description of the rule. Replaced by <see cref="P:PSRule.Definitions.Rules.IRuleV1.Synopsis"/>. </summary> </member> <member name="P:PSRule.Definitions.Rules.IRuleV1.Tag"> <summary> Any additional tags assigned to the rule. </summary> </member> <member name="T:PSRule.Definitions.Rules.IRuleSpec"> <summary> A specification for a rule resource. </summary> </member> <member name="P:PSRule.Definitions.Rules.IRuleSpec.Condition"> <summary> The of the rule condition that will be evaluated. </summary> </member> <member name="P:PSRule.Definitions.Rules.IRuleSpec.Level"> <summary> If the rule fails, how serious is the result. </summary> </member> <member name="P:PSRule.Definitions.Rules.IRuleSpec.Type"> <summary> An optional type pre-condition before the rule is evaluated. </summary> </member> <member name="P:PSRule.Definitions.Rules.IRuleSpec.With"> <summary> An optional selector pre-condition before the rule is evaluated. </summary> </member> <member name="P:PSRule.Definitions.Rules.IRuleSpec.Where"> <summary> An optional sub-selector pre-condition before the rule is evaluated. </summary> </member> <member name="T:PSRule.Definitions.Rules.RuleV1"> <summary> A rule resource V1. </summary> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.Ref"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.Alias"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.Level"> <summary> If the rule fails, how serious is the result. </summary> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.Synopsis"> <summary> A human readable block of text, used to identify the purpose of the rule. </summary> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.PSRule#Definitions#IDependencyTarget#Ref"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.PSRule#Definitions#IDependencyTarget#Alias"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.PSRule#Definitions#IDependencyTarget#Dependency"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.PSRule#Definitions#IResource#Ref"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.PSRule#Definitions#IResource#Alias"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.PSRule#Definitions#Rules#IRuleV1#RuleName"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.PSRule#Definitions#Rules#IRuleV1#Tag"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1.PSRule#Definitions#Rules#IRuleV1#Description"> <inheritdoc/> </member> <member name="T:PSRule.Definitions.Rules.RuleV1Spec"> <summary> A specification for a V1 rule resource. </summary> </member> <member name="P:PSRule.Definitions.Rules.RuleV1Spec.Condition"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1Spec.Level"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1Spec.Type"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1Spec.With"> <inheritdoc/> </member> <member name="P:PSRule.Definitions.Rules.RuleV1Spec.Where"> <inheritdoc/> </member> <member name="T:PSRule.Definitions.Rules.RuleFilter"> <summary> A filter to include or exclude rules from being processed by id or tag. </summary> </member> <member name="M:PSRule.Definitions.Rules.RuleFilter.#ctor(System.String[],System.Collections.Hashtable,System.String[],System.Nullable{System.Boolean},PSRule.Definitions.ResourceLabels)"> <summary> Filter rules by id or tag. </summary> <param name="include">Only accept these rules by name.</param> <param name="tag">Only accept rules that have these tags.</param> <param name="exclude">Rule that are always excluded by name.</param> <param name="includeLocal">Determine if local rules are automatically included.</param> <param name="labels">Only accept rules that have these labels.</param> </member> <member name="M:PSRule.Definitions.Rules.RuleFilter.Match(PSRule.Definitions.IResource)"> <summary> Matches if the RuleId is contained or any tag is matched </summary> <returns>Return true if rule is matched, otherwise false.</returns> </member> <member name="T:PSRule.Definitions.Rules.RuleVisitor"> <summary> A rule visitor. </summary> </member> <member name="T:PSRule.Definitions.Selectors.SelectorV1"> <summary> A selector resource V1. </summary> </member> <member name="T:PSRule.Definitions.Selectors.SelectorV1Spec"> <summary> A specification for a V1 selector resource. </summary> </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.Spec"> <summary> The base class for a resource specification. </summary> </member> <member name="M:PSRule.Definitions.Spec.#ctor"> <summary> Create an instance of the resource specication. </summary> </member> <member name="M:PSRule.Definitions.Spec.GetFullName(System.String,System.String)"> <summary> Get a fully qualified name for the resource type. </summary> <param name="apiVersion">The specific API version of the resource.</param> <param name="name">The type name of the resource.</param> <returns>A fully qualified type name string.</returns> </member> <member name="F:PSRule.Definitions.Specs.V1"> <summary> The API version for V1 resources. </summary> </member> <member name="F:PSRule.Definitions.Specs.BuiltinTypes"> <summary> The built-in resource types. </summary> </member> <member name="T:PSRule.Definitions.SuppressionGroups.ISuppressionGroupV1Spec"> <summary> A specification for a V1 suppression group resource. </summary> </member> <member name="T:PSRule.Definitions.SuppressionGroups.SuppressionGroupV1"> <summary> A suppression group resource V1. </summary> </member> <member name="T:PSRule.Definitions.SuppressionGroups.SuppressionGroupV1Spec"> <summary> A specification for a V1 suppression group resource. </summary> </member> <member name="T:PSRule.Definitions.SuppressionGroups.SuppressionGroupVisitor.SuppressionInfo"> <summary> Tracking information about the suppression. </summary> </member> <member name="M:PSRule.Help.HelpLexer.Synopsis(PSRule.Help.TokenStream,PSRule.Help.IHelpDocument)"> <summary> Read synopsis. </summary> </member> <member name="M:PSRule.Help.HelpLexer.Description(PSRule.Help.TokenStream,PSRule.Help.IHelpDocument)"> <summary> Read description. </summary> </member> <member name="M:PSRule.Help.HelpLexer.Links(PSRule.Help.TokenStream,PSRule.Help.IHelpDocument)"> <summary> Read links. </summary> </member> <member name="M:PSRule.Help.HelpLexer.ReadText(PSRule.Help.TokenStream,System.Boolean)"> <summary> Read tokens from the stream as text. </summary> </member> <member name="T:PSRule.Help.MarkdownReader"> <summary> Stateful markdown reader. </summary> </member> <member name="F:PSRule.Help.MarkdownReader._PreserveFormatting"> <summary> Preserve formatting skips processing inlines and treats them as raw text. </summary> </member> <member name="F:PSRule.Help.MarkdownReader.LineEndingCharacters"> <summary> Line ending characters: \r, \n </summary> </member> <member name="M:PSRule.Help.MarkdownReader.HashHeader"> <summary> Process hash header. </summary> </member> <member name="M:PSRule.Help.MarkdownReader.FencedBlock"> <summary> Process a fenced block. </summary> </member> <member name="M:PSRule.Help.MarkdownReader.Link"> <summary> Process link. </summary> </member> <member name="F:PSRule.Help.MarkdownStream._Position"> <summary> The current character position in the markdown string. Call Next() to change the position. </summary> </member> <member name="P:PSRule.Help.MarkdownStream.Current"> <summary> The character at the current position in the stream. </summary> </member> <member name="M:PSRule.Help.MarkdownStream.SkipWhitespace"> <summary> Skip if the current character is whitespace. </summary> </member> <member name="M:PSRule.Help.MarkdownStream.SkipLineEnding(System.Int32,System.Boolean)"> <summary> If the current character and sequential characters are line ending control characters, skip ahead. </summary> <param name="max">The number of line endings to skip. When max is 0, sequential line endings will be skipped.</param> <returns>The number of line endings skipped.</returns> </member> <member name="M:PSRule.Help.MarkdownStream.SkipNext(System.Char)"> <summary> Skip ahead if the next character is expected. </summary> <param name="c">The character to skip.</param> </member> <member name="M:PSRule.Help.MarkdownStream.Skip(System.Char,System.Int32)"> <summary> Skip ahead if the current character is expected. Keep skipping when the character is repeated. </summary> <param name="c">The character to skip.</param> <returns>The number of characters that where skipped.</returns> </member> <member name="M:PSRule.Help.MarkdownStream.Skip(System.Int32,System.Boolean)"> <summary> Skip ahead a number of characters. Use Next() in preference of Skip if the number to skip is 1. </summary> <param name="toSkip">The number of characters to skip</param> </member> <member name="M:PSRule.Help.MarkdownStream.Peak(System.Int32)"> <summary> Peak at the n'th character from the current position. Check remaining characters prior to calling. </summary> <param name="offset">The offset from the current position.</param> <returns>The character at the offset.</returns> </member> <member name="M:PSRule.Help.MarkdownStream.GetExtent"> <summary> Get the extent and clear previous marker. </summary> <returns></returns> </member> <member name="M:PSRule.Help.MarkdownStream.Checkpoint"> <summary> Create a position checkpoint that can be rolled back. </summary> </member> <member name="M:PSRule.Help.MarkdownStream.Rollback"> <summary> Rollback a position checkpoint. </summary> </member> <member name="M:PSRule.Help.MarkdownStream.Next(System.Boolean)"> <summary> Move to the next character in the stream. </summary> <returns>Is True when more characters exist in the stream.</returns> </member> <member name="M:PSRule.Help.MarkdownStream.CaptureUntil(System.String,System.Boolean,System.Boolean)"> <summary> Capture text until the sequence is found. </summary> <param name="sequence">A specific sequence that ends the capture.</param> <param name="onNewLine"></param> <param name="ignoreEscaping">Interprets the string literally instead of processing escape sequences.</param> <returns>Returns the captured text up until the sequence.</returns> </member> <member name="M:PSRule.Help.MarkdownStream.CaptureLine"> <summary> Capture text until the end of the line. </summary> <returns>Returns the captured text up until the end of the line.</returns> </member> <member name="T:PSRule.Help.FormatOptions"> <summary> Define options that determine how markdown will be rendered. </summary> </member> <member name="F:PSRule.Help.FormatOptions.LineBreak"> <summary> Add a line break after headers. </summary> </member> <member name="T:PSRule.Help.TextBlock"> <summary> Markdown text content. </summary> </member> <member name="F:PSRule.Help.TextBlock.Text"> <summary> The text of the section body. </summary> </member> <member name="F:PSRule.Help.TextBlock.FormatOption"> <summary> Additional options that determine how the section will be formated when rendering markdown. </summary> </member> <member name="T:PSRule.Help.Link"> <summary> YAML link. </summary> </member> <member name="T:PSRule.Help.RuleHelpLexer"> <summary> A lexer that interprets markdown as rule help. </summary> </member> <member name="M:PSRule.Help.RuleHelpLexer.Recommendation(PSRule.Help.TokenStream,PSRule.Help.RuleDocument)"> <summary> Read recommendation. </summary> </member> <member name="M:PSRule.Help.RuleHelpLexer.Notes(PSRule.Help.TokenStream,PSRule.Help.RuleDocument)"> <summary> Read notes. </summary> </member> <member name="M:PSRule.Help.TokenStreamExtensions.Header(PSRule.Help.TokenStream,System.Int32,System.String,PSRule.Help.SourceExtent,System.Boolean)"> <summary> Add a header. </summary> </member> <member name="M:PSRule.Help.TokenStreamExtensions.FencedBlock(PSRule.Help.TokenStream,System.String,System.String,PSRule.Help.SourceExtent,System.Boolean)"> <summary> Add a code fence. </summary> </member> <member name="M:PSRule.Help.TokenStreamExtensions.LineBreak(PSRule.Help.TokenStream,System.Int32)"> <summary> Add a line break. </summary> </member> <member name="M:PSRule.Help.TokenStreamExtensions.ParagraphStart(PSRule.Help.TokenStream)"> <summary> Add a marker for the start of a paragraph. </summary> </member> <member name="M:PSRule.Help.TokenStreamExtensions.ParagraphEnd(PSRule.Help.TokenStream)"> <summary> Add a marker for the end of a paragraph. </summary> </member> <member name="T:PSRule.Host.PSRuleVariable"> <summary> A dynamic variable $PSRule used during Rule execution. </summary> </member> <member name="T:PSRule.Host.RuleVariable"> <summary> A dynamic variable $Rule used during Rule execution. </summary> </member> <member name="T:PSRule.Host.LocalizedDataVariable"> <summary> A dynamic variable $LocalizedData used during Rule execution. </summary> </member> <member name="T:PSRule.Host.AssertVariable"> <summary> An assertion helper variable $Assert used during Rule execution. </summary> </member> <member name="T:PSRule.Host.TargetObjectVariable"> <summary> A dynamic variable used during Rule execution. </summary> </member> <member name="F:PSRule.Host.HostState.BuiltInCmdlets"> <summary> Define language commands. </summary> </member> <member name="F:PSRule.Host.HostState.BuiltInAliases"> <summary> Define language aliases. </summary> </member> <member name="M:PSRule.Host.HostState.CreateSessionState(PSRule.Configuration.SessionState)"> <summary> Create a default session state. </summary> </member> <member name="M:PSRule.Host.HostHelper.GetBaseline(PSRule.Pipeline.Source[],PSRule.Runtime.RunspaceContext)"> <summary> Read YAML/JSON objects and return baselines. </summary> </member> <member name="M:PSRule.Host.HostHelper.GetModuleConfig(PSRule.Pipeline.Source[],PSRule.Runtime.RunspaceContext)"> <summary> Read YAML/JSON objects and return module configurations. </summary> </member> <member name="M:PSRule.Host.HostHelper.GetSelector(PSRule.Pipeline.Source[],PSRule.Runtime.RunspaceContext)"> <summary> Read YAML/JSON objects and return selectors. </summary> </member> <member name="M:PSRule.Host.HostHelper.GetSuppressionGroup(PSRule.Pipeline.Source[],PSRule.Runtime.RunspaceContext)"> <summary> Read YAML/JSON objects and return suppression groups. </summary> </member> <member name="M:PSRule.Host.HostHelper.GetCommentMeta(System.String,System.Int32,System.Int32)"> <summary> Called from PowerShell to get additional metdata from a language block, such as comment help. </summary> <param name="path"></param> <param name="start"></param> <returns></returns> </member> <member name="M:PSRule.Host.HostHelper.GetPSLanguageBlocks(PSRule.Runtime.RunspaceContext,PSRule.Pipeline.Source[])"> <summary> Execute PowerShell script files to get language blocks. </summary> </member> <member name="M:PSRule.Host.HostHelper.GetYamlLanguageBlocks(PSRule.Pipeline.Source[],PSRule.Runtime.RunspaceContext)"> <summary> Get language blocks from YAML source files. </summary> </member> <member name="M:PSRule.Host.HostHelper.GetJsonLanguageBlocks(PSRule.Pipeline.Source[],PSRule.Runtime.RunspaceContext)"> <summary> Get language blocks from JSON source files. </summary> </member> <member name="M:PSRule.Host.HostHelper.ToRuleV1(PSRule.Definitions.ILanguageBlock[],PSRule.Runtime.RunspaceContext)"> <summary> Convert matching langauge blocks to rules. </summary> </member> <member name="M:PSRule.Host.HostHelper.GetConventions(PSRule.Definitions.ILanguageBlock[],PSRule.Runtime.RunspaceContext)"> <summary> Get conventions. </summary> </member> <member name="M:PSRule.Host.RuleLanguageAst.VisitRule(System.Management.Automation.Language.CommandAst)"> <summary> Visit a rule. </summary> </member> <member name="M:PSRule.Host.RuleLanguageAst.VisitBodyParameter(System.Management.Automation.Language.CommandAst,PSRule.Host.RuleLanguageAst.ParameterBindResult)"> <summary> Determines if the rule has a Body parameter. </summary> </member> <member name="M:PSRule.Host.RuleLanguageAst.VisitNameParameter(System.Management.Automation.Language.CommandAst,PSRule.Host.RuleLanguageAst.ParameterBindResult)"> <summary> Determines if the rule has a Name parameter. </summary> </member> <member name="M:PSRule.Host.RuleLanguageAst.IsNameValid(System.Management.Automation.Language.StringConstantExpressionAst)"> <summary> Determines if the rule name is valid. </summary> </member> <member name="M:PSRule.Host.RuleLanguageAst.NotNested(System.Management.Automation.Language.CommandAst)"> <summary> Determines if the rule is nested in another rule. </summary> </member> <member name="M:PSRule.Host.RuleLanguageAst.VisitErrorAction(System.Management.Automation.Language.CommandAst,PSRule.Host.RuleLanguageAst.ParameterBindResult)"> <summary> Determine if the rule has allowed ErrorAction options. </summary> </member> <member name="M:PSRule.Host.RuleLanguageAst.IsRule(System.Management.Automation.Language.CommandAst)"> <summary> Determines if the command is a rule definition. </summary> </member> <member name="T:PSRule.Pipeline.AssertPipelineBuilder"> <summary> A helper to construct the pipeline for Assert-PSRule. </summary> </member> <member name="T:PSRule.Pipeline.AssertPipelineBuilder.AssertWriter"> <summary> A writer for outputting assertions. </summary> </member> <member name="T:PSRule.Pipeline.CommandLineBuilder"> <summary> A helper to create a PSRule pipeline that can be used via the .NET SDK. </summary> </member> <member name="M:PSRule.Pipeline.CommandLineBuilder.Invoke(System.String[],PSRule.Configuration.PSRuleOption,PSRule.Pipeline.IHostContext)"> <summary> Create a builder for an Invoke pipeline. </summary> <remarks> Invoke piplines process objects and produce records indicating the outcome of each rule. </remarks> <param name="module">The name of modules containing rules to process.</param> <param name="option">Options that configure PSRule.</param> <param name="hostContext">An implementation of a host context that will recieve output and results.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Pipeline.CommandLineBuilder.Assert(System.String[],PSRule.Configuration.PSRuleOption,PSRule.Pipeline.IHostContext)"> <summary> Create a builder for an Assert pipeline. </summary> <remarks> Assert pipelines process objects with rules and produce text-based output suitable for output to a CI pipeline. </remarks> <param name="module">The name of modules containing rules to process.</param> <param name="option">Options that configure PSRule.</param> <param name="hostContext">An implementation of a host context that will recieve output and results.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="T:PSRule.Pipeline.PipelineException"> <summary> A base class for all pipeline exceptions. </summary> </member> <member name="M:PSRule.Pipeline.PipelineException.#ctor"> <summary> Initialize a new instance of a PSRule exception. </summary> </member> <member name="M:PSRule.Pipeline.PipelineException.#ctor(System.String)"> <summary> Initialize a new instance of a PSRule exception. </summary> </member> <member name="M:PSRule.Pipeline.PipelineException.#ctor(System.String,System.Exception)"> <summary> Initialize a new instance of a PSRule exception. </summary> </member> <member name="M:PSRule.Pipeline.PipelineException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initialize a new instance of a PSRule exception. </summary> </member> <member name="T:PSRule.Pipeline.RuntimeException"> <summary> A base class for runtime exceptions. </summary> </member> <member name="M:PSRule.Pipeline.RuntimeException.#ctor"> <summary> Initialize a new instance of a PSRule exception that is thrown during runtime. </summary> </member> <member name="M:PSRule.Pipeline.RuntimeException.#ctor(System.String)"> <summary> Initialize a new instance of a PSRule exception that is thrown during runtime. </summary> </member> <member name="M:PSRule.Pipeline.RuntimeException.#ctor(System.String,System.Exception)"> <summary> Initialize a new instance of a PSRule exception that is thrown during runtime. </summary> </member> <member name="M:PSRule.Pipeline.RuntimeException.#ctor(System.Exception,System.Management.Automation.InvocationInfo,System.String)"> <summary> Initialize a new instance of a PSRule exception that is thrown during runtime. </summary> </member> <member name="M:PSRule.Pipeline.RuntimeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initialize a new instance of a PSRule exception that is thrown during runtime. </summary> </member> <member name="P:PSRule.Pipeline.RuntimeException.CommandInvocation"> <summary> Additional information about the invocation when executing PowerShell language elements. </summary> </member> <member name="P:PSRule.Pipeline.RuntimeException.RuleId"> <summary> A unique identifier for the rule that was executing if currently within the context of a rule. </summary> </member> <member name="T:PSRule.Pipeline.PipelineBuilderException"> <summary> An exception when building the pipeline. </summary> </member> <member name="M:PSRule.Pipeline.PipelineBuilderException.#ctor"> <summary> Creates a pipeline builder exception. </summary> </member> <member name="M:PSRule.Pipeline.PipelineBuilderException.#ctor(System.String)"> <summary> Creates a pipeline builder exception. </summary> <param name="message">The detail of the exception.</param> </member> <member name="M:PSRule.Pipeline.PipelineBuilderException.#ctor(System.String,System.Exception)"> <summary> Creates a pipeline builder exception. </summary> <param name="message">The detail of the exception.</param> <param name="innerException">A nested exception that caused the issue.</param> </member> <member name="M:PSRule.Pipeline.PipelineBuilderException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Pipeline.PipelineSerializationException"> <summary> A serialization exception. </summary> </member> <member name="M:PSRule.Pipeline.PipelineSerializationException.#ctor"> <summary> Creates a serialization exception. </summary> </member> <member name="M:PSRule.Pipeline.PipelineSerializationException.#ctor(System.String,System.String,System.Exception)"> <summary> Creates a serialization exception. </summary> </member> <member name="M:PSRule.Pipeline.PipelineSerializationException.#ctor(System.String)"> <summary> Creates a serialization exception. </summary> <param name="message">The detail of the exception.</param> </member> <member name="M:PSRule.Pipeline.PipelineSerializationException.#ctor(System.String,System.Object[])"> <summary> Creates a serialization exception. </summary> <param name="message">The detail of the exception.</param> <param name="args">Additional argument to add to the format string.</param> </member> <member name="M:PSRule.Pipeline.PipelineSerializationException.#ctor(System.String,System.Exception)"> <summary> Creates a serialization exception. </summary> <param name="message">The detail of the exception.</param> <param name="innerException">A nested exception that caused the issue.</param> </member> <member name="M:PSRule.Pipeline.PipelineSerializationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Creates a serialization exception. </summary> </member> <member name="P:PSRule.Pipeline.PipelineSerializationException.Path"> <summary> The path to the file. </summary> </member> <member name="M:PSRule.Pipeline.PipelineSerializationException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Pipeline.ParseException"> <summary> A parser exception. </summary> </member> <member name="M:PSRule.Pipeline.ParseException.#ctor"> <summary> Creates a parser exception. </summary> </member> <member name="M:PSRule.Pipeline.ParseException.#ctor(System.String)"> <summary> Creates a parser exception. </summary> </member> <member name="M:PSRule.Pipeline.ParseException.#ctor(System.String,System.Exception)"> <summary> Creates a parser exception. </summary> </member> <member name="M:PSRule.Pipeline.ParseException.#ctor(System.String,System.String)"> <summary> Creates a parser exception. </summary> <param name="message">The detail of the exception.</param> <param name="errorId">A unique identifier related to the exception.</param> </member> <member name="M:PSRule.Pipeline.ParseException.#ctor(System.String,System.String,System.Exception)"> <summary> Creates a parser exception. </summary> <param name="message">The detail of the exception.</param> <param name="errorId">A unique identifier related to the exception.</param> <param name="innerException">A nested exception that caused the issue.</param> </member> <member name="M:PSRule.Pipeline.ParseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Creates a parser exception. </summary> </member> <member name="P:PSRule.Pipeline.ParseException.ErrorId"> <summary> An associated identifier related to why the exception was thrown. </summary> </member> <member name="M:PSRule.Pipeline.ParseException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Pipeline.RuleException"> <summary> A rule runtime exception. </summary> </member> <member name="M:PSRule.Pipeline.RuleException.#ctor"> <summary> Creates a rule runtime exception. </summary> </member> <member name="M:PSRule.Pipeline.RuleException.#ctor(System.String)"> <summary> Creates a rule runtime exception. </summary> <param name="message">The detail of the exception.</param> </member> <member name="M:PSRule.Pipeline.RuleException.#ctor(System.String,System.Exception)"> <summary> Creates a rule runtime exception. </summary> <param name="message">The detail of the exception.</param> <param name="innerException">A nested exception that caused the issue.</param> </member> <member name="M:PSRule.Pipeline.RuleException.#ctor(System.Exception,System.Management.Automation.InvocationInfo,System.String,System.Management.Automation.ErrorRecord)"> <summary> Creates a rule runtime exception. </summary> </member> <member name="M:PSRule.Pipeline.RuleException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Creates a rule runtime exception. </summary> </member> <member name="P:PSRule.Pipeline.RuleException.ErrorRecord"> <summary> An associated error record related to the exception. </summary> </member> <member name="M:PSRule.Pipeline.RuleException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Pipeline.PipelineConfigurationException"> <summary> A pipeline configuration exception. </summary> </member> <member name="M:PSRule.Pipeline.PipelineConfigurationException.#ctor"> <summary> Creates a pipeline configuration exception. </summary> </member> <member name="M:PSRule.Pipeline.PipelineConfigurationException.#ctor(System.String,System.String)"> <summary> Creates a pipeline configuration exception. </summary> <param name="optionName">The name of the option that caused the exception.</param> <param name="message">The detail of the exception.</param> </member> <member name="M:PSRule.Pipeline.PipelineConfigurationException.#ctor(System.String)"> <summary> Creates a pipeline configuration exception. </summary> </member> <member name="M:PSRule.Pipeline.PipelineConfigurationException.#ctor(System.String,System.Exception)"> <summary> Creates a pipeline configuration exception. </summary> </member> <member name="M:PSRule.Pipeline.PipelineConfigurationException.#ctor(System.String,System.String,System.Exception)"> <summary> Creates a pipeline configuration exception. </summary> <param name="optionName">The name of the option that caused the exception.</param> <param name="message">The detail of the exception.</param> <param name="innerException">A nested exception that caused the issue.</param> </member> <member name="M:PSRule.Pipeline.PipelineConfigurationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PipelineConfigurationException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Pipeline.FailPipelineException"> <summary> An exception thrown by PSRule when the calling PowerShell environment should fail because one or more rules failed or errored. </summary> </member> <member name="M:PSRule.Pipeline.FailPipelineException.#ctor"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.FailPipelineException.#ctor(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.FailPipelineException.#ctor(System.String,System.Exception)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.FailPipelineException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.FailPipelineException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Pipeline.RuntimeScopeException"> <summary> An exception thrown by PSRule when a runtime property or method is used outside of the intended scope. Avoid using runtime variables outside of a PSRule pipeline. </summary> </member> <member name="M:PSRule.Pipeline.RuntimeScopeException.#ctor"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.RuntimeScopeException.#ctor(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.RuntimeScopeException.#ctor(System.String,System.Exception)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.RuntimeScopeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.RuntimeScopeException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="F:PSRule.Pipeline.ExecutionScope.Script"> <summary> Execution is occuring at the script. This occurs during discovery. </summary> </member> <member name="F:PSRule.Pipeline.ExecutionScope.Condition"> <summary> Execution is occuring in the main rule condition block. </summary> </member> <member name="F:PSRule.Pipeline.ExecutionScope.Precondition"> <summary> Execution is occuring in a rule precondition. </summary> </member> <member name="F:PSRule.Pipeline.ExecutionScope.Resource"> <summary> Execution is currently parsing YAML objects. </summary> </member> <member name="M:PSRule.Pipeline.ExportBaselinePipelineBuilder.Name(System.String[])"> <summary> Filter returned baselines by name. </summary> </member> <member name="T:PSRule.Pipeline.Formatters.TerminalSupport"> <summary> Configures formatted output. </summary> </member> <member name="T:PSRule.Pipeline.Formatters.AssertFormatterBase"> <summary> A base class for a formatter. </summary> </member> <member name="M:PSRule.Pipeline.Formatters.AssertFormatterBase.Pass(PSRule.Rules.RuleRecord)"> <summary> Occurs when a rule passes. </summary> </member> <member name="M:PSRule.Pipeline.Formatters.AssertFormatterBase.Fail(PSRule.Rules.RuleRecord)"> <summary> Occurs when a rule fails. </summary> </member> <member name="M:PSRule.Pipeline.Formatters.AssertFormatterBase.FailWithError(PSRule.Rules.RuleRecord)"> <summary> Occurs when a rule raises an error. </summary> </member> <member name="T:PSRule.Pipeline.Formatters.AzurePipelinesFormatter"> <summary> Formatter for Azure Pipelines. </summary> </member> <member name="T:PSRule.Pipeline.Formatters.ClientFormatter"> <summary> Client assert formatter. </summary> </member> <member name="T:PSRule.Pipeline.Formatters.GitHubActionsFormatter"> <summary> Formatter for GitHub Actions. </summary> </member> <member name="T:PSRule.Pipeline.Formatters.PlainFormatter"> <summary> Plain text assert formatter. </summary> </member> <member name="T:PSRule.Pipeline.Formatters.VisualStudioCodeFormatter"> <summary> Visual Studio Code assert formatter. </summary> </member> <member name="M:PSRule.Pipeline.GetBaselinePipelineBuilder.Name(System.String[])"> <summary> Filter returned baselines by name. </summary> </member> <member name="T:PSRule.Pipeline.GetRulePipelineBuilder"> <summary> A helper to construct a get pipeline. </summary> </member> <member name="T:PSRule.Pipeline.GetTargetPipelineBuilder"> <summary> A helper to construct the pipeline for Assert-PSRule. </summary> </member> <member name="T:PSRule.Pipeline.GetTargetPipeline"> <summary> A pipeline that gets target objects through the pipeline. </summary> </member> <member name="T:PSRule.Pipeline.IHostContext"> <summary> A host context for handling input and output emitted from the pipeline. </summary> </member> <member name="P:PSRule.Pipeline.IHostContext.InSession"> <summary> Determines if the pipeline is executing in a remote PowerShell session. </summary> </member> <member name="M:PSRule.Pipeline.IHostContext.GetPreferenceVariable(System.String)"> <summary> Get the value of a PowerShell preference variable. </summary> </member> <member name="M:PSRule.Pipeline.IHostContext.GetVariable``1(System.String)"> <summary> Get the value of a named variable. </summary> </member> <member name="M:PSRule.Pipeline.IHostContext.SetVariable``1(System.String,``0)"> <summary> Set the value of a named variable. </summary> </member> <member name="M:PSRule.Pipeline.IHostContext.Error(System.Management.Automation.ErrorRecord)"> <summary> Handle an error reported by the pipeline. </summary> </member> <member name="M:PSRule.Pipeline.IHostContext.Warning(System.String)"> <summary> Handle a warning reported by the pipeline. </summary> </member> <member name="M:PSRule.Pipeline.IHostContext.Information(System.Management.Automation.InformationRecord)"> <summary> Handle an informational record reported by the pipeline. </summary> </member> <member name="M:PSRule.Pipeline.IHostContext.Verbose(System.String)"> <summary> Handle a verbose message reported by the pipeline. </summary> </member> <member name="M:PSRule.Pipeline.IHostContext.Debug(System.String)"> <summary> Handle a debug message reported by the pipeline. </summary> </member> <member name="M:PSRule.Pipeline.IHostContext.Object(System.Object,System.Boolean)"> <summary> Handle an object emitted from the pipeline. </summary> </member> <member name="M:PSRule.Pipeline.IHostContext.ShouldProcess(System.String,System.String)"> <summary> Determines if a destructive action such as overwriting a file should be processed. </summary> </member> <member name="T:PSRule.Pipeline.HostContext"> <summary> A base class for custom host context instances. </summary> </member> <member name="P:PSRule.Pipeline.HostContext.InSession"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.HostContext.Debug(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.HostContext.Error(System.Management.Automation.ErrorRecord)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.HostContext.GetPreferenceVariable(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.HostContext.GetVariable``1(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.HostContext.Information(System.Management.Automation.InformationRecord)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.HostContext.Object(System.Object,System.Boolean)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.HostContext.SetVariable``1(System.String,``0)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.HostContext.ShouldProcess(System.String,System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.HostContext.Verbose(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.HostContext.Warning(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.HostContext.Record(PSRule.Definitions.IResultRecord)"> <summary> Handle record objects emitted from the pipeline. </summary> </member> <member name="T:PSRule.Pipeline.PSHostContext"> <summary> The host context used for PowerShell-based pipelines. </summary> </member> <member name="P:PSRule.Pipeline.PSHostContext.InSession"> <summary> Determine if running in a remote session. </summary> </member> <member name="M:PSRule.Pipeline.PSHostContext.#ctor(System.Management.Automation.PSCmdlet,System.Management.Automation.EngineIntrinsics)"> <summary> Create an instance of a PowerShell-based host context. </summary> </member> <member name="M:PSRule.Pipeline.PSHostContext.GetPreferenceVariable(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PSHostContext.GetVariable``1(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PSHostContext.SetVariable``1(System.String,``0)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PSHostContext.ShouldProcess(System.String,System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PSHostContext.Error(System.Management.Automation.ErrorRecord)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PSHostContext.Warning(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PSHostContext.Information(System.Management.Automation.InformationRecord)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PSHostContext.Verbose(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PSHostContext.Debug(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PSHostContext.Object(System.Object,System.Boolean)"> <inheritdoc/> </member> <member name="T:PSRule.Pipeline.IInvokePipelineBuilder"> <summary> A helper to build a pipeline for executing rules and conventions within a PSRule sandbox. </summary> </member> <member name="M:PSRule.Pipeline.IInvokePipelineBuilder.InputPath(System.String[])"> <summary> Configures paths that will be scanned for input. </summary> <param name="path">An array of relative or absolute path specs to be scanned. Directories will be recursively scanned for all files not excluded matching the file path spec.</param> </member> <member name="M:PSRule.Pipeline.IInvokePipelineBuilder.ResultVariable(System.String)"> <summary> Configures a variable that will recieve all results in addition to the host context. </summary> <param name="variableName">The name of the variable to set.</param> </member> <member name="M:PSRule.Pipeline.IInvokePipelineBuilder.UnblockPublisher(System.String)"> <summary> Unblocks PowerShell sources from trusted publishers that originate from an Internet zone. </summary> <param name="publisher">The trusted publisher to unblock.</param> </member> <member name="T:PSRule.Pipeline.InvokeRulePipelineBuilder"> <summary> A helper to construct the pipeline for Invoke-PSRule. </summary> </member> <member name="T:PSRule.Pipeline.InvokeResult"> <summary> A result for a target object. </summary> </member> <member name="P:PSRule.Pipeline.InvokeResult.Time"> <summary> The execution time of all rules in milliseconds. </summary> </member> <member name="M:PSRule.Pipeline.InvokeResult.AsRecord"> <summary> Get the individual records for the target object. </summary> <returns>Returns an enumeration of RuleRecords.</returns> </member> <member name="M:PSRule.Pipeline.InvokeResult.IsSuccess"> <summary> Get an overall pass or fail for the target object. </summary> <returns>Returns true if object passed and false if object failed.</returns> </member> <member name="M:PSRule.Pipeline.InvokeResult.Add(PSRule.Rules.RuleRecord)"> <summary> Add a record to the result. </summary> <param name="ruleRecord">The record after processing a rule.</param> </member> <member name="M:PSRule.Pipeline.InvokeRulePipeline.Process(System.Management.Automation.PSObject)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.InvokeRulePipeline.End"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.InvokeRulePipeline.AddToSummary(PSRule.Rules.RuleBlock,PSRule.Rules.RuleOutcome)"> <summary> Add rule result to summary. </summary> </member> <member name="T:PSRule.Pipeline.ModulePathComparer"> <summary> Sort paths by versions in decending order. Use orginal order when versions are compariable. </summary> </member> <member name="M:PSRule.Pipeline.ModulePathComparer.Compare(System.String,System.String)"> <inheritdoc/> </member> <member name="T:PSRule.Pipeline.Output.FileOutputWriter"> <summary> An output writer that writes output to disk. </summary> </member> <member name="T:PSRule.Pipeline.Output.HostPipelineWriter"> <summary> An output writer that returns output to the host PowerShell runspace. </summary> </member> <member name="M:PSRule.Pipeline.Output.HostPipelineWriter.WriteError(System.Management.Automation.ErrorRecord)"> <summary> Core methods to hand off to logger. </summary> <param name="errorRecord">A valid PowerShell error record.</param> </member> <member name="M:PSRule.Pipeline.Output.HostPipelineWriter.WriteVerbose(System.String)"> <summary> Core method to hand off verbose messages to logger. </summary> <param name="message">A message to log.</param> </member> <member name="M:PSRule.Pipeline.Output.HostPipelineWriter.WriteWarning(System.String)"> <summary> Core method to hand off warning messages to logger. </summary> <param name="message">A message to log</param> </member> <member name="M:PSRule.Pipeline.Output.HostPipelineWriter.WriteInformation(System.Management.Automation.InformationRecord)"> <summary> Core method to hand off information messages to logger. </summary> </member> <member name="M:PSRule.Pipeline.Output.HostPipelineWriter.WriteDebug(System.String,System.Object[])"> <summary> Core method to hand off debug messages to logger. </summary> </member> <member name="M:PSRule.Pipeline.Output.SarifBuilder.GetVersionControl(PSRule.Configuration.RepositoryOption)"> <summary> Get information from version control system. </summary> <remarks> https://docs.oasis-open.org/sarif/sarif/v2.1.0/os/sarif-v2.1.0-os.html#_Toc34317497 </remarks> </member> <member name="P:PSRule.Pipeline.PathBuilder.Count"> <summary> The number of files found. </summary> </member> <member name="M:PSRule.Pipeline.PathBuilder.GetSearchParameters(System.String,System.String@,System.IO.SearchOption@,PSRule.Pipeline.PathFilter@)"> <summary> Split a search path into components based on wildcards. </summary> </member> <member name="M:PSRule.Pipeline.PathBuilder.TrimPath(System.String,System.Boolean@)"> <summary> Remove leading ./ or .\ characters indicating a relative path anchor. </summary> <param name="path">The path to trim.</param> <param name="relativeAnchor">Returns true when a relative path anchor was present.</param> <returns>Return a clean path without the relative path anchor.</returns> </member> <member name="M:PSRule.Pipeline.PathBuilder.UseSimpleSearch(System.String)"> <summary> Determines if a simple search can be used. </summary> </member> <member name="T:PSRule.Pipeline.PathFilter"> <summary> Filters paths based on predefined rules. </summary> </member> <member name="M:PSRule.Pipeline.PathFilter.PathStream.Reset"> <summary> Resets the cursor to the start of the path stream. </summary> </member> <member name="M:PSRule.Pipeline.PathFilter.PathStream.Next"> <summary> Move to the next character. </summary> </member> <member name="M:PSRule.Pipeline.PathFilter.PathStream.IsAnyMatchEnding(System.Int32)"> <summary> Determine if the current character sequence is ** or **/. </summary> </member> <member name="M:PSRule.Pipeline.PathFilter.PathStream.IsWildcardAA(System.Int32)"> <summary> Determine if the current character sequence is **. </summary> </member> <member name="M:PSRule.Pipeline.PathFilter.PathStream.TryMatchAA(PSRule.Pipeline.PathFilter.PathStream,System.Int32)"> <summary> Match ** </summary> </member> <member name="M:PSRule.Pipeline.PathFilter.PathStream.TryMatchA(PSRule.Pipeline.PathFilter.PathStream,System.Int32)"> <summary> Match * </summary> </member> <member name="M:PSRule.Pipeline.PathFilter.PathFilterExpression.Match(System.String,System.Boolean@)"> <summary> Determine if the path matches the expression. </summary> </member> <member name="M:PSRule.Pipeline.PathFilter.PathFilterExpression.Match(System.String)"> <summary> Determines if the path matches the expression. </summary> </member> <member name="M:PSRule.Pipeline.PathFilter.Match(System.String)"> <summary> Determine if the specific path is matched. </summary> <param name="path">The path to evaluate.</param> </member> <member name="T:PSRule.Pipeline.PipelineBuilder"> <summary> A helper to create a PowerShell-based pipeline for running PSRule. </summary> </member> <member name="M:PSRule.Pipeline.PipelineBuilder.Assert(PSRule.Pipeline.Source[],PSRule.Configuration.PSRuleOption,PSRule.Pipeline.IHostContext)"> <summary> Create a builder for an Assert pipeline. Used by Assert-PSRule. </summary> <remarks> Assert pipelines process objects with rules and produce text-based output suitable for output to a CI pipeline. </remarks> <param name="source">An array of sources.</param> <param name="option">Options that configure PSRule.</param> <param name="hostContext">An implementation of a host context that will recieve output and results.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Pipeline.PipelineBuilder.Invoke(PSRule.Pipeline.Source[],PSRule.Configuration.PSRuleOption,PSRule.Pipeline.IHostContext)"> <summary> Create a builder for an Invoke pipeline. Used by Invoke-PSRule. </summary> <remarks> Invoke piplines process objects and produce records indicating the outcome of each rule. </remarks> <param name="source">An array of sources.</param> <param name="option">Options that configure PSRule.</param> <param name="hostContext">An implementation of a host context that will recieve output and results.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Pipeline.PipelineBuilder.Test(PSRule.Pipeline.Source[],PSRule.Configuration.PSRuleOption,PSRule.Pipeline.IHostContext)"> <summary> Create a builder for a Test pipeline. Used by Test-PSRule. </summary> <remarks> Test piplines process objects and true or false the outcome of each rule. </remarks> <param name="source">An array of sources.</param> <param name="option">Options that configure PSRule.</param> <param name="hostContext">An implementation of a host context that will recieve output and results.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Pipeline.PipelineBuilder.Get(PSRule.Pipeline.Source[],PSRule.Configuration.PSRuleOption,PSRule.Pipeline.IHostContext)"> <summary> Create a builder for a Get pipeline. Used by Get-PSRule. </summary> <remarks> Get pipelines list rules that are discovered by PSRule either in modules or as standalone rules. </remarks> <param name="source">An array of sources.</param> <param name="option">Options that configure PSRule.</param> <param name="hostContext">An implementation of a host context that will recieve output and results.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Pipeline.PipelineBuilder.GetHelp(PSRule.Pipeline.Source[],PSRule.Configuration.PSRuleOption,PSRule.Pipeline.IHostContext)"> <summary> Create a builder for a help pipeline. Used by Get-PSRuleHelp. </summary> <remarks> Gets command lines help content for all or specific rules. </remarks> <param name="source">An array of sources.</param> <param name="option">Options that configure PSRule.</param> <param name="hostContext">An implementation of a host context that will recieve output and results.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Pipeline.PipelineBuilder.RuleSource(PSRule.Configuration.PSRuleOption,PSRule.Pipeline.IHostContext)"> <summary> Create a builder to define a list of rule sources. </summary> <param name="option">>Options that configure PSRule.</param> <param name="hostContext">>An implementation of a host context that will recieve output and results.</param> <returns>A builder object to configure the source pipeline.</returns> </member> <member name="M:PSRule.Pipeline.PipelineBuilder.GetBaseline(PSRule.Pipeline.Source[],PSRule.Configuration.PSRuleOption,PSRule.Pipeline.IHostContext)"> <summary> Create a builder for a get baseline pipeline. Used by Get-PSRuleBaseline. </summary> <param name="source">An array of sources.</param> <param name="option">Options that configure PSRule.</param> <param name="hostContext">An implementation of a host context that will recieve output and results.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Pipeline.PipelineBuilder.ExportBaseline(PSRule.Pipeline.Source[],PSRule.Configuration.PSRuleOption,PSRule.Pipeline.IHostContext)"> <summary> Create a builder for an export baseline pipeline. Used by Export-PSRuleBaseline. </summary> <param name="source">An array of sources.</param> <param name="option">Options that configure PSRule.</param> <param name="hostContext">An implementation of a host context that will recieve output and results.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Pipeline.PipelineBuilder.GetTarget(PSRule.Configuration.PSRuleOption,PSRule.Pipeline.IHostContext)"> <summary> Create a builder for a target pipeline. Used by Get-PSRuleTarget. </summary> <param name="option">Options that configure PSRule.</param> <param name="hostContext">An implementation of a host context that will recieve output and results.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="T:PSRule.Pipeline.IPipelineBuilder"> <summary> A helper to build a PSRule pipeline. </summary> </member> <member name="M:PSRule.Pipeline.IPipelineBuilder.Configure(PSRule.Configuration.PSRuleOption)"> <summary> Configure the pipeline with options. </summary> </member> <member name="M:PSRule.Pipeline.IPipelineBuilder.Baseline(PSRule.Configuration.BaselineOption)"> <summary> Configure the pipeline to use a specific baseline. </summary> <param name="baseline">A baseline option or the name of a baseline.</param> </member> <member name="M:PSRule.Pipeline.IPipelineBuilder.Build(PSRule.Pipeline.IPipelineWriter)"> <summary> Build the pipeline. </summary> <param name="writer">Optionally specify a custom writer which will handle output processing.</param> </member> <member name="T:PSRule.Pipeline.IPipeline"> <summary> An instance of a PSRule pipeline. </summary> </member> <member name="M:PSRule.Pipeline.IPipeline.Begin"> <summary> Initalize the pipeline and results. Call this method once prior to calling Process. </summary> </member> <member name="M:PSRule.Pipeline.IPipeline.Process(System.Management.Automation.PSObject)"> <summary> Process an object through the pipeline. Each object will be processed by rules that apply based on pre-conditions. </summary> <param name="sourceObject">The object to process.</param> </member> <member name="M:PSRule.Pipeline.IPipeline.End"> <summary> Clean up and flush pipeline results. Call this method once after processing any objects through the pipeline. </summary> </member> <member name="M:PSRule.Pipeline.PipelineBuilderBase.Name(System.String[])"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PipelineBuilderBase.Tag(System.Collections.Hashtable)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PipelineBuilderBase.Convention(System.String[])"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PipelineBuilderBase.Configure(PSRule.Configuration.PSRuleOption)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PipelineBuilderBase.Build(PSRule.Pipeline.IPipelineWriter)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PipelineBuilderBase.UseBaseline(PSRule.Configuration.BaselineOption)"> <summary> Use a baseline, either by name or by path. </summary> </member> <member name="M:PSRule.Pipeline.PipelineBuilderBase.Baseline(PSRule.Configuration.BaselineOption)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.PipelineBuilderBase.RequireModules"> <summary> Require correct module versions for pipeline execution. </summary> </member> <member name="M:PSRule.Pipeline.PipelineBuilderBase.RequireSources"> <summary> Require sources for pipeline execution. </summary> </member> <member name="M:PSRule.Pipeline.PipelineBuilderBase.GetExecutionOption(PSRule.Configuration.ExecutionOption)"> <summary> Coalesce execution options with defaults. </summary> </member> <member name="M:PSRule.Pipeline.PipelineBuilderBase.NormalizeJsonIndentRange(System.Nullable{System.Int32})"> <summary> Normalizes JSON indent range between minimum 0 and maximum 4. </summary> <param name="jsonIndent"></param> <returns>The number of characters to indent.</returns> </member> <member name="M:PSRule.Pipeline.PipelineContext.ReportIssue(PSRule.Runtime.RunspaceContext)"> <summary> Report any tracked issues. </summary> </member> <member name="T:PSRule.Pipeline.PipelineExtensions"> <summary> Extension methods for the PSRule pipelines. </summary> </member> <member name="M:PSRule.Pipeline.PipelineExtensions.Process(PSRule.Pipeline.IPipeline,System.Object)"> <summary> Process an object through the pipeline. Each object will be processed by rules that apply based on pre-conditions. </summary> <param name="pipeline">An instance of a PSRule pipeline.</param> <param name="sourceObject">The object to process.</param> </member> <member name="T:PSRule.Pipeline.PipelineHookActions"> <summary> Define built-in binding hooks. </summary> </member> <member name="M:PSRule.Pipeline.PipelineHookActions.DefaultTargetNameBinding(System.Object)"> <summary> Get the TargetName of the object by looking for a TargetName or Name property. </summary> <param name="targetObject">A PSObject to bind.</param> <returns>The TargetName of the object.</returns> </member> <member name="M:PSRule.Pipeline.PipelineHookActions.CustomTargetPropertyBinding(System.String[],System.Boolean,System.Object,PSRule.Configuration.BindTargetName,System.String@)"> <summary> Get the TargetName of the object by using any of the specified property names. </summary> <param name="propertyNames">One or more property names to use to bind TargetName.</param> <param name="caseSensitive">Determines if binding properties are case-sensitive.</param> <param name="targetObject">A PSObject to bind.</param> <param name="next">The next delegate function to check if all of the property names can not be found.</param> <param name="path">The object path that was used for binding.</param> <returns>The TargetName of the object.</returns> </member> <member name="M:PSRule.Pipeline.PipelineHookActions.NestedTargetPropertyBinding(System.String[],System.Boolean,System.Object,PSRule.Configuration.BindTargetName,System.String@)"> <summary> Get the TargetName of the object by using any of the specified property names. </summary> <param name="propertyNames">One or more property names to use to bind TargetName.</param> <param name="caseSensitive">Determines if binding properties are case-sensitive.</param> <param name="targetObject">A PSObject to bind.</param> <param name="next">The next delegate function to check if all of the property names can not be found.</param> <param name="path">The object path that was used for binding.</param> <returns>The TargetName of the object.</returns> </member> <member name="M:PSRule.Pipeline.PipelineHookActions.GetUnboundObjectTargetName(System.Object)"> <summary> Calculate a SHA1 hash for an object to use as TargetName. </summary> <param name="targetObject">A PSObject to hash.</param> <returns>The TargetName of the object.</returns> </member> <member name="M:PSRule.Pipeline.PipelineHookActions.TryGetTargetName(System.Object,System.String,System.String@)"> <summary> Try to get TargetName from specified property. </summary> </member> <member name="M:PSRule.Pipeline.PipelineHookActions.DefaultTargetTypeBinding(System.Object)"> <summary> Get the TargetType by reading TypeNames of the PSObject. </summary> <param name="targetObject">A PSObject to bind.</param> <returns>The TargetObject of the object.</returns> </member> <member name="M:PSRule.Pipeline.PipelineLogger.DoWriteError(System.Management.Automation.ErrorRecord)"> <summary> Core methods to hand off to logger. </summary> <param name="errorRecord">A valid PowerShell error record.</param> </member> <member name="M:PSRule.Pipeline.PipelineLogger.DoWriteVerbose(System.String)"> <summary> Core method to hand off verbose messages to logger. </summary> <param name="message">A message to log.</param> </member> <member name="M:PSRule.Pipeline.PipelineLogger.DoWriteWarning(System.String)"> <summary> Core method to hand off warning messages to logger. </summary> <param name="message">A message to log</param> </member> <member name="M:PSRule.Pipeline.PipelineLogger.DoWriteInformation(System.Management.Automation.InformationRecord)"> <summary> Core method to hand off information messages to logger. </summary> </member> <member name="M:PSRule.Pipeline.PipelineLogger.DoWriteDebug(System.Management.Automation.DebugRecord)"> <summary> Core method to hand off debug messages to logger. </summary> </member> <member name="M:PSRule.Pipeline.PipelineReader.Add(System.String)"> <summary> Add a path to the list of inputs. </summary> <param name="path">The path of files to add.</param> </member> <member name="T:PSRule.Pipeline.PipelineWriterExtensions"> <summary> Extensions for the <see cref="T:PSRule.Pipeline.IPipelineWriter"/>. </summary> </member> <member name="M:PSRule.Pipeline.RulePipeline.Begin"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.RulePipeline.Process(System.Management.Automation.PSObject)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.RulePipeline.End"> <inheritdoc/> </member> <member name="T:PSRule.Pipeline.SourceType"> <summary> The type of source file. </summary> </member> <member name="F:PSRule.Pipeline.SourceType.Script"> <summary> PowerShell script file. </summary> </member> <member name="F:PSRule.Pipeline.SourceType.Yaml"> <summary> YAML file. </summary> </member> <member name="F:PSRule.Pipeline.SourceType.Json"> <summary> JSON or JSON with comments file. </summary> </member> <member name="T:PSRule.Pipeline.SourceFile"> <summary> A source file containing resources that will be loaded and interpreted by PSRule. </summary> </member> <member name="M:PSRule.Pipeline.SourceFile.#ctor(System.String,System.String,PSRule.Pipeline.SourceType,System.String)"> <summary> Create an instance of a PSRule source. </summary> <param name="path">The file path to the source.</param> <param name="module">The name of the module if the source was loaded from a module.</param> <param name="type">The type of source file.</param> <param name="helpPath">The base path to use for loading help content.</param> </member> <member name="P:PSRule.Pipeline.SourceFile.Path"> <summary> The file path to the source. </summary> </member> <member name="P:PSRule.Pipeline.SourceFile.Module"> <summary> The name of the module if the source was loaded from a module. </summary> </member> <member name="P:PSRule.Pipeline.SourceFile.ModuleName"> <summary> The name of the module if the source was loaded from a module. </summary> </member> <member name="P:PSRule.Pipeline.SourceFile.Type"> <summary> The type of source file. </summary> </member> <member name="P:PSRule.Pipeline.SourceFile.HelpPath"> <summary> The base path to use for loading help content. </summary> </member> <member name="T:PSRule.Pipeline.Source"> <summary> A PSRule source containing one or more source files. </summary> </member> <member name="P:PSRule.Pipeline.Source.Path"> <summary> The base path of the source. </summary> </member> <member name="P:PSRule.Pipeline.Source.File"> <summary> An array of source files. </summary> </member> <member name="T:PSRule.Pipeline.ISourcePipelineBuilder"> <summary> A helper to build a list of sources for a PowerShell pipeline. </summary> </member> <member name="P:PSRule.Pipeline.ISourcePipelineBuilder.ShouldLoadModule"> <summary> Determines if PowerShell should automatically load the module. </summary> </member> <member name="M:PSRule.Pipeline.ISourcePipelineBuilder.VerboseScanSource(System.String)"> <summary> Log a verbose message for scanning sources. </summary> </member> <member name="M:PSRule.Pipeline.ISourcePipelineBuilder.VerboseFoundModules(System.Int32)"> <summary> Log a verbose message for source modules. </summary> </member> <member name="M:PSRule.Pipeline.ISourcePipelineBuilder.VerboseScanModule(System.String)"> <summary> Log a verbose message for scanning for modules. </summary> </member> <member name="M:PSRule.Pipeline.ISourcePipelineBuilder.Directory(System.String[],System.Boolean)"> <summary> Add loose files as a source. </summary> <param name="path">An array of file or directory paths containing one or more rule files.</param> <param name="excludeDefaultRulePath">Determine if the default rule path is excluded. When set to <c>true</c> the default rule path is excluded.</param> </member> <member name="M:PSRule.Pipeline.ISourcePipelineBuilder.Directory(System.String,System.Boolean)"> <summary> Add loose files as a source. </summary> <param name="path">A file or directory path containing one or more rule files.</param> <param name="excludeDefaultRulePath">Determine if the default rule path is excluded. When set to <c>true</c> the default rule path is excluded.</param> </member> <member name="M:PSRule.Pipeline.ISourcePipelineBuilder.Module(System.Management.Automation.PSModuleInfo[])"> <summary> Add a module source. </summary> <param name="module">The module info.</param> </member> <member name="M:PSRule.Pipeline.ISourcePipelineBuilder.Build"> <summary> Build a list of sources for executing within PSRule. </summary> <returns>A list of sources.</returns> </member> <member name="T:PSRule.Pipeline.ISourceCommandlineBuilder"> <summary> A helper to build a list of sources for a command-line tool pipeline. </summary> </member> <member name="M:PSRule.Pipeline.ISourceCommandlineBuilder.Directory(System.String[],System.Boolean)"> <summary> Add loose files as a source. </summary> <param name="path">An array of file or directory paths containing one or more rule files.</param> <param name="excludeDefaultRulePath">Determine if the default rule path is excluded. When set to <c>true</c> the default rule path is excluded.</param> </member> <member name="M:PSRule.Pipeline.ISourceCommandlineBuilder.Directory(System.String,System.Boolean)"> <summary> Add loose files as a source. </summary> <param name="path">A file or directory path containing one or more rule files.</param> <param name="excludeDefaultRulePath">Determine if the default rule path is excluded. When set to <c>true</c> the default rule path is excluded.</param> </member> <member name="M:PSRule.Pipeline.ISourceCommandlineBuilder.ModuleByName(System.String)"> <summary> Add a module source. </summary> <param name="name">The name of the module.</param> </member> <member name="M:PSRule.Pipeline.ISourceCommandlineBuilder.Build"> <summary> Build a list of sources for executing within PSRule. </summary> <returns>A list of sources.</returns> </member> <member name="T:PSRule.Pipeline.SourcePipelineBuilder"> <summary> A helper to build a list of rule sources for discovery. </summary> </member> <member name="P:PSRule.Pipeline.SourcePipelineBuilder.ShouldLoadModule"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.SourcePipelineBuilder.VerboseScanSource(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.SourcePipelineBuilder.VerboseFoundModules(System.Int32)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.SourcePipelineBuilder.VerboseScanModule(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.SourcePipelineBuilder.Directory(System.String[],System.Boolean)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.SourcePipelineBuilder.Directory(System.String,System.Boolean)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.SourcePipelineBuilder.Module(System.Management.Automation.PSModuleInfo[])"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.SourcePipelineBuilder.ModuleByName(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.SourcePipelineBuilder.TryPackagedModule(System.String,System.String@)"> <summary> Try to find a packaged module found relative to the tool. </summary> </member> <member name="M:PSRule.Pipeline.SourcePipelineBuilder.TryInstalledModule(System.String,System.String@)"> <summary> Try to find a module installed into PowerShell. </summary> </member> <member name="M:PSRule.Pipeline.SourcePipelineBuilder.Module(System.Management.Automation.PSModuleInfo,System.Boolean)"> <summary> Add a module source </summary> <param name="module">The module info.</param> <param name="dependency">Flags the source as only a dependency.</param> </member> <member name="M:PSRule.Pipeline.SourcePipelineBuilder.Build"> <inheritdoc/> </member> <member name="T:PSRule.Pipeline.ITargetBinder"> <summary> Responsible for handling binding for a given target object. </summary> </member> <member name="T:PSRule.Pipeline.ITargetBindingContext"> <summary> A binding context specific to a language scope. </summary> </member> <member name="P:PSRule.Pipeline.ITargetBindingResult.TargetName"> <summary> The bound TargetName of the target object. </summary> </member> <member name="P:PSRule.Pipeline.ITargetBindingResult.TargetType"> <summary> The bound TargetType of the target object. </summary> </member> <member name="P:PSRule.Pipeline.ITargetBindingResult.Field"> <summary> Additional bound fields of the target object. </summary> </member> <member name="T:PSRule.Pipeline.TargetBinderBuilder"> <summary> Builds a TargetBinder. </summary> </member> <member name="M:PSRule.Pipeline.TargetBinderBuilder.Build"> <summary> Build a TargetBinder. </summary> </member> <member name="M:PSRule.Pipeline.TargetBinderBuilder.With(PSRule.Pipeline.ITargetBindingContext)"> <summary> Add a target binding context. </summary> </member> <member name="M:PSRule.Pipeline.TargetBinderBuilder.With(System.String,PSRule.Pipeline.IBindingOption)"> <summary> Add a target binding context. </summary> </member> <member name="T:PSRule.Pipeline.TargetBinder"> <summary> Responsible for handling binding for a given target object. </summary> </member> <member name="P:PSRule.Pipeline.TargetBinder.TargetBindingResult.TargetName"> <inheritdoc/> </member> <member name="P:PSRule.Pipeline.TargetBinder.TargetBindingResult.TargetNamePath"> <inheritdoc/> </member> <member name="P:PSRule.Pipeline.TargetBinder.TargetBindingResult.TargetType"> <inheritdoc/> </member> <member name="P:PSRule.Pipeline.TargetBinder.TargetBindingResult.TargetTypePath"> <inheritdoc/> </member> <member name="P:PSRule.Pipeline.TargetBinder.TargetBindingResult.ShouldFilter"> <inheritdoc/> </member> <member name="P:PSRule.Pipeline.TargetBinder.TargetBindingResult.Field"> <inheritdoc/> </member> <member name="M:PSRule.Pipeline.TargetBinder.Bind(PSRule.Pipeline.TargetObject)"> <summary> Bind target object based on the supplied baseline. </summary> </member> <member name="M:PSRule.Pipeline.TargetBinder.BindField(PSRule.Configuration.BindTargetMethod,PSRule.Configuration.FieldMap[],System.Boolean,System.Object)"> <summary> Bind additional fields. </summary> </member> <member name="T:PSRule.Pipeline.TargetObject"> <summary> An object processed by PSRule. </summary> </member> <member name="T:PSRule.Resources.DocumentStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSRule.Resources.DocumentStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSRule.Resources.DocumentStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PSRule.Resources.DocumentStrings.Description"> <summary> Looks up a localized string similar to DESCRIPTION. </summary> </member> <member name="P:PSRule.Resources.DocumentStrings.DisplayName"> <summary> Looks up a localized string similar to DISPLAY NAME. </summary> </member> <member name="P:PSRule.Resources.DocumentStrings.Links"> <summary> Looks up a localized string similar to LINKS. </summary> </member> <member name="P:PSRule.Resources.DocumentStrings.ModuleName"> <summary> Looks up a localized string similar to MODULE NAME. </summary> </member> <member name="P:PSRule.Resources.DocumentStrings.Name"> <summary> Looks up a localized string similar to NAME. </summary> </member> <member name="P:PSRule.Resources.DocumentStrings.Notes"> <summary> Looks up a localized string similar to NOTES. </summary> </member> <member name="P:PSRule.Resources.DocumentStrings.Recommendation"> <summary> Looks up a localized string similar to RECOMMENDATION. </summary> </member> <member name="P:PSRule.Resources.DocumentStrings.Synopsis"> <summary> Looks up a localized string similar to SYNOPSIS. </summary> </member> <member name="T:PSRule.Resources.FormatterStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Banner"> <summary> Looks up a localized string similar to ____ _____ ____ __\n / __ \/ ___// __ \__ __/ /__\n / /_/ /\__ \/ /_/ / / / / / _ \\n / ____/___/ / _, _/ /_/ / / __/\n/_/ /____/_/ |_|\__,_/_/\___/. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.FooterRuleCount"> <summary> Looks up a localized string similar to Rules processed: {0}, failed: {1}, errored: {2}. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.FooterRunInfo"> <summary> Looks up a localized string similar to Run {0} completed in {1}. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Help"> <summary> Looks up a localized string similar to | HELP:. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.HelpContribute"> <summary> Looks up a localized string similar to Contribute and find source: https://github.com/microsoft/PSRule. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.HelpDocs"> <summary> Looks up a localized string similar to Explore documentation: https://aka.ms/ps-rule. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.HelpIssues"> <summary> Looks up a localized string similar to Report issues: https://github.com/microsoft/PSRule/issues. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.HelpModule"> <summary> Looks up a localized string similar to {0}: {1}. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Message"> <summary> Looks up a localized string similar to | MESSAGE:. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.ModuleVersion"> <summary> Looks up a localized string similar to Using {0} v{1}. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Position"> <summary> Looks up a localized string similar to | POSITION:. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.PSRuleVersion"> <summary> Looks up a localized string similar to Using PSRule v{0}. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Reason"> <summary> Looks up a localized string similar to | REASON:. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Recommend"> <summary> Looks up a localized string similar to | RECOMMEND:. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Repository_Branch"> <summary> Looks up a localized string similar to on : {0}. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Repository_Revision"> <summary> Looks up a localized string similar to at : {0}. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Repository_Url"> <summary> Looks up a localized string similar to From repository: {0}. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Result_Error"> <summary> Looks up a localized string similar to [ERROR] . </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Result_ErrorDetail"> <summary> Looks up a localized string similar to {0} failed {1} with the error '{2}'.. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Result_ErrorDetailWithRef"> <summary> Looks up a localized string similar to {3}: {0} failed {1} with the error '{2}'.. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Result_Fail"> <summary> Looks up a localized string similar to [FAIL] . </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Result_FailDetail"> <summary> Looks up a localized string similar to {0} failed {1}. {2}. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Result_FailDetailWithRef"> <summary> Looks up a localized string similar to {3}: {0} failed {1}. {2}. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Result_Information"> <summary> Looks up a localized string similar to [INFO] . </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Result_Pass"> <summary> Looks up a localized string similar to [PASS] . </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.Result_Warning"> <summary> Looks up a localized string similar to [WARN] . </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.SourceAt"> <summary> Looks up a localized string similar to At. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.StackTrace"> <summary> Looks up a localized string similar to | STACK TRACE:. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.StartObjectPrefix"> <summary> Looks up a localized string similar to -> . </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.SynopsisPrefix"> <summary> Looks up a localized string similar to | SYNOPSIS: . </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.VSCode_Error"> <summary> Looks up a localized string similar to ERROR . </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.VSCode_Fail"> <summary> Looks up a localized string similar to FAIL . </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.VSCode_Help"> <summary> Looks up a localized string similar to Help:. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.VSCode_Pass"> <summary> Looks up a localized string similar to PASS . </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.VSCode_Reason"> <summary> Looks up a localized string similar to Reason:. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.VSCode_Recommend"> <summary> Looks up a localized string similar to Recommend:. </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.VSCode_StartObjectPrefix"> <summary> Looks up a localized string similar to > . </summary> </member> <member name="P:PSRule.Resources.FormatterStrings.VSCode_Warning"> <summary> Looks up a localized string similar to WARN . </summary> </member> <member name="T:PSRule.Resources.PSRuleResources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.AliasReference"> <summary> Looks up a localized string similar to The {0} resource '{1}' is currently referencing '{2}' using the alias '{3}'. Consider updating the reference to use name or id directly.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.AliasSuppression"> <summary> Looks up a localized string similar to Suppression for the rule '{0}' was configured using the alias '{1}'. Consider updating the suppression to use the name or id directly.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ArgumentFormatInvalid"> <summary> Looks up a localized string similar to The arguments for '{0}' are not in the expected format or type.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ArgumentInvalidBoolean"> <summary> Looks up a localized string similar to The argument '{0}' for '{1}' is not a valid boolean.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ArgumentInvalidInteger"> <summary> Looks up a localized string similar to The argument '{0}' for '{1}' is not a valid integer.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ArgumentInvalidString"> <summary> Looks up a localized string similar to The argument '{0}' for '{1}' is not a valid string.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ArgumentsOutOfRange"> <summary> Looks up a localized string similar to The number of arguments '{1}' is not within the allowed range for '{0}'.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.BaselineObsolete"> <summary> Looks up a localized string similar to The baseline '{0}' is obsolete. Consider switching to an alternative baseline.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ConstrainedTargetBinding"> <summary> Looks up a localized string similar to Binding functions are not supported in this language mode.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.DebugPropertyObsolete"> <summary> Looks up a localized string similar to {0}: The property '${1}.{2}' is obsolete and will be removed in the next major version.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.DebugTargetIfMismatch"> <summary> Looks up a localized string similar to Target failed If precondition. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.DebugTargetRuleMismatch"> <summary> Looks up a localized string similar to Target failed Rule precondition. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.DebugTargetSubselectorMismatch"> <summary> Looks up a localized string similar to Target failed sub-selector pre-condition.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.DebugTargetTypeMismatch"> <summary> Looks up a localized string similar to Target failed Type precondition. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.DependencyCircularReference"> <summary> Looks up a localized string similar to A circular rule dependency was detected. The rule '{0}' depends on '{1}' which also depend on '{0}'.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.DependencyNotFound"> <summary> Looks up a localized string similar to The dependency '{0}' for '{1}' could not be found. Check that the rule is defined in a .Rule.ps1 file within the search path.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.DuplicateResourceId"> <summary> Looks up a localized string similar to The resource '{0}' is using a duplicate resource identifier. A resource with the identifier '{1}' already exists. Each resource must have a unique name, ref, and aliases. See https://aka.ms/ps-rule/naming for guidance on naming within PSRule.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.DuplicateRuleName"> <summary> Looks up a localized string similar to A rule with the same name '{0}' already exists.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ErrorDetailMessage"> <summary> Looks up a localized string similar to {0} : Reported '{1}'. At {2}:{3} char:{4}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ErrorPipelineException"> <summary> Looks up a localized string similar to One or more errors occured.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ExistsTrue"> <summary> Looks up a localized string similar to Exists: {0}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ExpressionInvalid"> <summary> Looks up a localized string similar to Failed to parse expression. The expression may not be valid. Expression: "{0}". </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.FileSourceType"> <summary> Looks up a localized string similar to File. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.FoundModules"> <summary> Looks up a localized string similar to [PSRule][D] -- Found {0} PSRule module(s). </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.FunctionNotFound"> <summary> Looks up a localized string similar to The function "{0}" was not found.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.IndexInvalid"> <summary> Looks up a localized string similar to The language expression index '{0}' is not valid for the object.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.InfoOutputPath"> <summary> Looks up a localized string similar to Output written to the following file: '{0}'. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.InputAdded"> <summary> Looks up a localized string similar to The input path was added: {0}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.InvalidErrorAction"> <summary> Looks up a localized string similar to An invalid ErrorAction ({0}) was specified for rule at {1}. Ignore | Stop are supported.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.InvalidResourceName"> <summary> Looks up a localized string similar to The resource name '{0}' is not valid at {1}. Each resource name must be between 3-128 characters in length, must start and end with a letter or number, and only contain letters, numbers, hyphens, dots, or underscores. See https://aka.ms/ps-rule/naming for more information.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.InvalidRuleNesting"> <summary> Looks up a localized string similar to Rule nesting was detected for rule at {0}. Rules must not be nested.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.InvalidRuleResult"> <summary> Looks up a localized string similar to An invalid rule result was returned for {0}. Conditions must return boolean $True or $False.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.KeywordConditionScope"> <summary> Looks up a localized string similar to The keyword '{0}' can only be used within a Rule block.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.KeywordRuleScope"> <summary> Looks up a localized string similar to The keyword '{0}' can only be used within a Rule block or script precondition.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.KeywordSourceScope"> <summary> Looks up a localized string similar to The keyword '{0}' can not be nested in a Rule block.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.LanguageExpressionTraceP2"> <summary> Looks up a localized string similar to [PSRule][{0}][Trace] -- {1}: {2}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.LanguageExpressionTraceP3"> <summary> Looks up a localized string similar to [PSRule][{0}][Trace] -- {1}: {2} {1} {3}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.LaunchBrowser"> <summary> Looks up a localized string similar to Please open your browser to the following location: {0}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.MatchSingleName"> <summary> Looks up a localized string similar to Wildcard match requires exactly one name.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.MatchTrue"> <summary> Looks up a localized string similar to Matches: {0}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ModuleManifestBaseline"> <summary> Looks up a localized string similar to Update module '{0}' to set the default baseline using a module configuration resource instead. Configuring the default baseline via manifest will be removed in the next major version. See https://aka.ms/ps-rule/module-config.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ModuleNotFound"> <summary> Looks up a localized string similar to No valid module can be found with that name.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ObjectNotProcessed"> <summary> Looks up a localized string similar to Target object '{0}' has not been processed because no matching rules were found.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ObjectPathNotFound"> <summary> Looks up a localized string similar to Object path not found.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ObjectPathRecurseMaxDepth"> <summary> Looks up a localized string similar to The object path expression reached the maximum depth of {0} evaluating the path '{1}'.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.OptionsNotFound"> <summary> Looks up a localized string similar to Options file does not exist.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.OptionsSourceComment"> <summary> Looks up a localized string similar to # Source: {0}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.OutcomeError"> <summary> Looks up a localized string similar to Error. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.OutcomeFail"> <summary> Looks up a localized string similar to Fail. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.OutcomePass"> <summary> Looks up a localized string similar to Pass. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.OutcomeRuleFail"> <summary> Looks up a localized string similar to [FAIL] -- {0}:: Reported for '{1}'. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.OutcomeRulePass"> <summary> Looks up a localized string similar to [PASS] -- {0}:: Reported for '{1}'. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.OutcomeUnknown"> <summary> Looks up a localized string similar to Unknown. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.PropertyNotFound"> <summary> Looks up a localized string similar to The language expression property '{0}' doesn't exist.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.PropertyObsolete"> <summary> Looks up a localized string similar to The property '${0}.{1}' is obsolete and will be removed in the next major version.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ReadFileFailed"> <summary> Looks up a localized string similar to Failed to deserialize the file '{0}': {1}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ReadJsonFailed"> <summary> Looks up a localized string similar to Read JSON failed.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ReadJsonFailedExpectedToken"> <summary> Looks up a localized string similar to Read JSON failed because the token ({0}) was not expected.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RequiredVersionMismatch"> <summary> Looks up a localized string similar to The module version '{1}' for '{0}' does not match the required version '{2}'. To continue, first update the module to match the version requirement.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ResourceObsolete"> <summary> Looks up a localized string similar to The {0} '{1}' is obsolete. Consider switching to an alternative {0}.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleCountSuppressed"> <summary> Looks up a localized string similar to {0} rule/s were suppressed for '{1}'.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleErrorPipelineException"> <summary> Looks up a localized string similar to One or more rules reported errors.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleFailPipelineException"> <summary> Looks up a localized string similar to One or more rules reported failure.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleInconclusive"> <summary> Looks up a localized string similar to Inconclusive result reported for '{1}' @{0}.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleMatchTrace"> <summary> Looks up a localized string similar to [PSRule][R][Trace] -- {0}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleNotFound"> <summary> Looks up a localized string similar to Could not find a matching rule. Please check that Path, Name and Tag parameters are correct.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleParameterNotFound"> <summary> Looks up a localized string similar to Could not find required rule definition parameter '{0}' on rule at {1}.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RulePathNotFound"> <summary> Looks up a localized string similar to No matching .Rule.ps1 files were found. Rule definitions should be saved into script files with the .Rule.ps1 extension.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleStackTrace"> <summary> Looks up a localized string similar to at Rule '{0}', {1}: line {2}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleSuppressed"> <summary> Looks up a localized string similar to Rule '{0}' was suppressed for '{1}'.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleSuppressionGroup"> <summary> Looks up a localized string similar to Rule '{0}' was suppressed by suppression group '{1}' for '{2}'.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleSuppressionGroupCount"> <summary> Looks up a localized string similar to {0} rule/s were suppressed by suppression group '{1}' for '{2}'.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleSuppressionGroupExtended"> <summary> Looks up a localized string similar to Rule '{0}' was suppressed by suppression group '{1}' for '{2}'. {3}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.RuleSuppressionGroupExtendedCount"> <summary> Looks up a localized string similar to {0} rule/s were suppressed by suppression group '{1}' for '{2}'. {3}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ScanModule"> <summary> Looks up a localized string similar to [PSRule][D] -- Scanning for source files in module: {0}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ScanSource"> <summary> Looks up a localized string similar to [PSRule][D] -- Scanning for source files: {0}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ScriptNotFound"> <summary> Looks up a localized string similar to The script was not found.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.SelectorMatchTrace"> <summary> Looks up a localized string similar to [PSRule][S][Trace] -- {0}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.SerializeNullPSObject"> <summary> Looks up a localized string similar to Can not serialize a null PSObject.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ShouldCreatePath"> <summary> Looks up a localized string similar to Create path. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.ShouldWriteFile"> <summary> Looks up a localized string similar to Write file. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.SourceNotFound"> <summary> Looks up a localized string similar to The source was not found.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.UsingChangedFile"> <summary> Looks up a localized string similar to Using changed files: {0}. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.UsingInvariantCulture"> <summary> Looks up a localized string similar to Using invariant culture may cause rule infomation to be displayed incorrectly. Consider using -Culture or set the Output.Culture option.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.VariableConditionScope"> <summary> Looks up a localized string similar to The variable '${0}' can only be used within a Rule block.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.VersionConstraintInvalid"> <summary> Looks up a localized string similar to The version constraint '{0}' is not valid.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.WithinLikeNotString"> <summary> Looks up a localized string similar to The Within parameter Value must be a string when the Like parameter is used.. </summary> </member> <member name="P:PSRule.Resources.PSRuleResources.WithinTrue"> <summary> Looks up a localized string similar to Within: {0}. </summary> </member> <member name="T:PSRule.Resources.ReasonStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_Contains"> <summary> Looks up a localized string similar to The value '{0}' contains '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_Count"> <summary> Looks up a localized string similar to The number of items is '{0}' instead of '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_DoesNotMatch"> <summary> Looks up a localized string similar to The value '{0}' does not match the expression '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_EndsWith"> <summary> Looks up a localized string similar to The value '{0}' ends with '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_Exists"> <summary> Looks up a localized string similar to Does not exist.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_IsLower"> <summary> Looks up a localized string similar to The value '{0}' does not contain only lowercase characters.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_IsNull"> <summary> Looks up a localized string similar to The value is null.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_IsNullOrEmpty"> <summary> Looks up a localized string similar to Is null or empty.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_IsSetTo"> <summary> Looks up a localized string similar to Is set to '{0}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_IsUpper"> <summary> Looks up a localized string similar to The value '{0}' does not contain only uppercase characters.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_Like"> <summary> Looks up a localized string similar to The value '{0}' is like '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_Matches"> <summary> Looks up a localized string similar to The value '{0}' matches the expression '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotArray"> <summary> Looks up a localized string similar to The value '{0}' is not an array.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotBoolean"> <summary> Looks up a localized string similar to The value '{0}' is not a boolean.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotComparedTo"> <summary> Looks up a localized string similar to The value '{0}' is not {1} {2}.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotContains"> <summary> Looks up a localized string similar to The value '{0}' does not contain any of {1}.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotCount"> <summary> Looks up a localized string similar to The number of items is '{0}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotDateTime"> <summary> Looks up a localized string similar to The value '{0}' is not a date.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotEndsWith"> <summary> Looks up a localized string similar to The value '{0}' does not end with any of {1}.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotExists"> <summary> Looks up a localized string similar to Exists.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotInSet"> <summary> Looks up a localized string similar to The value '{0}' was not in {1}.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotInteger"> <summary> Looks up a localized string similar to The value '{0}' is not an integer.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotLike"> <summary> Looks up a localized string similar to The value '{0}' is not like '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotNumeric"> <summary> Looks up a localized string similar to The value '{0}' is not numeric.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotSpecifiedSchema"> <summary> Looks up a localized string similar to None of the specified schemas match '{0}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotStartsWith"> <summary> Looks up a localized string similar to The value '{0}' does not start with any of {1}.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_NotString"> <summary> Looks up a localized string similar to The value '{0}' is not a string.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Assert_StartsWith"> <summary> Looks up a localized string similar to The value '{0}' starts with '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Compare"> <summary> Looks up a localized string similar to The field value '{0}' can not be compared with '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Contains"> <summary> Looks up a localized string similar to The field '{0}' does not contain '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Count"> <summary> Looks up a localized string similar to The field '{0}' has '{1}' items instead of '{2}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.EndsWith"> <summary> Looks up a localized string similar to The field '{0}' does not end with '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Exists"> <summary> Looks up a localized string similar to None of the field(s) existed: {0}. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.ExistsNot"> <summary> Looks up a localized string similar to The field(s) existed: {0}. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.FileHeader"> <summary> Looks up a localized string similar to The header was not set.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.FilePath"> <summary> Looks up a localized string similar to The file '{0}' does not exist.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Greater"> <summary> Looks up a localized string similar to The value '{0}' was not > '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.GreaterOrEqual"> <summary> Looks up a localized string similar to The value '{0}' was not >= '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.HasExpectedFieldValue"> <summary> Looks up a localized string similar to The field '{0}' is set to '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.HasField"> <summary> Looks up a localized string similar to The field '{0}' exists.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.HasJsonSchema"> <summary> Looks up a localized string similar to None of the specified schemas match '{0}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.In"> <summary> Looks up a localized string similar to The field value '{0}' was not included in the set.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.IsLetter"> <summary> Looks up a localized string similar to The value '{0}' does not contain only letters.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.JsonSchemaInvalid"> <summary> Looks up a localized string similar to Failed schema validation on {0}. {1}. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.JsonSchemaNotFound"> <summary> Looks up a localized string similar to The JSON schema '{0}' could not be found.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Less"> <summary> Looks up a localized string similar to The value '{0}' was not < '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.LessOrEqual"> <summary> Looks up a localized string similar to The value '{0}' was not <= '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Match"> <summary> Looks up a localized string similar to None of the regex(s) matched: {0}. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.MatchNot"> <summary> Looks up a localized string similar to The regex '{0}' matched.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.MatchPattern"> <summary> Looks up a localized string similar to The field value '{0}' does not match the pattern '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.NotCount"> <summary> Looks up a localized string similar to The field '{0}' has '{1}' items instead of not '{2}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.NotEnumerable"> <summary> Looks up a localized string similar to The field '{0}' is not enumerable.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.NotHasField"> <summary> Looks up a localized string similar to The field '{0}' does not exist.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.NotHasFieldValue"> <summary> Looks up a localized string similar to The value of '{0}' is null or empty.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.NotIn"> <summary> Looks up a localized string similar to The field value '{0}' was in the set.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.NotMatchPattern"> <summary> Looks up a localized string similar to The field value '{0}' matches the pattern '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.NotNull"> <summary> Looks up a localized string similar to The field value '{0}' is not null.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.NotWithinPath"> <summary> Looks up a localized string similar to The file '{0}' is within the path '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Null"> <summary> Looks up a localized string similar to The field value '{0}' is null.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.NullOrEmpty"> <summary> Looks up a localized string similar to The field '{0}' is not empty.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.NullOrEmptyParameter"> <summary> Looks up a localized string similar to The parameter '{0}' is null or empty.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.NullParameter"> <summary> Looks up a localized string similar to The parameter '{0}' is null.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.ResultsNotProvided"> <summary> Looks up a localized string similar to No results were provided.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.StartsWith"> <summary> Looks up a localized string similar to The field '{0}' does not start with '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.String"> <summary> Looks up a localized string similar to The field value '{0}' is not a string.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Subset"> <summary> Looks up a localized string similar to The field '{0}' did not contain '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.SubsetDuplicate"> <summary> Looks up a localized string similar to The field '{0}' included multiple instances of '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Type"> <summary> Looks up a localized string similar to The field value '{2}' of type {1} is not {0}.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.TypeInteger"> <summary> Looks up a localized string similar to The field value '{1}' of type {0} is not an integer.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.TypeNumeric"> <summary> Looks up a localized string similar to The field value '{1}' of type {0} is not numeric.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.TypeOf"> <summary> Looks up a localized string similar to None of the type name(s) match: {0}. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Version"> <summary> Looks up a localized string similar to The field value '{0}' is not a version string.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.VersionContraint"> <summary> Looks up a localized string similar to The version '{0}' does not match the constraint '{1}'.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.Within"> <summary> Looks up a localized string similar to The field value didn't match the set.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.WithinNot"> <summary> Looks up a localized string similar to The value '{0}' was within the set.. </summary> </member> <member name="P:PSRule.Resources.ReasonStrings.WithinPath"> <summary> Looks up a localized string similar to The file '{0}' is not within the path '{1}'.. </summary> </member> <member name="T:PSRule.Resources.ReportStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.Markdown_Links"> <summary> Looks up a localized string similar to Related resources. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.Markdown_Outcome"> <summary> Looks up a localized string similar to Outcome. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.Markdown_Recommendation"> <summary> Looks up a localized string similar to Recommendation. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.Markdown_Results"> <summary> Looks up a localized string similar to Result summary. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.Markdown_ResultText"> <summary> Looks up a localized string similar to The following results were reported.. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.Markdown_TargetName"> <summary> Looks up a localized string similar to Name. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.Markdown_TargetType"> <summary> Looks up a localized string similar to Type. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.NUnit_DetailsLink"> <summary> Looks up a localized string similar to See details [online]({0}).. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.NUnit_ReportedReasons"> <summary> Looks up a localized string similar to The following reasons were reported:. </summary> </member> <member name="P:PSRule.Resources.ReportStrings.SARIF_REPOROOT_Description"> <summary> Looks up a localized string similar to The directory into which the repo was cloned.. </summary> </member> <member name="T:PSRule.Resources.ViewStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Description"> <summary> Looks up a localized string similar to Description. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Fail"> <summary> Looks up a localized string similar to Fail. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Message"> <summary> Looks up a localized string similar to Message. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Module"> <summary> Looks up a localized string similar to Module. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.ModuleName"> <summary> Looks up a localized string similar to ModuleName. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Name"> <summary> Looks up a localized string similar to Name. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.OptionsComment"> <summary> Looks up a localized string similar to # PSRule options. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Outcome"> <summary> Looks up a localized string similar to Outcome. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.OutcomeReason"> <summary> Looks up a localized string similar to OutcomeReason. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Pass"> <summary> Looks up a localized string similar to Pass. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Reason"> <summary> Looks up a localized string similar to Reason. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Recommendation"> <summary> Looks up a localized string similar to Recommendation. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.RuleName"> <summary> Looks up a localized string similar to RuleName. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Synopsis"> <summary> Looks up a localized string similar to Synopsis. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.Tag"> <summary> Looks up a localized string similar to Tag. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.TargetName"> <summary> Looks up a localized string similar to TargetName. </summary> </member> <member name="P:PSRule.Resources.ViewStrings.TargetType"> <summary> Looks up a localized string similar to TargetType. </summary> </member> <member name="T:PSRule.Rules.ErrorInfo"> <summary> Information about an error that occurred within PSRule. </summary> </member> <member name="P:PSRule.Rules.ErrorInfo.Message"> <summary> An error message describing the issue. </summary> </member> <member name="P:PSRule.Rules.ErrorInfo.ScriptStackTrace"> <summary> A PSRule script stack trace. </summary> </member> <member name="P:PSRule.Rules.ErrorInfo.ErrorId"> <summary> A fully qualified identifier of the error. </summary> </member> <member name="P:PSRule.Rules.ErrorInfo.Exception"> <summary> The related error exception. </summary> </member> <member name="P:PSRule.Rules.ErrorInfo.ExceptionType"> <summary> The exception type. </summary> </member> <member name="P:PSRule.Rules.ErrorInfo.Category"> <summary> The error category. </summary> </member> <member name="P:PSRule.Rules.ErrorInfo.PositionMessage"> <summary> A positional message for the error. </summary> </member> <member name="P:PSRule.Rules.ErrorInfo.ScriptExtent"> <summary> The extent for the error. </summary> </member> <member name="T:PSRule.Rules.Rule"> <summary> Define a single rule. </summary> </member> <member name="P:PSRule.Rules.Rule.Id"> <summary> A unique identifier for the rule. </summary> </member> <member name="P:PSRule.Rules.Rule.Name"> <summary> The name of the rule. </summary> </member> <member name="P:PSRule.Rules.Rule.Level"> <summary> If the rule fails, how serious is the result. </summary> </member> <member name="P:PSRule.Rules.Rule.RuleId"> <summary> Legacy. A unique identifier for the rule. </summary> </member> <member name="P:PSRule.Rules.Rule.RuleName"> <summary> Legacy. The name of the rule. </summary> </member> <member name="P:PSRule.Rules.Rule.SourcePath"> <summary> The script file path where the rule is defined. </summary> </member> <member name="P:PSRule.Rules.Rule.ModuleName"> <summary> The name of the module where the rule is defined, or null if the rule is not defined in a module. </summary> </member> <member name="P:PSRule.Rules.Rule.Synopsis"> <summary> A human readable block of text, used to identify the purpose of the rule. </summary> </member> <member name="P:PSRule.Rules.Rule.Description"> <summary> Legacy. Alias to <see cref="P:PSRule.Rules.Rule.Synopsis"/>. </summary> </member> <member name="P:PSRule.Rules.Rule.Tag"> <summary> One or more tags assigned to the rule. Tags are additional metadata used to select rules to execute and identify results. </summary> </member> <member name="P:PSRule.Rules.Rule.Info"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Rule.Source"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Rule.DependsOn"> <summary> Other rules that must completed successfully before calling this rule. </summary> </member> <member name="P:PSRule.Rules.Rule.Flags"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Rule.Extent"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Rule.Labels"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Rule.Ref"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Rule.Alias"> <inheritdoc/> </member> <member name="T:PSRule.Rules.RuleBlock"> <summary> Define an instance of a rule block. Each rule block has a unique id. </summary> </member> <member name="P:PSRule.Rules.RuleBlock.Id"> <summary> A unique identifier for the rule. </summary> </member> <member name="P:PSRule.Rules.RuleBlock.Ref"> <inheritdoc/> </member> <member name="P:PSRule.Rules.RuleBlock.Alias"> <inheritdoc/> </member> <member name="P:PSRule.Rules.RuleBlock.Level"> <summary> If the rule fails, how serious is the result. </summary> </member> <member name="F:PSRule.Rules.RuleBlock.Name"> <summary> The name of the rule. </summary> </member> <member name="F:PSRule.Rules.RuleBlock.Condition"> <summary> The body of the rule definition where conditions are provided that either pass or fail the rule. </summary> </member> <member name="F:PSRule.Rules.RuleBlock.DependsOn"> <summary> Other rules that must completed successfully before calling this rule. </summary> </member> <member name="F:PSRule.Rules.RuleBlock.Tag"> <summary> Tags assigned to block. Tags are additional metadata used to select rules to execute and identify results. </summary> </member> <member name="P:PSRule.Rules.RuleBlock.Labels"> <inheritdoc/> </member> <member name="F:PSRule.Rules.RuleBlock.Configuration"> <summary> Configuration defaults for the rule definition. </summary> <remarks> These defaults are used when the value does not exist in the baseline configuration. </remarks> </member> <member name="P:PSRule.Rules.RuleBlock.Source"> <inheritdoc/> </member> <member name="P:PSRule.Rules.RuleBlock.Extent"> <inheritdoc/> </member> <member name="P:PSRule.Rules.RuleBlock.Flags"> <inheritdoc/> </member> <member name="T:PSRule.Rules.IRuleHelpInfoV2"> <summary> A rule help information structure. </summary> </member> <member name="P:PSRule.Rules.IRuleHelpInfoV2.Recommendation"> <summary> The rule recommendation. </summary> </member> <member name="P:PSRule.Rules.IRuleHelpInfoV2.Annotations"> <summary> Additional annotations, which are string key/ value pairs. </summary> </member> <member name="P:PSRule.Rules.IRuleHelpInfoV2.ModuleName"> <summary> The name of the module where the rule was loaded from. </summary> </member> <member name="P:PSRule.Rules.IRuleHelpInfoV2.Links"> <summary> Additional online links to reference information for the rule. </summary> </member> <member name="T:PSRule.Rules.RuleHelpInfoExtensions"> <summary> Extension methods for rule help information. </summary> </member> <member name="M:PSRule.Rules.RuleHelpInfoExtensions.GetOnlineHelpUri(PSRule.Rules.IRuleHelpInfoV2)"> <summary> Get the URI for the online version of the documentation. </summary> <returns>Returns the URI when a valid link is set, otherwise null is returned.</returns> </member> <member name="M:PSRule.Rules.RuleHelpInfoExtensions.GetOnlineHelpUrl(PSRule.Rules.IRuleHelpInfoV2)"> <summary> Get the URL for the online version of the documentation. </summary> <returns>Returns the URL when set, otherwise null is returned.</returns> </member> <member name="T:PSRule.Rules.Link"> <summary> An URL link to reference information. </summary> </member> <member name="P:PSRule.Rules.Link.Name"> <summary> The display name of the link. </summary> </member> <member name="P:PSRule.Rules.Link.Uri"> <summary> The URL to the information, or the target link. </summary> </member> <member name="T:PSRule.Rules.RuleHelpInfo"> <summary> Output view helper class for rule help. </summary> </member> <member name="P:PSRule.Rules.RuleHelpInfo.Name"> <summary> The name of the rule. </summary> </member> <member name="P:PSRule.Rules.RuleHelpInfo.DisplayName"> <summary> A localized display name for the rule. </summary> </member> <member name="P:PSRule.Rules.RuleHelpInfo.ModuleName"> <summary> The name of the module. </summary> <remarks> This will be null if the rule is not contained within a module. </remarks> </member> <member name="P:PSRule.Rules.RuleHelpInfo.Synopsis"> <summary> The synopsis of the rule. </summary> </member> <member name="P:PSRule.Rules.RuleHelpInfo.Description"> <summary> An extended description of the rule. </summary> </member> <member name="P:PSRule.Rules.RuleHelpInfo.Recommendation"> <summary> The recommendation for the rule. </summary> </member> <member name="P:PSRule.Rules.RuleHelpInfo.Notes"> <summary> Additional notes for the rule. </summary> </member> <member name="P:PSRule.Rules.RuleHelpInfo.Links"> <summary> Reference links for the rule. </summary> </member> <member name="P:PSRule.Rules.RuleHelpInfo.Annotations"> <summary> Metadata annotations for the rule. </summary> </member> <member name="M:PSRule.Rules.RuleHelpInfo.GetLinkString"> <summary> Get a view link string for display in rule help. </summary> </member> <member name="T:PSRule.Rules.RuleObject"> <summary> Defines a serialized rule object. </summary> </member> <member name="T:PSRule.Rules.RuleOutcome"> <summary> The outcome of a rule. </summary> </member> <member name="F:PSRule.Rules.RuleOutcome.None"> <summary> The rule was not evaluated. </summary> </member> <member name="F:PSRule.Rules.RuleOutcome.Fail"> <summary> The rule evaluated as false. </summary> </member> <member name="F:PSRule.Rules.RuleOutcome.Pass"> <summary> The rule evaluated as true. </summary> </member> <member name="F:PSRule.Rules.RuleOutcome.Error"> <summary> The rule returned an error. </summary> </member> <member name="F:PSRule.Rules.RuleOutcome.Processed"> <summary> Any outcome when the rule was processed. </summary> <remarks> This flag is used to filter outcomes with Invoke-PSRule. </remarks> </member> <member name="F:PSRule.Rules.RuleOutcome.Problem"> <summary> Any outcome that is considered a problem that should be addressed. </summary> </member> <member name="F:PSRule.Rules.RuleOutcome.All"> <summary> Any outcome. </summary> <remarks> This flag is used to filter outcomes with Invoke-PSRule. </remarks> </member> <member name="T:PSRule.Rules.RuleOutcomeReason"> <summary> The reason for the outcome of a rule. </summary> </member> <member name="F:PSRule.Rules.RuleOutcomeReason.None"> <summary> A reason was not specified. </summary> </member> <member name="F:PSRule.Rules.RuleOutcomeReason.Processed"> <summary> The rule was processed. </summary> <remarks> This reason is used with the Pass, Fail and Error outcomes. </remarks> </member> <member name="F:PSRule.Rules.RuleOutcomeReason.PreconditionFail"> <summary> The rule was not processed because the precondition returned false. </summary> <remarks> This reason is used with the None outcome. </remarks> </member> <member name="F:PSRule.Rules.RuleOutcomeReason.DependencyFail"> <summary> The rule was not processed because a dependency already returned an error or failed. </summary> <remarks> This reason is used with the None outcome. </remarks> </member> <member name="F:PSRule.Rules.RuleOutcomeReason.Inconclusive"> <summary> The rule was processed but didn't return pass or fail. </summary> <remarks> This reason is used with the Fail outcome. </remarks> </member> <member name="F:PSRule.Rules.RuleOutcomeReason.Suppressed"> <summary> The rule was not processed because the Target Name was suppressed. </summary> <remarks> This reason is used with the None outcome. </remarks> </member> <member name="T:PSRule.Rules.RuleRecord"> <summary> A detailed format for rule results. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.RunId"> <summary> A unique identifier for the run. </summary> </member> <member name="F:PSRule.Rules.RuleRecord.RuleId"> <summary> A unique identifier for the rule. </summary> <remarks> An additional opaque identifer may also be provided by by <see cref="P:PSRule.Rules.RuleRecord.Ref"/>. </remarks> </member> <member name="F:PSRule.Rules.RuleRecord.RuleName"> <summary> The name of the rule. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Ref"> <summary> A stable opaque unique identifier for the rule in addition to <see cref="F:PSRule.Rules.RuleRecord.RuleId"/>. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Level"> <summary> If the rule fails, how serious is the result. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Extent"> <summary> A source location for the rule that executed. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Outcome"> <summary> The outcome after the rule processes an object. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.OutcomeReason"> <summary> An additional reason code for the <see cref="P:PSRule.Rules.RuleRecord.Outcome"/>. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Recommendation"> <summary> A localized recommendation for the rule. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Reason"> <summary> The reason for the failed condition. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.TargetName"> <summary> A name to identify the target object. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.TargetType"> <summary> The type of the target object. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.TargetObject"> <summary> The current target object. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Data"> <summary> Custom data set by the rule for this target object. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Field"> <summary> A set of custom fields bound for the target object. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Tag"> <summary> Tags set for the rule. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Info"> <summary> Help info for the rule. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Time"> <summary> The execution time of the rule in millisecond. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Error"> <summary> Additional information if the rule errored. If the rule passed or failed this value is null. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Source"> <summary> Source of target object. </summary> </member> <member name="P:PSRule.Rules.RuleRecord.Detail"> <summary> Rule reason details. </summary> </member> <member name="M:PSRule.Rules.RuleRecord.IsSuccess"> <summary> Determine if the rule is successful or skipped. </summary> </member> <member name="M:PSRule.Rules.RuleRecord.IsProcessed"> <summary> Determine if the rule was executed and resulted in an outcome. </summary> </member> <member name="M:PSRule.Rules.RuleRecord.GetReasonViewString"> <summary> Gets a string for output views in PowerShell. </summary> <remarks> This method is called by PowerShell. </remarks> </member> <member name="T:PSRule.Rules.RuleSummaryRecord"> <summary> A summary format for rule results. </summary> </member> <member name="F:PSRule.Rules.RuleSummaryRecord.RuleId"> <summary> The unique identifier for the rule. </summary> </member> <member name="F:PSRule.Rules.RuleSummaryRecord.RuleName"> <summary> The name of the rule. </summary> </member> <member name="P:PSRule.Rules.RuleSummaryRecord.Pass"> <summary> The number of rule passes. </summary> </member> <member name="P:PSRule.Rules.RuleSummaryRecord.Fail"> <summary> The number of rule failures. </summary> </member> <member name="P:PSRule.Rules.RuleSummaryRecord.Error"> <summary> The number of rile errors. </summary> </member> <member name="P:PSRule.Rules.RuleSummaryRecord.Outcome"> <summary> The aggregate outcome after the rule processes all objects. </summary> </member> <member name="M:PSRule.Rules.SuppressionFilter.SuppressionKey.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Rules.SuppressionFilter.SuppressionKey.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.SuppressionFilter.TrySuppressionGroup(System.String,PSRule.Pipeline.TargetObject,PSRule.Definitions.ISuppressionInfo@)"> <summary> Attempts to fetch suppression group from rule suppression group index. </summary> <param name="ruleId">The key rule id which indexes suppression groups.</param> <param name="targetObject">The <seealso cref="T:PSRule.Pipeline.TargetObject"/> we are evaluating.</param> <param name="suppression">Information about a matching suppression group.</param> <returns>Boolean indicating if suppression group has been found.</returns> </member> <member name="M:PSRule.Rules.SuppressionFilter.IndexSuppressionGroups(System.Collections.Generic.IEnumerable{PSRule.Definitions.SuppressionGroups.SuppressionGroupVisitor})"> <summary> Index suppression groups by rule </summary> <param name="suppressionGroups">The suppression group collection</param> </member> <member name="M:PSRule.Rules.SuppressionFilter.AddSuppressionGroup(System.String,PSRule.Definitions.SuppressionGroups.SuppressionGroupVisitor)"> <summary> Add suppression group visitor to index </summary> </member> <member name="T:PSRule.Runtime.Assert"> <summary> A set of assertion helpers that are exposed at runtime through the $Assert variable. </summary> </member> <member name="M:PSRule.Runtime.Assert.Create(System.Boolean,System.String)"> <summary> Create a result based on a boolean <paramref name="condition"/>. </summary> <param name="condition">A boolean condition that passes when set to <c>true</c>, and fails when set to <c>false</c>.</param> <param name="reason">A localized reason why the assertion failed. This parameter is ignored if the assertion passed.</param> <returns>An assertion result.</returns> </member> <member name="M:PSRule.Runtime.Assert.Create(System.Boolean,System.String,System.Object[])"> <summary> Create a result based on a boolean <paramref name="condition"/>. </summary> <param name="condition">A boolean condition that passes when set to <c>true</c>, and fails when set to <c>false</c>.</param> <param name="reason">An unformatted localized reason why the assertion failed. This parameter is ignored if the assertion passed.</param> <param name="args">A list of arguments that are inserted into the format string.</param> <returns>An assertion result.</returns> </member> <member name="M:PSRule.Runtime.Assert.Create(System.String,System.Boolean,System.String,System.Object[])"> <summary> Create a result based on a boolean <paramref name="condition"/>. </summary> <param name="path">The object path that was reported by the assertion.</param> <param name="condition">A boolean condition that passes when set to <c>true</c>, and fails when set to <c>false</c>.</param> <param name="reason">An unformatted localized reason why the assertion failed. This parameter is ignored if the assertion passed.</param> <param name="args">A list of arguments that are inserted into the format string.</param> <returns>An assertion result.</returns> </member> <member name="M:PSRule.Runtime.Assert.Create(PSRule.Data.TargetIssueInfo[])"> <summary> Create a result based on issues reported downstream. </summary> <param name="issue">An array of issues reported downstream.</param> <returns>An assertion result.</returns> </member> <member name="M:PSRule.Runtime.Assert.Pass"> <summary> Create a passing assertion result. </summary> <returns>An assertion result.</returns> </member> <member name="M:PSRule.Runtime.Assert.Fail"> <summary> Create a failed assertion result. </summary> <returns>An assertion result.</returns> </member> <member name="M:PSRule.Runtime.Assert.Fail(System.String,System.Object[])"> <summary> Create a failed assertion result. </summary> <param name="reason">An unformatted localized reason why the assertion failed.</param> <param name="args">A list of arguments that are inserted into the format string.</param> <returns>An assertion result.</returns> </member> <member name="M:PSRule.Runtime.Assert.Fail(PSRule.Runtime.IOperand,System.String,System.Object[])"> <summary> Create a failed assertion result. </summary> <param name="operand">An operand that was reported by the assertion.</param> <param name="reason">An unformatted localized reason why the assertion failed.</param> <param name="args">A list of arguments that are inserted into the format string.</param> <returns>An assertion result.</returns> </member> <member name="M:PSRule.Runtime.Assert.AnyOf(PSRule.Runtime.AssertResult[])"> <summary> Aggregates one or more results. If any one results is a pass, then pass is returned. </summary> </member> <member name="M:PSRule.Runtime.Assert.AllOf(PSRule.Runtime.AssertResult[])"> <summary> Aggregates one or more results. If all results are a pass, then pass is returned. </summary> </member> <member name="M:PSRule.Runtime.Assert.JsonSchema(System.Management.Automation.PSObject,System.String)"> <summary> The object should match the defined schema. </summary> </member> <member name="M:PSRule.Runtime.Assert.HasJsonSchema(System.Management.Automation.PSObject,System.String[],System.Boolean)"> <summary> The object should have the $schema property defined with the URI. </summary> <remarks> The parameter 'inputObject' is null. The field '$schema' does not exist. The field value '$schema' is not a string. The value of '$schema' is null or empty. None of the specified schemas match '{0}'. </remarks> </member> <member name="M:PSRule.Runtime.Assert.HasField(System.Management.Automation.PSObject,System.String[],System.Boolean)"> <summary> The object must have any of the specified fields. </summary> <remarks> The parameter 'inputObject' is null. The parameter 'field' is null or empty. Does not exist. </remarks> </member> <member name="M:PSRule.Runtime.Assert.NotHasField(System.Management.Automation.PSObject,System.String[],System.Boolean)"> <summary> The object must not have any of the specified fields. </summary> </member> <member name="M:PSRule.Runtime.Assert.HasFields(System.Management.Automation.PSObject,System.String[],System.Boolean)"> <summary> The object must have all of the specified fields. </summary> </member> <member name="M:PSRule.Runtime.Assert.HasFieldValue(System.Management.Automation.PSObject,System.String,System.Object)"> <summary> The object should have a specific field with a value set. </summary> <remarks> Does not exist. Is null or empty. Is set to '{0}'. </remarks> </member> <member name="M:PSRule.Runtime.Assert.HasDefaultValue(System.Management.Automation.PSObject,System.String,System.Object)"> <summary> The object should not have the field or the field value is set to the default value. </summary> </member> <member name="M:PSRule.Runtime.Assert.Null(System.Management.Automation.PSObject,System.String)"> <summary> The object field value must be null. </summary> </member> <member name="M:PSRule.Runtime.Assert.NotNull(System.Management.Automation.PSObject,System.String)"> <summary> The object field value must not be null. </summary> </member> <member name="M:PSRule.Runtime.Assert.NullOrEmpty(System.Management.Automation.PSObject,System.String)"> <summary> The object should not have the field or the field value is null or empty. </summary> </member> <member name="M:PSRule.Runtime.Assert.StartsWith(System.Management.Automation.PSObject,System.String,System.String[],System.Boolean)"> <summary> The value should start with the any of the specified prefixes. Only applies to strings. </summary> </member> <member name="M:PSRule.Runtime.Assert.NotStartsWith(System.Management.Automation.PSObject,System.String,System.String[],System.Boolean)"> <summary> The value should not start with the any of the specified prefixes. Only applies to strings. </summary> <remarks> The parameter 'inputObject' is null. The parameter 'field' is null or empty. The parameter 'prefix' is null. The field '{0}' does not exist. The value '{0}' starts with '{1}'. </remarks> </member> <member name="M:PSRule.Runtime.Assert.EndsWith(System.Management.Automation.PSObject,System.String,System.String[],System.Boolean)"> <summary> The value should end with the any of the specified suffix. Only applies to strings. </summary> </member> <member name="M:PSRule.Runtime.Assert.NotEndsWith(System.Management.Automation.PSObject,System.String,System.String[],System.Boolean)"> <summary> The value should not end with the any of the specified suffix. Only applies to strings. </summary> <remarks> The parameter 'inputObject' is null. The parameter 'field' is null or empty. The parameter 'prefix' is null. The field '{0}' does not exist. The value '{0}' ends with '{1}'. </remarks> </member> <member name="M:PSRule.Runtime.Assert.Contains(System.Management.Automation.PSObject,System.String,System.String[],System.Boolean)"> <summary> The value should contain with the any of the specified text. Only applies to strings. </summary> </member> <member name="M:PSRule.Runtime.Assert.NotContains(System.Management.Automation.PSObject,System.String,System.String[],System.Boolean)"> <summary> The value should not contain with the any of the specified text. Only applies to strings. </summary> <remarks> The parameter 'inputObject' is null. The parameter 'field' is null or empty. The parameter 'prefix' is null. The field '{0}' does not exist. The value '{0}' contains '{1}'. </remarks> </member> <member name="M:PSRule.Runtime.Assert.IsLower(System.Management.Automation.PSObject,System.String,System.Boolean)"> <summary> The object field value should only contain lowercase characters. </summary> </member> <member name="M:PSRule.Runtime.Assert.IsUpper(System.Management.Automation.PSObject,System.String,System.Boolean)"> <summary> The object field value should only contain uppercase characters. </summary> </member> <member name="M:PSRule.Runtime.Assert.IsNumeric(System.Management.Automation.PSObject,System.String,System.Boolean)"> <summary> The object field value should be a numeric type. </summary> <remarks> The value '{0}' is not numeric. </remarks> </member> <member name="M:PSRule.Runtime.Assert.IsInteger(System.Management.Automation.PSObject,System.String,System.Boolean)"> <summary> The object field value should be an integer type. </summary> <remarks> The value '{0}' is not an integer. </remarks> </member> <member name="M:PSRule.Runtime.Assert.IsBoolean(System.Management.Automation.PSObject,System.String,System.Boolean)"> <summary> The object field value should be a boolean. </summary> <remarks> The value '{0}' is not a boolean. </remarks> </member> <member name="M:PSRule.Runtime.Assert.IsArray(System.Management.Automation.PSObject,System.String)"> <summary> The object field value should be an array. </summary> <remarks> The value '{0}' is not an array </remarks> </member> <member name="M:PSRule.Runtime.Assert.IsString(System.Management.Automation.PSObject,System.String)"> <summary> The object field value should be a string. </summary> <remarks> The value '{0}' is not a string. </remarks> </member> <member name="M:PSRule.Runtime.Assert.IsDateTime(System.Management.Automation.PSObject,System.String,System.Boolean)"> <summary> The object field value should be a DateTime. </summary> <remarks> The value '{0}' is not a date. </remarks> </member> <member name="M:PSRule.Runtime.Assert.TypeOf(System.Management.Automation.PSObject,System.String,System.Type[])"> <summary> The object field value should be one of the specified types. </summary> </member> <member name="M:PSRule.Runtime.Assert.TypeOf(System.Management.Automation.PSObject,System.String,System.String[])"> <summary> The object field value should be one of the specified types. </summary> </member> <member name="M:PSRule.Runtime.Assert.Version(System.Management.Automation.PSObject,System.String,System.String,System.Boolean)"> <summary> The Version assertion method checks the field value is a valid semantic version. A constraint can optionally be provided to require the semantic version to be within a range. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#version"/> </summary> <remarks> Only applies to strings. </remarks> </member> <member name="M:PSRule.Runtime.Assert.Greater(System.Management.Automation.PSObject,System.String,System.Int32,System.Boolean)"> <summary> The Greater assertion method checks the field value is greater than the specified value. The field value can either be an integer, float, array, or string. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#greater"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.GreaterOrEqual(System.Management.Automation.PSObject,System.String,System.Int32,System.Boolean)"> <summary> The GreaterOrEqual assertion method checks the field value is greater or equal to the specified value. The field value can either be an integer, float, array, or string. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#greaterorequal"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.Less(System.Management.Automation.PSObject,System.String,System.Int32,System.Boolean)"> <summary> The Less assertion method checks the field value is less than the specified value. The field value can either be an integer, float, array, or string. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#less"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.LessOrEqual(System.Management.Automation.PSObject,System.String,System.Int32,System.Boolean)"> <summary> The LessOrEqual assertion method checks the field value is less or equal to the specified value. The field value can either be an integer, float, array, or string. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#lessorequal"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.In(System.Management.Automation.PSObject,System.String,System.Array,System.Boolean)"> <summary> The object field value must be included in the set. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#in"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.NotIn(System.Management.Automation.PSObject,System.String,System.Array,System.Boolean)"> <summary> The object field value must not be included in the set. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#notin"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.Subset(System.Management.Automation.PSObject,System.String,System.Array,System.Boolean,System.Boolean)"> <summary> The Subset assertion method checks the field value includes all of the specified values. The field value may also contain additional values that are not specified in the values parameter. The field value must be an array or collection. Specified values can be included in the field value in any order. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#subset"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.SetOf(System.Management.Automation.PSObject,System.String,System.Array,System.Boolean)"> <summary> The SetOf assertion method checks the field value only includes all of the specified values. The field value must be an array or collection. Specified values can be included in the field value in any order. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#setof"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.Count(System.Management.Automation.PSObject,System.String,System.Int32)"> <summary> The field value must contain the specified number of items. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#count"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.NotCount(System.Management.Automation.PSObject,System.String,System.Int32)"> <summary> The field value must not contain the specified number of items. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#notcount"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.Match(System.Management.Automation.PSObject,System.String,System.String,System.Boolean)"> <summary> The object field value must match the regular expression. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#match"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.NotMatch(System.Management.Automation.PSObject,System.String,System.String,System.Boolean)"> <summary> The object field value must not match the regular expression. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#notmatch"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.FilePath(System.Management.Automation.PSObject,System.String,System.String[])"> <summary> The FilePath assertion method checks the file exists. Checks use file system case-sensitivity rules. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#filepath"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.FileHeader(System.Management.Automation.PSObject,System.String,System.String[],System.String)"> <summary> The FileHeader assertion method checks a file for a comment header. When comparing the file header, the format of line comments are automatically detected by file extension. <seealso href="https://microsoft.github.io/PSRule/latest/concepts/PSRule/en-US/about_PSRule_Assert/#fileheader"/> </summary> </member> <member name="M:PSRule.Runtime.Assert.WithinPath(System.Management.Automation.PSObject,System.String,System.String[],System.Nullable{System.Boolean})"> <summary> The field value must be within the specified path. </summary> </member> <member name="M:PSRule.Runtime.Assert.NotWithinPath(System.Management.Automation.PSObject,System.String,System.String[],System.Nullable{System.Boolean})"> <summary> The field must not be within the specified path. </summary> </member> <member name="M:PSRule.Runtime.Assert.Like(System.Management.Automation.PSObject,System.String,System.String[],System.Boolean)"> <summary> The value should match at least one of the specified patterns. Only applies to strings. </summary> <remarks> The parameter 'inputObject' is null. The parameter 'field' is null or empty. The parameter 'pattern' is null. The field '{0}' does not exist. The value '{0}' is not like '{1}'. </remarks> </member> <member name="M:PSRule.Runtime.Assert.NotLike(System.Management.Automation.PSObject,System.String,System.String[],System.Boolean)"> <summary> The value should not match any of the specified patterns. Only applies to strings. </summary> <remarks> The parameter 'inputObject' is null. The parameter 'field' is null or empty. The parameter 'pattern' is null. The field '{0}' does not exist. The value '{0}' is like '{1}'. </remarks> </member> <member name="M:PSRule.Runtime.Assert.GuardNullParam(System.Object,System.String,PSRule.Runtime.AssertResult@)"> <summary> Fails if the value is null. </summary> <remarks> Reason: The parameter '{0}' is null. </remarks> </member> <member name="M:PSRule.Runtime.Assert.GuardNullOrEmptyParam(System.String,System.String,PSRule.Runtime.AssertResult@)"> <summary> Fails of the value is null or empty. </summary> <returns>Returns true if the value is null or an empty string.</returns> <remarks> Reason: The parameter '{0}' is null or empty. </remarks> </member> <member name="M:PSRule.Runtime.Assert.GuardNullOrEmptyParam(System.Array,System.String,PSRule.Runtime.AssertResult@)"> <summary> Fails of the value is null or empty. </summary> <returns>Returns true if the value is null or is empty.</returns> <remarks> Reason: The parameter '{0}' is null or empty. </remarks> </member> <member name="M:PSRule.Runtime.Assert.GuardField(System.Management.Automation.PSObject,System.String,System.Boolean,System.Object@,PSRule.Runtime.AssertResult@)"> <summary> Fails if the field does not exist. </summary> <returns>Returns true if the field does not exist.</returns> <remarks> Reason: The field '{0}' does not exist. </remarks> </member> <member name="M:PSRule.Runtime.Assert.GuardFieldEnumerable(System.Object,System.String,System.Int32@,PSRule.Runtime.AssertResult@)"> <summary> Fails if the field is not enumerable. </summary> <returns>Returns true of the field value is not enumerable.</returns> <remarks> Reason: The field '{0}' is not enumerable. </remarks> </member> <member name="M:PSRule.Runtime.Assert.GuardString(PSRule.Runtime.IOperand,System.Object,System.String@,PSRule.Runtime.AssertResult@)"> <summary> Fails if the field value is not a string. </summary> <returns>Returns true if the field value is not a string.</returns> <remarks> Reason: The field value '{0}' is not a string. </remarks> </member> <member name="M:PSRule.Runtime.Assert.GuardNullFieldValue(System.String,System.Object,PSRule.Runtime.AssertResult@)"> <summary> Fields if the field value is null. </summary> <returns>Returns true if the field value is null.</returns> <remarks> Reason: The field value '{0}' is null. </remarks> </member> <member name="M:PSRule.Runtime.Assert.GetFileType(System.String)"> <summary> Get the file extension of the name of the file if an extension is not set. </summary> </member> <member name="M:PSRule.Runtime.Assert.DetectLinePrefix(System.String)"> <summary> Determine line comment prefix by file extension </summary> </member> <member name="T:PSRule.Runtime.AssertResult"> <summary> The result of a single assertion. </summary> </member> <member name="M:PSRule.Runtime.AssertResult.op_Explicit(PSRule.Runtime.AssertResult)~System.Boolean"> <summary> Convert the result into a boolean value. </summary> </member> <member name="P:PSRule.Runtime.AssertResult.Result"> <summary> Success of the condition. True indicate pass, false indicates fail. </summary> </member> <member name="M:PSRule.Runtime.AssertResult.AddReason(System.String)"> <summary> Add a reason. </summary> <param name="text">The text of a reason to add. This text should already be localized for the currently culture.</param> </member> <member name="M:PSRule.Runtime.AssertResult.AddReason(PSRule.Runtime.AssertResult)"> <summary> Add a reasons from an existing result. </summary> </member> <member name="M:PSRule.Runtime.AssertResult.AddReason(PSRule.Runtime.IOperand,System.String,System.Object[])"> <summary> Add a reason. </summary> <param name="operand">Indentifies the operand that was the reason for the failure.</param> <param name="text">The text of a reason to add. This text should already be localized for the currently culture.</param> <param name="args">Replacement arguments for the format string.</param> </member> <member name="M:PSRule.Runtime.AssertResult.WithReason(System.String,System.Boolean)"> <summary> Adds a reason, and optionally replace existing reasons. </summary> <param name="text">The text of a reason to add. This text should already be localized for the currently culture.</param> <param name="replace">When set to true, existing reasons are cleared.</param> </member> <member name="M:PSRule.Runtime.AssertResult.PathPrefix(System.String)"> <summary> Adds a logical path prefix on to each reason path. </summary> <param name="prefix">A string to prefix on each path.</param> </member> <member name="M:PSRule.Runtime.AssertResult.Reason(System.String,System.Object[])"> <summary> Replace the existing reason with the supplied format string. </summary> <param name="text">The text of a reason to use. This text should already be localized for the currently culture.</param> <param name="args">Replacement arguments for the format string.</param> </member> <member name="M:PSRule.Runtime.AssertResult.ReasonFrom(System.String,System.String,System.Object[])"> <summary> Replace the existing reason with the supplied format string. </summary> <param name="path">The object path that affected the reason.</param> <param name="text">The text of a reason to use. This text should already be localized for the currently culture.</param> <param name="args">Replacement arguments for the format string.</param> </member> <member name="M:PSRule.Runtime.AssertResult.ReasonIf(System.Boolean,System.String,System.Object[])"> <summary> Replace the existing reason with the supplied format string if the condition is true. </summary> <param name="condition">When true the reason will be used. When false the existing reason will be used.</param> <param name="text">The text of a reason to use. This text should already be localized for the currently culture.</param> <param name="args">Replacement arguments for the format string.</param> </member> <member name="M:PSRule.Runtime.AssertResult.ReasonIf(System.String,System.Boolean,System.String,System.Object[])"> <summary> Replace the existing reason with the supplied format string if the condition is true. </summary> <param name="path">The object path that affected the reason.</param> <param name="condition">When true the reason will be used. When false the existing reason will be used.</param> <param name="text">The text of a reason to use. This text should already be localized for the currently culture.</param> <param name="args">Replacement arguments for the format string.</param> </member> <member name="M:PSRule.Runtime.AssertResult.GetReason"> <summary> Get an reasons that are currently set. </summary> <returns>Returns an array of reasons. This will always return null when the Value is true.</returns> </member> <member name="M:PSRule.Runtime.AssertResult.Complete"> <summary> Complete an assertion by writing an provided reasons and returning a boolean. </summary> <returns>Returns true or false.</returns> </member> <member name="M:PSRule.Runtime.AssertResult.Ignore"> <summary> Clear any reasons for this result. </summary> </member> <member name="M:PSRule.Runtime.AssertResult.Equals(System.Boolean)"> <inheritdoc/> </member> <member name="M:PSRule.Runtime.AssertResult.ToString"> <summary> Get a formatted string of the result reasons. </summary> </member> <member name="M:PSRule.Runtime.AssertResult.ToBoolean"> <summary> Convert the result into a boolean value. </summary> </member> <member name="T:PSRule.Runtime.Configuration"> <summary> A set of rule configuration values that are exposed at runtime and automatically failback to defaults when not set in configuration. </summary> </member> <member name="T:PSRule.Runtime.IInputCollection"> <summary> A collection of input passed to PSRule for anlaysis. </summary> </member> <member name="M:PSRule.Runtime.IInputCollection.Add(System.String)"> <summary> Add a path to the list of inputs. </summary> <param name="path">The path of files to add.</param> </member> <member name="T:PSRule.Runtime.IRepositoryRuntimeInfo"> <summary> Display information about the current repository at runtime. </summary> </member> <member name="P:PSRule.Runtime.IRepositoryRuntimeInfo.Url"> <summary> A URL to the current repository. </summary> </member> <member name="P:PSRule.Runtime.IRepositoryRuntimeInfo.BaseRef"> <summary> The base ref for the current repository branch. </summary> </member> <member name="M:PSRule.Runtime.IRepositoryRuntimeInfo.GetChangedFiles"> <summary> Get a list of changed files within the repository. </summary> <returns>A collection of files.</returns> </member> <member name="T:PSRule.Runtime.ILanguageScope"> <summary> A named scope for langauge elements. </summary> </member> <member name="P:PSRule.Runtime.ILanguageScope.Name"> <summary> The name of the scope. </summary> </member> <member name="M:PSRule.Runtime.ILanguageScope.Configure(System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Adds one or more configuration values to the scope. </summary> </member> <member name="M:PSRule.Runtime.ILanguageScope.TryConfigurationValue(System.String,System.Object@)"> <summary> Try to get a specific configuration value by name. </summary> </member> <member name="M:PSRule.Runtime.ILanguageScope.AddService(System.String,System.Object)"> <summary> Add a service to the scope. </summary> </member> <member name="M:PSRule.Runtime.ILanguageScope.GetService(System.String)"> <summary> Get a previously added service. </summary> </member> <member name="P:PSRule.Runtime.LanguageScope.Name"> <inheritdoc/> </member> <member name="M:PSRule.Runtime.LanguageScope.AddService(System.String,System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Runtime.LanguageScope.GetService(System.String)"> <inheritdoc/> </member> <member name="T:PSRule.Runtime.NameTokenType"> <summary> The type of NameToken. </summary> </member> <member name="F:PSRule.Runtime.NameTokenType.Field"> <summary> The token represents a field/ property of an object. </summary> </member> <member name="F:PSRule.Runtime.NameTokenType.Index"> <summary> The token is an index in an object. </summary> </member> <member name="F:PSRule.Runtime.NameTokenType.Self"> <summary> The token is a reference to the parent object. Can only be the first token. </summary> </member> <member name="T:PSRule.Runtime.NameToken"> <summary> A token for expressing a path through a tree of fields. </summary> </member> <member name="F:PSRule.Runtime.NameToken.Name"> <summary> The name of the field if the token type if Field. </summary> </member> <member name="F:PSRule.Runtime.NameToken.Index"> <summary> The index if the token type if Index. </summary> </member> <member name="F:PSRule.Runtime.NameToken.Next"> <summary> The next token. </summary> </member> <member name="F:PSRule.Runtime.NameToken.Type"> <summary> The type of the token. </summary> </member> <member name="T:PSRule.Runtime.ObjectHelper"> <summary> A helper class to traverse object properties. </summary> </member> <member name="M:PSRule.Runtime.ObjectHelper.GetPathExpression(PSRule.Runtime.IBindingContext,System.String)"> <summary> Get a token for the specified name either by creating or reading from cache. </summary> </member> <member name="T:PSRule.Runtime.ObjectPath.ObjectPathEvaluateException"> <summary> An exception thrown by PSRule when evaluating an object path. </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.ObjectPathEvaluateException.#ctor"> <inheritdoc/> </member> <member name="M:PSRule.Runtime.ObjectPath.ObjectPathEvaluateException.#ctor(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Runtime.ObjectPath.ObjectPathEvaluateException.#ctor(System.String,System.Exception)"> <inheritdoc/> </member> <member name="M:PSRule.Runtime.ObjectPath.ObjectPathEvaluateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="M:PSRule.Runtime.ObjectPath.ObjectPathEvaluateException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Runtime.ObjectPath.PathExpressionFn"> <summary> An expression function that returns one or more values when successful. </summary> </member> <member name="T:PSRule.Runtime.ObjectPath.PathExpressionFilterFn"> <summary> A function for filter objects that simply returns true or false. </summary> </member> <member name="T:PSRule.Runtime.ObjectPath.IPathExpressionContext"> <summary> A context ojbect used using evaluating a path expression. </summary> </member> <member name="T:PSRule.Runtime.ObjectPath.PathExpressionContext"> <summary> The default context object used using evaluating a path expression. </summary> </member> <member name="P:PSRule.Runtime.ObjectPath.PathExpressionContext.Input"> <summary> The original root object passed into the expression. </summary> </member> <member name="P:PSRule.Runtime.ObjectPath.PathExpressionContext.CaseSensitive"> <summary> Determines if member name matching is case-sensitive. </summary> </member> <member name="T:PSRule.Runtime.ObjectPath.PathExpression"> <summary> A path expression using JSONPath inspired syntax. </summary> </member> <member name="P:PSRule.Runtime.ObjectPath.PathExpression.Path"> <summary> The path expression. </summary> </member> <member name="P:PSRule.Runtime.ObjectPath.PathExpression.IsArray"> <summary> Specifies if the result is an array. </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathExpression.Create(System.String)"> <summary> Create the expression from the specified path. </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathExpression.TryGet(System.Object,System.Boolean,System.Object[]@)"> <summary> Use the expression to return an array of results. </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathExpression.TryGet(System.Object,System.Boolean,System.Object@)"> <summary> Use the expression to return a single or an array of results. </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathExpression.TryGet(System.Object,System.Boolean,System.Collections.Generic.IEnumerable{System.Object}@,System.Boolean@)"> <summary> Use the path to selector one or more values from the object. </summary> <param name="o">The object to navigate the path for.</param> <param name="caseSensitive">Determines if member name matching is case-sensitive.</param> <param name="value">The values selected from the object.</param> <param name="enumerable">Determines if <paramref name="value"/> is enumerable.</param> <returns>Returns true when the path exists within the object. Returns false if the path does not exist.</returns> </member> <member name="T:PSRule.Runtime.ObjectPath.PathExpressionBuilder"> <summary> A helper class to build an expression tree from path tokens. </summary> </member> <member name="P:PSRule.Runtime.ObjectPath.PathExpressionBuilder.IsArray"> <summary> Determines if the output should be an array. </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathExpressionBuilder.Build(PSRule.Runtime.ObjectPath.IPathToken[])"> <summary> Build a delegate function to evaluate the object path. </summary> </member> <member name="T:PSRule.Runtime.ObjectPath.PathTokenizer"> <summary> A helper to tokenize an object path expression. </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.Next(System.Int32@)"> <summary> Find the start of the sequence. </summary> <returns>Return true when more characters follow.</returns> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.TryConsumeRef(System.Int32@,PSRule.Runtime.ObjectPath.ITokenWriter)"> <summary> Capture a token for $ and @. </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.TryConsumeFilter(System.Int32@,PSRule.Runtime.ObjectPath.ITokenWriter)"> <summary> Capture a token for "[?(@.enabled==true)]". </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.IsDotSelector(System.Int32)"> <summary> Check if current is a property operator. </summary> <remarks> "." or "+" but not ".." </remarks> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.TryConsumeArraySliceSelector(System.Int32@,PSRule.Runtime.ObjectPath.ITokenWriter)"> <summary> Capture a token for: [::1] </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.TryConsumeUnionSelector(System.Int32@,PSRule.Runtime.ObjectPath.ITokenWriter)"> <summary> Capture a token for: [,] </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.TryConsumeStringIndex(System.Int32@,PSRule.Runtime.ObjectPath.ITokenWriter)"> <summary> Capture a token for "['store']". </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.TryConsumeIndexWildSelector(System.Int32@,PSRule.Runtime.ObjectPath.ITokenWriter)"> <summary> Capture a token for "[*]". </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.TryConsumeNumericIndex(System.Int32@,PSRule.Runtime.ObjectPath.ITokenWriter)"> <summary> Capture a token for "[0]". </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.SkipPadding(System.Int32)"> <summary> Skip whitespace. </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.WhileMemberName(System.Int32@,System.String@)"> <summary> Continue while the character is a member name. </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.WhileNumeric(System.Int32,System.Int32@)"> <summary> Continue while the character is numeric. </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.PathStream.UntilQuote(System.Int32@,System.String@)"> <summary> Find the end of the quote ('). </summary> </member> <member name="M:PSRule.Runtime.ObjectPath.PathTokenizer.Get(System.String)"> <summary> Get path tokens for a specific object path expression. </summary> <param name="path">The object path expression.</param> <returns>One or more path tokens.</returns> </member> <member name="F:PSRule.Runtime.ObjectPath.PathTokenType.RootRef"> <summary> Token: $ </summary> </member> <member name="F:PSRule.Runtime.ObjectPath.PathTokenType.CurrentRef"> <summary> Token: @ </summary> </member> <member name="F:PSRule.Runtime.ObjectPath.PathTokenType.DotSelector"> <summary> Token: .Name </summary> </member> <member name="F:PSRule.Runtime.ObjectPath.PathTokenType.IndexSelector"> <summary> Token: [index] </summary> </member> <member name="F:PSRule.Runtime.ObjectPath.PathTokenType.IndexWildSelector"> <summary> Token: [*] </summary> </member> <member name="F:PSRule.Runtime.ObjectPath.PathTokenType.NotOperator"> <summary> Token: ! </summary> </member> <member name="F:PSRule.Runtime.ObjectPath.PathTokenType.DescendantSelector"> <summary> Token: .. </summary> </member> <member name="F:PSRule.Runtime.ObjectPath.PathTokenType.DotWildSelector"> <summary> Token: .* </summary> </member> <member name="T:PSRule.Runtime.OperandKind"> <summary> The type of operand that is compared with the expression. </summary> </member> <member name="F:PSRule.Runtime.OperandKind.None"> <summary> Unknown. </summary> </member> <member name="F:PSRule.Runtime.OperandKind.Path"> <summary> An object path. </summary> </member> <member name="F:PSRule.Runtime.OperandKind.Type"> <summary> The object target type. </summary> </member> <member name="F:PSRule.Runtime.OperandKind.Name"> <summary> The object target name. </summary> </member> <member name="F:PSRule.Runtime.OperandKind.Source"> <summary> The object source information. </summary> </member> <member name="F:PSRule.Runtime.OperandKind.Target"> <summary> The target object itself. </summary> </member> <member name="F:PSRule.Runtime.OperandKind.Value"> <summary> A literal value or function. </summary> </member> <member name="T:PSRule.Runtime.IOperand"> <summary> An operand that is compared with PSRule expressions. </summary> </member> <member name="P:PSRule.Runtime.IOperand.Value"> <summary> The value of the operand. </summary> </member> <member name="P:PSRule.Runtime.IOperand.Kind"> <summary> The type of operand. </summary> </member> <member name="P:PSRule.Runtime.IOperand.Path"> <summary> The object path to the operand. </summary> </member> <member name="P:PSRule.Runtime.IOperand.Prefix"> <summary> A logical prefix to add to the object path. </summary> </member> <member name="T:PSRule.Runtime.PSRule"> <summary> A set of context properties that are exposed at runtime through the $PSRule variable. </summary> </member> <member name="M:PSRule.Runtime.PSRule.#ctor"> <summary> Create an empty instance. </summary> </member> <member name="M:PSRule.Runtime.PSRule.PSRuleInput.Add(System.String)"> <inheritdoc/> </member> <member name="P:PSRule.Runtime.PSRule.PSRuleRepository.Url"> <inheritdoc/> </member> <member name="P:PSRule.Runtime.PSRule.PSRuleRepository.BaseRef"> <inheritdoc/> </member> <member name="M:PSRule.Runtime.PSRule.PSRuleRepository.GetChangedFiles"> <inheritdoc/> </member> <member name="P:PSRule.Runtime.PSRule.Badges"> <summary> Exposes the badge API for used within conventions. </summary> </member> <member name="P:PSRule.Runtime.PSRule.Data"> <summary> Custom data set by the rule for this target object. </summary> </member> <member name="P:PSRule.Runtime.PSRule.Field"> <summary> A set of custom fields bound for the target object. </summary> <remarks> This property can only be accessed from a rule or pre-condition. </remarks> <exception cref="T:PSRule.Pipeline.RuntimeScopeException"> Thrown when accessing this property outside of a rule or pre-condition. </exception> </member> <member name="P:PSRule.Runtime.PSRule.Input"> <summary> A list of pre-defined input path that are included. </summary> <remarks> This property can only be accessed from an initialize convention block. </remarks> <exception cref="T:PSRule.Pipeline.RuntimeScopeException"> Thrown when accessing this property outside of an initialize convention block. </exception> </member> <member name="P:PSRule.Runtime.PSRule.Repository"> <summary> Information about the repository that is currently being used. </summary> </member> <member name="P:PSRule.Runtime.PSRule.Output"> <summary> An aggregated set of results from executing PSRule rules. </summary> <remarks> This property can only be accessed from an end convention block. </remarks> <exception cref="T:PSRule.Pipeline.RuntimeScopeException"> Thrown when accessing this property outside of an end convention block. </exception> </member> <member name="P:PSRule.Runtime.PSRule.Source"> <summary> The source information for the location the target object originated from. </summary> </member> <member name="P:PSRule.Runtime.PSRule.Issue"> <summary> Any issues reported by downstream tools and annotated to the target object. </summary> </member> <member name="P:PSRule.Runtime.PSRule.TargetObject"> <summary> The current target object. </summary> </member> <member name="P:PSRule.Runtime.PSRule.TargetName"> <summary> The bound name of the target object. </summary> </member> <member name="P:PSRule.Runtime.PSRule.TargetType"> <summary> The bound type of the target object. </summary> </member> <member name="M:PSRule.Runtime.PSRule.GetContent(System.Management.Automation.PSObject)"> <summary> Attempts to read content from disk. </summary> </member> <member name="M:PSRule.Runtime.PSRule.GetContentField(System.Management.Automation.PSObject,System.String)"> <summary> Attempts to read content from disk and extract a field from each object. </summary> </member> <member name="M:PSRule.Runtime.PSRule.GetContentFirstOrDefault(System.Management.Automation.PSObject)"> <summary> Attempts to read content from disk and return the first object or null. </summary> </member> <member name="M:PSRule.Runtime.PSRule.GetPath(System.Object,System.String)"> <summary> Evalute an object path expression and returns the resulting objects. </summary> </member> <member name="M:PSRule.Runtime.PSRule.Import(System.Management.Automation.PSObject[])"> <summary> Imports source objects into the pipeline for processing. </summary> <remarks> This method can only be called from a convention begin block. </remarks> <exception cref="T:PSRule.Pipeline.RuntimeScopeException"> Thrown when accessing this method outside of a convention begin block. </exception> </member> <member name="M:PSRule.Runtime.PSRule.AddService(System.String,System.Object)"> <summary> Add a reusable singleton object into PSRule runtime that can be reference across multiple rules or conventions. To retrieve the singleton call <seealso cref="M:PSRule.Runtime.PSRule.GetService(System.String)"/>. </summary> <param name="id">A unique identifier for the object.</param> <param name="service">A instance of the singleton.</param> <remarks> If either <paramref name="id"/> or <paramref name="service"/> is null or empty the singleton is ignored. This method can only be called from a convention initialize block. </remarks> <exception cref="T:PSRule.Pipeline.RuntimeScopeException"> Thrown when accessing this method outside of a convention initialize block. </exception> </member> <member name="M:PSRule.Runtime.PSRule.GetService(System.String)"> <summary> Retrieve a reusable singleton object from the PSRule runtime that has previously been stored with <see cref="M:PSRule.Runtime.PSRule.AddService(System.String,System.Object)"/>. </summary> <param name="id">The unique identifier for the object.</param> <returns>The singleton instance or null if an object with the specified <paramref name="id"/> was not found.</returns> <exception cref="T:PSRule.Pipeline.RuntimeScopeException"> Thrown when accessing this method outside of PSRule. </exception> </member> <member name="T:PSRule.Runtime.Rule"> <summary> A set of rule properties that are exposed at runtime through the $Rule variable. </summary> </member> <member name="P:PSRule.Runtime.Rule.RuleName"> <summary> The name of the currently executing rule. </summary> </member> <member name="P:PSRule.Runtime.Rule.RuleId"> <summary> A unique identifer of the currently executing rule. </summary> </member> <member name="F:PSRule.Runtime.RunspaceScope.Rule"> <summary> Executing a rule. </summary> </member> <member name="F:PSRule.Runtime.RunspaceScope.Precondition"> <summary> Executing a rule precondition. </summary> </member> <member name="F:PSRule.Runtime.RunspaceScope.Resource"> <summary> Execution is currently parsing YAML objects. </summary> </member> <member name="T:PSRule.Runtime.RunspaceContext"> <summary> A context for a PSRule runspace. </summary> </member> <member name="F:PSRule.Runtime.RunspaceContext._WarnOnce"> <summary> Track common warnings, to only raise once. </summary> </member> <member name="M:PSRule.Runtime.RunspaceContext.EnterTargetObject(PSRule.Pipeline.TargetObject)"> <summary> Increment the pipeline object number. </summary> </member> <member name="M:PSRule.Runtime.RunspaceContext.EnterRuleBlock(PSRule.Rules.RuleBlock)"> <summary> Enter the rule block scope. </summary> </member> <member name="M:PSRule.Runtime.RunspaceContext.ExitRuleBlock"> <summary> Exit the rule block scope. </summary> </member> <member name="T:PSRule.Runtime.ScopedItem"> <summary> A base class for scoped context variables used internally by PSRule. </summary> </member> </members> </doc> |