Microsoft.PSRule.Types.xml
|
<?xml version="1.0"?> <doc> <assembly> <name>Microsoft.PSRule.Types</name> </assembly> <members> <member name="M:PSRule.Converters.TypeConverter.TryInt(System.Object,System.Boolean,System.Int32@)"> <summary> Try to get an int from the existing object. </summary> </member> <member name="T:PSRule.Converters.Yaml.StringArrayConverter"> <summary> A YAML converter for deserializing a string array. </summary> </member> <member name="M:PSRule.Converters.Yaml.StringArrayConverter.YamlDotNet#Serialization#IYamlTypeConverter#Accepts(System.Type)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringArrayConverter.YamlDotNet#Serialization#IYamlTypeConverter#ReadYaml(YamlDotNet.Core.IParser,System.Type)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringArrayConverter.YamlDotNet#Serialization#IYamlTypeConverter#WriteYaml(YamlDotNet.Core.IEmitter,System.Object,System.Type)"> <inheritdoc/> </member> <member name="T:PSRule.Converters.Yaml.StringArrayMapConverter"> <summary> A YAML converter for de/serializing <see cref="T:PSRule.Data.StringArrayMap"/>. </summary> </member> <member name="M:PSRule.Converters.Yaml.StringArrayMapConverter.YamlDotNet#Serialization#IYamlTypeConverter#Accepts(System.Type)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringArrayMapConverter.YamlDotNet#Serialization#IYamlTypeConverter#ReadYaml(YamlDotNet.Core.IParser,System.Type)"> <inheritdoc/> </member> <member name="M:PSRule.Converters.Yaml.StringArrayMapConverter.YamlDotNet#Serialization#IYamlTypeConverter#WriteYaml(YamlDotNet.Core.IEmitter,System.Object,System.Type)"> <inheritdoc/> </member> <member name="T:PSRule.Data.IDateVersionConstraint"> <summary> An date version constraint. </summary> </member> <member name="M:PSRule.Data.IDateVersionConstraint.Equals(PSRule.Data.DateVersion.Version)"> <summary> Determines if the date version meets the requirments of the constraint. </summary> </member> <member name="T:PSRule.Data.DateVersion"> <summary> A helper for comparing date version strings. An date version is represented as YYYY-MM-DD-prerelease. </summary> </member> <member name="T:PSRule.Data.DateVersion.ComparisonOperator"> <summary> A comparison operation for a version constraint. </summary> </member> <member name="F:PSRule.Data.DateVersion.ComparisonOperator.Equals"> <summary> YYYY-MM-DD bits must match. </summary> </member> <member name="T:PSRule.Data.DateVersion.VersionConstraint"> <summary> An date version constraint. </summary> </member> <member name="M:PSRule.Data.DateVersion.VersionConstraint.Equals(PSRule.Data.DateVersion.Version)"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.ConstraintExpression.GT(System.Int32,System.Int32,System.Int32,PSRule.Data.DateVersion.PR)"> <summary> Greater Than. </summary> </member> <member name="M:PSRule.Data.DateVersion.ConstraintExpression.LT(System.Int32,System.Int32,System.Int32,PSRule.Data.DateVersion.PR)"> <summary> Less Than. </summary> </member> <member name="M:PSRule.Data.DateVersion.ConstraintExpression.PR(PSRule.Data.DateVersion.PR)"> <summary> Compare pre-release. </summary> </member> <member name="T:PSRule.Data.DateVersion.Version"> <summary> An date version. </summary> </member> <member name="F:PSRule.Data.DateVersion.Version.Year"> <summary> The year part of the version. </summary> </member> <member name="F:PSRule.Data.DateVersion.Version.Month"> <summary> The month part of the version. </summary> </member> <member name="F:PSRule.Data.DateVersion.Version.Day"> <summary> The day part of the version. </summary> </member> <member name="F:PSRule.Data.DateVersion.Version.Prerelease"> <summary> The pre-release part of the version. </summary> </member> <member name="M:PSRule.Data.DateVersion.Version.ToString"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.Version.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.Version.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.Version.Equals(PSRule.Data.DateVersion.Version)"> <summary> Compare the version against another version. </summary> </member> <member name="M:PSRule.Data.DateVersion.Version.Equals(System.Int32,System.Int32,System.Int32)"> <summary> Compare the version against another version based on YYYY-MM-DD. </summary> </member> <member name="M:PSRule.Data.DateVersion.Version.CompareTo(PSRule.Data.DateVersion.Version)"> <summary> Compare the version against another version. </summary> </member> <member name="T:PSRule.Data.DateVersion.PR"> <summary> An date version pre-release identifier. </summary> </member> <member name="P:PSRule.Data.DateVersion.PR.Value"> <summary> The string value of a pre-release identifier. </summary> </member> <member name="P:PSRule.Data.DateVersion.PR.Stable"> <summary> Is the pre-release identifier empty, indicating a stable release. </summary> </member> <member name="M:PSRule.Data.DateVersion.PR.CompareTo(PSRule.Data.DateVersion.PR)"> <summary> Compare the pre-release identifer to another pre-release identifier. </summary> </member> <member name="M:PSRule.Data.DateVersion.PR.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.PR.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.PR.ToString"> <inheritdoc/> </member> <member name="M:PSRule.Data.DateVersion.VersionStream.GetJoin"> <summary> 1.2.3 || 3.4.5 >=1.2.3 <3.4.5 </summary> </member> <member name="M:PSRule.Data.DateVersion.VersionStream.IsLetter(System.Char)"> <summary> Is the character within the reduced set of allowed characters. a-z or A-Z. </summary> </member> <member name="M:PSRule.Data.DateVersion.TryParseConstraint(System.String,PSRule.Data.IDateVersionConstraint@,System.Boolean)"> <summary> Try to parse a version constraint from the provided string. </summary> </member> <member name="M:PSRule.Data.DateVersion.TryParseVersion(System.String,PSRule.Data.DateVersion.Version@)"> <summary> Try to parse a version from the provided string. </summary> </member> <member name="T:PSRule.Data.ModuleConstraint"> <summary> A version constraint for a PSRule module. </summary> </member> <member name="M:PSRule.Data.ModuleConstraint.#ctor(System.String,PSRule.Data.ISemanticVersionConstraint)"> <summary> Create a version constraint for a PSRule module. </summary> <param name="module">The name of the module.</param> <param name="constraint">The version constraint of the module.</param> </member> <member name="P:PSRule.Data.ModuleConstraint.Module"> <summary> The name of the module. </summary> </member> <member name="P:PSRule.Data.ModuleConstraint.Constraint"> <summary> The version constraint of the module. </summary> </member> <member name="T:PSRule.Data.ISemanticVersionConstraint"> <summary> A semantic version constraint. </summary> </member> <member name="M:PSRule.Data.ISemanticVersionConstraint.Equals(PSRule.Data.SemanticVersion.Version)"> <summary> Determines if the semantic version meets the requirments of the constraint. </summary> </member> <member name="T:PSRule.Data.SemanticVersion"> <summary> A helper for comparing semantic version strings. </summary> </member> <member name="T:PSRule.Data.SemanticVersion.ComparisonOperator"> <summary> A comparison operation for a version constraint. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.ComparisonOperator.Equals"> <summary> Major.Minor.Patch bits must match. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.ComparisonOperator.PatchUplift"> <summary> Major.Minor bits must match, Patch can equal to or greater. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.ComparisonOperator.MinorUplift"> <summary> Major bit must match, Minor.Patch can be equal to or greater. </summary> </member> <member name="T:PSRule.Data.SemanticVersion.VersionConstraint"> <summary> A semantic version constraint. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.VersionConstraint.Equals(PSRule.Data.SemanticVersion.Version)"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.ConstraintExpression.GT(System.Int32,System.Int32,System.Int32,PSRule.Data.SemanticVersion.PR)"> <summary> Greater Than. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.ConstraintExpression.LT(System.Int32,System.Int32,System.Int32,PSRule.Data.SemanticVersion.PR)"> <summary> Less Than. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.ConstraintExpression.PR(PSRule.Data.SemanticVersion.PR)"> <summary> Compare pre-release. </summary> </member> <member name="T:PSRule.Data.SemanticVersion.Version"> <summary> A semantic version. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.Version.Major"> <summary> The major part of the version. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.Version.Minor"> <summary> The minor part of the version. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.Version.Patch"> <summary> The patch part of the version. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.Version.Prerelease"> <summary> The pre-release part of the version. </summary> </member> <member name="F:PSRule.Data.SemanticVersion.Version.Build"> <summary> The build part of the version. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.Version.TryParse(System.String,PSRule.Data.SemanticVersion.Version@)"> <summary> Try to parse a semantic version from a string. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.Version.ToString"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.Version.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.Version.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.Version.Equals(PSRule.Data.SemanticVersion.Version)"> <summary> Compare the version against another version. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.Version.Equals(System.Int32,System.Int32,System.Int32)"> <summary> Compare the version against another version based on major.minor.patch. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.Version.CompareTo(PSRule.Data.SemanticVersion.Version)"> <summary> Compare the version against another version. </summary> </member> <member name="T:PSRule.Data.SemanticVersion.PR"> <summary> A semantic version pre-release identifier. </summary> </member> <member name="P:PSRule.Data.SemanticVersion.PR.Value"> <summary> The string value of a pre-release identifier. </summary> </member> <member name="P:PSRule.Data.SemanticVersion.PR.Stable"> <summary> Is the pre-release identifier empty, indicating a stable release. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.PR.CompareTo(PSRule.Data.SemanticVersion.PR)"> <summary> Compare the pre-release identifer to another pre-release identifier. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.PR.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.PR.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.PR.ToString"> <inheritdoc/> </member> <member name="M:PSRule.Data.SemanticVersion.VersionStream.GetJoin"> <summary> 1.2.3 || 3.4.5 >=1.2.3 <3.4.5 </summary> </member> <member name="M:PSRule.Data.SemanticVersion.VersionStream.IsLetter(System.Char)"> <summary> Is the character within the reduced set of allowed characters. a-z or A-Z. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.TryParseConstraint(System.String,PSRule.Data.ISemanticVersionConstraint@,System.Boolean)"> <summary> Try to parse a version constraint from the provided string. </summary> </member> <member name="M:PSRule.Data.SemanticVersion.TryParseVersion(System.String,PSRule.Data.SemanticVersion.Version@)"> <summary> Try to parse a version from the provided string. </summary> </member> <member name="T:PSRule.Data.StringArrayMap"> <summary> A mapping of string to string arrays. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.#ctor"> <summary> Create an empty <see cref="T:PSRule.Data.StringArrayMap"/> instance. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.#ctor(PSRule.Data.StringArrayMap)"> <summary> Create an instance by copying an existing <see cref="T:PSRule.Data.StringArrayMap"/>. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.#ctor(System.Collections.Generic.Dictionary{System.String,System.String[]})"> <summary> Create an instance by copying mapped keys from a string dictionary. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.#ctor(System.Collections.Hashtable)"> <summary> Create an instance by copying mapped keys from a <seealso cref="T:System.Collections.Hashtable"/>. </summary> <param name="map"></param> </member> <member name="P:PSRule.Data.StringArrayMap.Count"> <summary> The number of mapped keys. </summary> </member> <member name="P:PSRule.Data.StringArrayMap.Item(System.String)"> <summary> Get or set mapping for a specified key. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.op_Implicit(System.Collections.Hashtable)~PSRule.Data.StringArrayMap"> <summary> </summary> <param name="hashtable"></param> </member> <member name="M:PSRule.Data.StringArrayMap.TryGetValue(System.String,System.String[]@)"> <summary> Try to get a mapping by key. </summary> <param name="key">The key.</param> <param name="value">Returns an array of mapped keys.</param> <returns>Returns <c>true</c> if the key was found. Otherwise <c>false</c> is returned.</returns> </member> <member name="M:PSRule.Data.StringArrayMap.Load(PSRule.Data.StringArrayMap,System.Collections.Generic.IDictionary{System.String,System.Object})"> <summary> Load a key map from an existing dictionary. </summary> </member> <member name="M:PSRule.Data.StringArrayMap.GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.Data.StringArrayMap.System#Collections#IEnumerable#GetEnumerator"> <inheritdoc/> </member> <member name="M:PSRule.Data.StringArrayMap.ToDictionary"> <summary> Convert the instance into a dictionary. </summary> <returns></returns> </member> <member name="M:PSRule.Data.StringArrayMap.FromHashtable(System.Collections.Hashtable)"> <summary> Convert a hashtable into a <see cref="T:PSRule.Data.StringArrayMap"/> instance. </summary> </member> <member name="T:PSRule.DictionaryExtensions"> <summary> Extension methods for <see cref="T:System.Collections.Generic.IDictionary`2"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopValue(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Object@)"> <summary> Try to get a value and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopValue``1(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,``0@)"> <summary> Try to get a value and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopBool(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Boolean@)"> <summary> Try to get a <see cref="T:System.Boolean"/> and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopEnum``1(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,``0@)"> <summary> Try to get a <typeparamref name="TEnum"/> and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopString(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.String@)"> <summary> Try to get a <see cref="T:System.String"/> and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopStringArray(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.String[]@)"> <summary> Try to get an array of strings and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryPopStringArrayMap(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,PSRule.Data.StringArrayMap@)"> <summary> Try to get a <see cref="T:PSRule.Data.StringArrayMap"/> and remove it from the dictionary. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetBool(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Nullable{System.Boolean}@)"> <summary> Try to get the value as a <see cref="T:System.Boolean"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetLong(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Nullable{System.Int64}@)"> <summary> Try to get the value as a <see cref="T:System.Int64"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetInt(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Nullable{System.Int32}@)"> <summary> Try to get the value as a <see cref="T:System.Int32"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetChar(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Nullable{System.Char}@)"> <summary> Try to get the value as a <see cref="T:System.Char"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetString(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.String@)"> <summary> Try to get the value as a <see cref="T:System.String"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetEnumerable(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.Collections.IEnumerable@)"> <summary> Try to get the value as an <see cref="T:System.Collections.IEnumerable"/>. </summary> </member> <member name="M:PSRule.DictionaryExtensions.TryGetStringArray(System.Collections.Generic.IDictionary{System.String,System.Object},System.String,System.String[]@)"> <summary> Try to get the value as an array of strings. </summary> </member> <member name="M:PSRule.DictionaryExtensions.AddUnique(System.Collections.Generic.IDictionary{System.String,System.Object},System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})"> <summary> Add unique keys to the dictionary. Duplicate keys are ignored. </summary> </member> <member name="T:PSRule.Environment"> <summary> A helper for accessing environment variables. </summary> </member> <member name="M:PSRule.Environment.IsAzurePipelines"> <summary> Determine if the environment is running within Azure Pipelines. </summary> </member> <member name="M:PSRule.Environment.IsGitHubActions"> <summary> Determines if the environment is running within GitHub Actions. </summary> </member> <member name="M:PSRule.Environment.IsVisualStudioCode"> <summary> Determine if the environment is running within Visual Studio Code. </summary> </member> <member name="M:PSRule.Environment.GetRunId"> <summary> Get the run identifier for the current environment. </summary> </member> <member name="M:PSRule.Environment.TryString(System.String,System.String@)"> <summary> Try to get the environment variable as a <see cref="T:System.String"/>. </summary> </member> <member name="M:PSRule.Environment.TrySecureString(System.String,System.Security.SecureString@)"> <summary> Try to get the environment variable as a <see cref="T:System.Security.SecureString"/>. </summary> </member> <member name="M:PSRule.Environment.TryInt(System.String,System.Int32@)"> <summary> Try to get the environment variable as an <see cref="T:System.Int32"/>. </summary> </member> <member name="M:PSRule.Environment.TryBool(System.String,System.Boolean@)"> <summary> Try to get the environment variable as a <see cref="T:System.Boolean"/>. </summary> </member> <member name="M:PSRule.Environment.TryEnum``1(System.String,``0@)"> <summary> Try to get the environment variable as a enum of type <typeparamref name="TEnum"/>. </summary> </member> <member name="M:PSRule.Environment.TryStringArray(System.String,System.String[]@)"> <summary> Try to get the environment variable as an array of strings. </summary> </member> <member name="M:PSRule.Environment.TryStringArrayMap(System.String,PSRule.Data.StringArrayMap@)"> <summary> Try to get the environment variable as a <see cref="T:PSRule.Data.StringArrayMap"/>. </summary> </member> <member name="M:PSRule.Environment.TryPathEnvironmentVariable(System.String[]@)"> <summary> Try to get the PATH environment variable. </summary> </member> <member name="M:PSRule.Environment.TryPathEnvironmentVariable(System.String,System.String[]@)"> <summary> Try to get a PATH environment variable with a specific name. </summary> </member> <member name="M:PSRule.Environment.GetByPrefix(System.String)"> <summary> Try to get any environment variable with a specific prefix. </summary> </member> <member name="T:PSRule.HashtableExtensions"> <summary> Extension methods for <see cref="T:System.Collections.Hashtable"/>. </summary> </member> <member name="M:PSRule.HashtableExtensions.IndexByString(System.Collections.Hashtable,System.Boolean)"> <summary> Map the hashtable into a dictionary string a string key. </summary> </member> <member name="T:PSRule.Options.BaselineOption"> <summary> Options that configure baselines. </summary> </member> <member name="M:PSRule.Options.BaselineOption.#ctor"> <summary> Create an option instance. </summary> </member> <member name="M:PSRule.Options.BaselineOption.#ctor(PSRule.Options.BaselineOption)"> <summary> Create an option instance based on an existing object. </summary> <param name="option">The existing object to copy.</param> </member> <member name="M:PSRule.Options.BaselineOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Options.BaselineOption.Equals(PSRule.Options.BaselineOption)"> <inheritdoc/> </member> <member name="M:PSRule.Options.BaselineOption.GetHashCode"> <inheritdoc/> </member> <member name="M:PSRule.Options.BaselineOption.Combine(PSRule.Options.BaselineOption,PSRule.Options.BaselineOption)"> <summary> Combines two option instances into a new merged instance. The new instance uses any non-null values from <paramref name="o1"/>. Any null values from <paramref name="o1"/> are replaced with <paramref name="o2"/>. </summary> </member> <member name="P:PSRule.Options.BaselineOption.Group"> <summary> A mapping of baseline group names to baselines. </summary> <remarks> See <see href="https://aka.ms/ps-rule/options#baselinegroup"/>. </remarks> </member> <member name="M:PSRule.Options.BaselineOption.Load"> <summary> Load from environment variables. </summary> </member> <member name="M:PSRule.Options.BaselineOption.Load(System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Load from a dictionary. </summary> </member> </members> </doc> |