Microsoft.PSRule.Rules.Azure.Core.xml
|
<?xml version="1.0"?> <doc> <assembly> <name>Microsoft.PSRule.Rules.Azure.Core</name> </assembly> <members> <member name="T:PSRule.Rules.Azure.DictionaryExtensions"> <summary> Extension methods for dictionary instances. </summary> </member> <member name="M:PSRule.Rules.Azure.DictionaryExtensions.AddUnique(System.Collections.Generic.IDictionary{System.String,System.Object},System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})"> <summary> Add an item to the dictionary if it doesn't already exist in the dictionary. </summary> </member> <member name="T:PSRule.Rules.Azure.PSObjectJsonConverter"> <summary> A custom serializer to correctly convert PSObject properties to JSON instead of CLIXML. </summary> </member> <member name="T:PSRule.Rules.Azure.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="M:PSRule.Rules.Azure.JsonExtensions.HasValue(Newtonsoft.Json.Linq.JToken)"> <summary> Determine if the token is a value. </summary> </member> <member name="M:PSRule.Rules.Azure.JsonExtensions.AddRange(Newtonsoft.Json.Linq.JArray,System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})"> <summary> Add items to the array. </summary> <param name="o">The <seealso cref="T:Newtonsoft.Json.Linq.JArray"/> to add items to.</param> <param name="items">A set of items to add.</param> </member> <member name="M:PSRule.Rules.Azure.JsonExtensions.AddRangeFromStart(Newtonsoft.Json.Linq.JArray,System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})"> <summary> Add items to the start of the array instead of the end. </summary> <param name="o">The <seealso cref="T:Newtonsoft.Json.Linq.JArray"/> to add items to.</param> <param name="items">A set of items to add.</param> </member> <member name="M:PSRule.Rules.Azure.JsonExtensions.ConvertPropertyToInt(Newtonsoft.Json.Linq.JObject,System.String)"> <summary> Convert a string property to an integer. </summary> <param name="o">The target object with properties.</param> <param name="propertyName">The name of the property to convert.</param> </member> <member name="M:PSRule.Rules.Azure.JsonExtensions.ConvertPropertyToBool(Newtonsoft.Json.Linq.JObject,System.String)"> <summary> Convert a string property to a boolean. </summary> <param name="o">The target object with properties.</param> <param name="propertyName">The name of the property to convert.</param> </member> <member name="M:PSRule.Rules.Azure.JsonExtensions.TryGetDependencies(Newtonsoft.Json.Linq.JObject,System.String[]@)"> <summary> Get the dependencies for a resource by extracting any identifiers configured on the <c>dependsOn</c> property. </summary> <param name="resource">The resource object to check.</param> <param name="dependencies">An array of dependencies if set.</param> <returns></returns> </member> <member name="M:PSRule.Rules.Azure.JsonExtensions.IsExpressionString(Newtonsoft.Json.Linq.JToken)"> <summary> Check if the script uses an expression. </summary> </member> <member name="M:PSRule.Rules.Azure.LocationHelper.Equal(System.String,System.String)"> <summary> Determines of two Azure locations are equals regardless of spacing or case. </summary> </member> <member name="M:PSRule.Rules.Azure.OutputEncodingExtensions.GetEncoding(System.Nullable{PSRule.Rules.Azure.Configuration.OutputEncoding})"> <summary> Get the character encoding for the specified output encoding. </summary> <param name="encoding"></param> <returns></returns> </member> <member name="M:PSRule.Rules.Azure.ResourceHelper.IsResourceType(System.String,System.String)"> <summary> Determines if the resource Id matches the specified resource type. </summary> <param name="resourceId">The resource Id to compare.</param> <param name="resourceType">The expected resource type.</param> <returns>Returns <c>true</c> if the resource Id matches the type. Otherwise <c>false</c> is returned.</returns> </member> <member name="M:PSRule.Rules.Azure.ResourceHelper.IsSubResourceType(System.String,System.String)"> <summary> Determine if the resource type is a sub-resource of the parent resource Id. </summary> <param name="parentId">The resource Id of the parent resource.</param> <param name="resourceType">The resource type of sub-resource.</param> <returns>Returns <c>true</c> if the resource type is a sub-resource. Otherwise <c>false</c> is returned.</returns> </member> <member name="M:PSRule.Rules.Azure.ResourceHelper.GetResourceType(System.String)"> <summary> Get the resource type of the resource. </summary> <param name="resourceId">The resource Id of a resource.</param> <returns>Returns the resource type if the Id is valid or <c>null</c> when an invalid resource Id is specified.</returns> </member> <member name="M:PSRule.Rules.Azure.ResourceHelper.TryResourceProviderFromType(System.String,System.String@,System.String@)"> <summary> Get the resource provider namespaces and type from a full resource type string. </summary> </member> <member name="M:PSRule.Rules.Azure.ResourceHelper.TrySubscriptionId(System.String,System.String@)"> <summary> Get the subscription Id from a specified resource Id. </summary> </member> <member name="M:PSRule.Rules.Azure.ResourceHelper.TryResourceGroup(System.String,System.String@,System.String@)"> <summary> Get the name of the resource group from the specified resource Id. </summary> </member> <member name="M:PSRule.Rules.Azure.ResourceHelper.CombineResourceId(System.String,System.String,System.String[],System.String[],System.Int32)"> <summary> Combines Id fragments to form a resource Id. </summary> <remarks> /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/{resourceType}/{name} /subscriptions/{subscriptionId}/providers/{resourceType}/{name} /providers/{resourceType}/{name} </remarks> </member> <member name="M:PSRule.Rules.Azure.ResourceHelper.MergeComponents(System.String[],System.String[])"> <summary> Merge type or name components from parent and child. </summary> </member> <member name="M:PSRule.Rules.Azure.ResourceHelper.CombineResourceId(System.String,System.String[],System.String[],System.Int32)"> <summary> Combines Id fragments to form a resource Id at a management group scope. </summary> <remarks> /providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/{resourceType}/{resourceName} </remarks> </member> <member name="M:PSRule.Rules.Azure.StringExtensions.ToCamelCase(System.String)"> <summary> Convert the first character of the string to lower-case. </summary> </member> <member name="M:PSRule.Rules.Azure.StringExtensions.CountCharacterOccurrences(System.String,System.Char)"> <summary> Count the occurances of the specified character in the string. </summary> <param name="str">The original string.</param> <param name="chr">The character to count.</param> <returns>The number of occurances in the string.</returns> </member> <member name="M:PSRule.Rules.Azure.StringExtensions.SplitByLastSubstring(System.String,System.String)"> <summary> Split by the last occurance of the specified substring. </summary> <param name="str">The original string to split.</param> <param name="substring">The substring to split by.</param> <returns>An array of left and right strings based on split.</returns> </member> <member name="M:PSRule.Rules.Azure.StringExtensions.SplitByFirstSubstring(System.String,System.String)"> <summary> Split by the first occurance of the specified substring. </summary> <param name="str">The original string to split.</param> <param name="substring">The substring to split by.</param> <returns>An array of left and right strings based on split.</returns> </member> <member name="M:PSRule.Rules.Azure.StringExtensions.SplitLastSegment(System.String,System.Char)"> <summary> Split a string by a specified character and return the last segment. </summary> <param name="str">The original string to split.</param> <param name="c">The character to split by.</param> <returns>The last segment of the string.</returns> </member> <member name="M:PSRule.Rules.Azure.StringExtensions.IsExpressionString(System.String)"> <summary> Check if the string is an Azure Resource Manager expression. Expression use the <c>[function()]</c> syntax. </summary> </member> <member name="T:PSRule.Rules.Azure.TaskExtensions"> <summary> Helpers for <see cref="T:System.Threading.Tasks.Task"/> instances. </summary> </member> <member name="M:PSRule.Rules.Azure.TaskExtensions.DisposeAll(System.Threading.Tasks.Task[])"> <summary> Call the <c>Dispose</c> method all the specified tasks. </summary> </member> <member name="T:PSRule.Rules.Azure.TypeExtensions"> <summary> Extensions for types. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.ConfigurationOption"> <summary> Options for configuring PSRule for Azure. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ConfigurationOption.#ctor"> <summary> Create an empty configuration option. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ConfigurationOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.ConfigurationOption.Equals(PSRule.Rules.Azure.Configuration.ConfigurationOption)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.ConfigurationOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Configuration.ConfigurationOption.Subscription"> <summary> Configures the properties of the subscription object. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ConfigurationOption.ResourceGroup"> <summary> Configures the properties of the resourceGroup object. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ConfigurationOption.Tenant"> <summary> Configures the properties of the tenant object. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ConfigurationOption.ManagementGroup"> <summary> Configures the properties of the managementGroup object. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ConfigurationOption.ParameterDefaults"> <summary> Configures defaults for required parameters that are not specified. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ConfigurationOption.Deployment"> <summary> Configures the properties of the deployment object. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ConfigurationOption.PolicyRulePrefix"> <summary> Configures the policy rule prefix. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ConfigurationOption.PolicyIgnoreList"> <summary> Configures a list of policy definitions to ignore. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ConfigurationOption.BicepMinimumVersion"> <summary> Configures the minimum version of Bicep to support. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ConfigurationOption.BicepFileExpansionTimeout"> <summary> Configures the timeout when expanding Bicep files. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.DeploymentOption"> <summary> Options that affect the properties of the <c>deployment()</c> object during expansion. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentOption.#ctor"> <summary> Creates an empty deployment option. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentOption.Equals(PSRule.Rules.Azure.Configuration.DeploymentOption)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentOption.op_Equality(PSRule.Rules.Azure.Configuration.DeploymentOption,PSRule.Rules.Azure.Configuration.DeploymentOption)"> <summary> Compares two deployment options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentOption.op_Inequality(PSRule.Rules.Azure.Configuration.DeploymentOption,PSRule.Rules.Azure.Configuration.DeploymentOption)"> <summary> Compares two deployment options to determine if they are not equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentOption.Equals(PSRule.Rules.Azure.Configuration.DeploymentOption,PSRule.Rules.Azure.Configuration.DeploymentOption)"> <summary> Compares two deployment options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Configuration.DeploymentOption.Name"> <summary> The name of the deployment. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.DeploymentReference"> <summary> A reference to a deployment. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.DeploymentReference.Name"> <summary> The name of the deployment. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.DeploymentReference.FromName"> <summary> Determines if the reference is created from a display name. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentReference.op_Implicit(System.Collections.Hashtable)~PSRule.Rules.Azure.Configuration.DeploymentReference"> <summary> Create a deployment reference from a hashtable. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentReference.op_Implicit(System.String)~PSRule.Rules.Azure.Configuration.DeploymentReference"> <summary> Create a deployment reference from a name. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentReference.FromHashtable(System.Collections.Hashtable)"> <summary> Create a deployment reference from a hashtable. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentReference.FromString(System.String)"> <summary> Create a deployment reference from a name. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.DeploymentReference.ToDeploymentOption"> <summary> Convert the reference to an option. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.ManagementGroupOption"> <summary> Options that affect the properties of the <c>managementGroup()</c> object during expansion. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ManagementGroupOption.#ctor"> <summary> Creates an empty management group option. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupProperties"> <summary> Properties for the management group. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupProperties.#ctor"> <summary> Create a default management group properties. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupProperties.DisplayName"> <summary> The display name of the management group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupProperties.TenantId"> <summary> A GUID for the tenant that the management group belongs to. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupProperties.Details"> <summary> Additional details of the management group. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupDetails"> <summary> Details for the management group. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupDetails.#ctor"> <summary> Create a default management group details. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupDetails.Parent"> <summary> Additional details about the parent of the management group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupDetails.UpdatedBy"> <summary> What identity last updated the management group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupDetails.UpdatedTime"> <summary> When the management group was last updated. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupDetails.Version"> <summary> The version. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupParent"> <summary> Parent properties for the management group. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupParent.#ctor"> <summary> Create a default management group parent. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupParent.Id"> <summary> The resource identifier for the parent. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupParent.Name"> <summary> The name of the parent. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.ManagementGroupParent.DisplayName"> <summary> The display name of the parent. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ManagementGroupOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.ManagementGroupOption.Equals(PSRule.Rules.Azure.Configuration.ManagementGroupOption)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.ManagementGroupOption.op_Equality(PSRule.Rules.Azure.Configuration.ManagementGroupOption,PSRule.Rules.Azure.Configuration.ManagementGroupOption)"> <summary> Compares two management group options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ManagementGroupOption.op_Inequality(PSRule.Rules.Azure.Configuration.ManagementGroupOption,PSRule.Rules.Azure.Configuration.ManagementGroupOption)"> <summary> Compares two management group options to determine if they are not equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ManagementGroupOption.Equals(PSRule.Rules.Azure.Configuration.ManagementGroupOption,PSRule.Rules.Azure.Configuration.ManagementGroupOption)"> <summary> Compares two management group options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ManagementGroupOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.Type"> <summary> The Azure resource type. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.Id"> <summary> A unique identifier for the management group. </summary> <remarks> This is a calculated property based on Name. </remarks> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.Name"> <summary> The name of the management group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ManagementGroupOption.Properties"> <summary> Additional properties of the management group. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.OutputEncoding"> <summary> The encoding format to convert output to. </summary> </member> <member name="F:PSRule.Rules.Azure.Configuration.OutputEncoding.Default"> <summary> UTF-8 with Byte Order Mark (BOM). This is the default. </summary> </member> <member name="F:PSRule.Rules.Azure.Configuration.OutputEncoding.UTF8"> <summary> UTF-8 without Byte Order Mark (BOM). </summary> </member> <member name="F:PSRule.Rules.Azure.Configuration.OutputEncoding.UTF7"> <summary> UTF-7. </summary> </member> <member name="F:PSRule.Rules.Azure.Configuration.OutputEncoding.Unicode"> <summary> Unicode. Same as UTF-16. </summary> </member> <member name="F:PSRule.Rules.Azure.Configuration.OutputEncoding.UTF32"> <summary> UTF-32. </summary> </member> <member name="F:PSRule.Rules.Azure.Configuration.OutputEncoding.ASCII"> <summary> ASCII. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.OutputOption"> <summary> Options for generating and formatting output. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.OutputOption.#ctor"> <summary> Create an empty output option. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.OutputOption.#ctor(PSRule.Rules.Azure.Configuration.OutputOption)"> <summary> Create a output option based on an existing option. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.OutputOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.OutputOption.Equals(PSRule.Rules.Azure.Configuration.OutputOption)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.OutputOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Configuration.OutputOption.Encoding"> <summary> The encoding to use when writing results to file. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.OutputOption.Path"> <summary> The file path location to save results. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.ParameterDefaultsOption"> <summary> Options that set parameter defaults for expansion. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ParameterDefaultsOption.#ctor"> <summary> Create an empty parameter defaults option. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ParameterDefaultsOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.ParameterDefaultsOption.Equals(PSRule.Rules.Azure.Configuration.ParameterDefaultsOption)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.ParameterDefaultsOption.op_Equality(PSRule.Rules.Azure.Configuration.ParameterDefaultsOption,PSRule.Rules.Azure.Configuration.ParameterDefaultsOption)"> <summary> Compares two parameter default options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ParameterDefaultsOption.op_Inequality(PSRule.Rules.Azure.Configuration.ParameterDefaultsOption,PSRule.Rules.Azure.Configuration.ParameterDefaultsOption)"> <summary> Compares two parameter default options to determine if they are not equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ParameterDefaultsOption.Equals(PSRule.Rules.Azure.Configuration.ParameterDefaultsOption,PSRule.Rules.Azure.Configuration.ParameterDefaultsOption)"> <summary> Compares two parameter default options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ParameterDefaultsOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Configuration.ParameterDefaultsOption.Item(System.String)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Configuration.PathDelegate"> <summary> A delgate to allow callback to PowerShell to get current working path. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.PSRuleOption"> <summary> Options for configuration PSRule for Azure. </summary> </member> <member name="F:PSRule.Rules.Azure.Configuration.PSRuleOption._GetWorkingPath"> <summary> A callback that is overridden by PowerShell so that the current working path can be retrieved. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.PSRuleOption.#ctor"> <summary> Create an empty PSRule option. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.PSRuleOption.Configuration"> <summary> Options for configuring PSRule for Azure. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.PSRuleOption.Output"> <summary> Options that affect how output is generated. </summary> </member> <member name="M:PSRule.Rules.Azure.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.Rules.Azure.Configuration.PSRuleOption.GetWorkingPath"> <summary> Get the current working path. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.PSRuleOption.FromFileOrDefault(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.Rules.Azure.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.Rules.Azure.Configuration.PSRuleOption.GetRootedPath(System.String)"> <summary> Get a full path instead of a relative path that may be passed from PowerShell. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.PSRuleOption.GetRootedBasePath(System.String)"> <summary> Get a full path instead of a relative path that may be passed from PowerShell. </summary> </member> <member name="M:PSRule.Rules.Azure.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.Rules.Azure.Configuration.ResourceGroupOption"> <summary> Options that affect the properties of the <c>resourceGroup()</c> object during expansion. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupOption.#ctor"> <summary> Creates an empty resource group option. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.ResourceGroupOption.ResourceGroupProperties"> <summary> A set of resource group properties. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupOption.ResourceGroupProperties.#ctor"> <summary> Create default resource group properties. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupOption.ResourceGroupProperties.ProvisioningState"> <summary> The provisioning state of the resource group. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupOption.Equals(PSRule.Rules.Azure.Configuration.ResourceGroupOption)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupOption.op_Equality(PSRule.Rules.Azure.Configuration.ResourceGroupOption,PSRule.Rules.Azure.Configuration.ResourceGroupOption)"> <summary> Compares two resource group options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupOption.op_Inequality(PSRule.Rules.Azure.Configuration.ResourceGroupOption,PSRule.Rules.Azure.Configuration.ResourceGroupOption)"> <summary> Compares two resource group options to determine if they are not equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupOption.Equals(PSRule.Rules.Azure.Configuration.ResourceGroupOption,PSRule.Rules.Azure.Configuration.ResourceGroupOption)"> <summary> Compares two resource group options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupOption.SubscriptionId"> <summary> The unique GUID associated with the subscription. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupOption.Id"> <summary> A unique identifier for the resource group. </summary> <remarks> This is a calculated property based on SubscriptionId and Name. </remarks> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupOption.Name"> <summary> The name of the resource group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupOption.Type"> <summary> The Azure resource type. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupOption.Location"> <summary> The location of the resource group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupOption.ManagedBy"> <summary> The value of the managed by property. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupOption.Tags"> <summary> Any tags assigned to the resource group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupOption.Properties"> <summary> Additional properties for the resource group. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.ResourceGroupReference"> <summary> A reference to a resource group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupReference.Name"> <summary> The name of the resource group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupReference.Location"> <summary> The location of the resource group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupReference.ManagedBy"> <summary> The value of the managed by property. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupReference.Tags"> <summary> Any tags assigned to the resource group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupReference.ProvisioningState"> <summary> The provisioning state for the resource group. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.ResourceGroupReference.FromName"> <summary> Determines if the reference is created from a resource group name. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupReference.op_Implicit(System.Collections.Hashtable)~PSRule.Rules.Azure.Configuration.ResourceGroupReference"> <summary> Create a resource group reference from a hashtable. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupReference.op_Implicit(System.String)~PSRule.Rules.Azure.Configuration.ResourceGroupReference"> <summary> Create a resource group reference from a resource group name. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupReference.FromHashtable(System.Collections.Hashtable)"> <summary> Create a resource group reference from a hashtable. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupReference.FromString(System.String)"> <summary> Create a resource group reference from a resource group name. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.ResourceGroupReference.ToResourceGroupOption"> <summary> Convert the reference to an option. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.SubscriptionOption"> <summary> Options that affect the properties of the <c>subscription()</c> object during expansion. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionOption.#ctor"> <summary> Creates an empty subscription option. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionOption.Equals(PSRule.Rules.Azure.Configuration.SubscriptionOption)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionOption.op_Equality(PSRule.Rules.Azure.Configuration.SubscriptionOption,PSRule.Rules.Azure.Configuration.SubscriptionOption)"> <summary> Compares two subscription options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionOption.op_Inequality(PSRule.Rules.Azure.Configuration.SubscriptionOption,PSRule.Rules.Azure.Configuration.SubscriptionOption)"> <summary> Compares two subscription options to determine if they are not equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionOption.Equals(PSRule.Rules.Azure.Configuration.SubscriptionOption,PSRule.Rules.Azure.Configuration.SubscriptionOption)"> <summary> Compares two subscription options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Configuration.SubscriptionOption.Id"> <summary> A unique identifier for the subscription. </summary> <remarks> This is a calculated property based on SubscriptionId. </remarks> </member> <member name="P:PSRule.Rules.Azure.Configuration.SubscriptionOption.SubscriptionId"> <summary> The unique GUID associated with the subscription. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.SubscriptionOption.TenantId"> <summary> A GUID identifier for the tenant. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.SubscriptionOption.DisplayName"> <summary> The display name of the tenant. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.SubscriptionOption.State"> <summary> The current state of the tenant. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.SubscriptionReference"> <summary> A reference to a subscription. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.SubscriptionReference.SubscriptionId"> <summary> A unique identifier for the subscription. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.SubscriptionReference.TenantId"> <summary> A GUID identifier for the tenant. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.SubscriptionReference.DisplayName"> <summary> The display name of the tenant. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.SubscriptionReference.State"> <summary> The current state of the tenant. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.SubscriptionReference.FromName"> <summary> Determines if the reference is created from a display name. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionReference.op_Implicit(System.Collections.Hashtable)~PSRule.Rules.Azure.Configuration.SubscriptionReference"> <summary> Create a subscription reference from a hashtable. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionReference.op_Implicit(System.String)~PSRule.Rules.Azure.Configuration.SubscriptionReference"> <summary> Create a subscription reference from a display name. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionReference.FromHashtable(System.Collections.Hashtable)"> <summary> Create a subscription reference from a hashtable. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionReference.FromString(System.String)"> <summary> Create a subscription reference from a display name. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.SubscriptionReference.ToSubscriptionOption"> <summary> Convert the reference to an option. </summary> </member> <member name="T:PSRule.Rules.Azure.Configuration.TenantOption"> <summary> Options that affect the properties of the <c>tenant()</c> object during expansion. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.TenantOption.#ctor"> <summary> Creates an empty tenant option. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.TenantOption.Equals(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.TenantOption.Equals(PSRule.Rules.Azure.Configuration.TenantOption)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Configuration.TenantOption.op_Equality(PSRule.Rules.Azure.Configuration.TenantOption,PSRule.Rules.Azure.Configuration.TenantOption)"> <summary> Compares two tenant options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.TenantOption.op_Inequality(PSRule.Rules.Azure.Configuration.TenantOption,PSRule.Rules.Azure.Configuration.TenantOption)"> <summary> Compares two tenant options to determine if they are not equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.TenantOption.Equals(PSRule.Rules.Azure.Configuration.TenantOption,PSRule.Rules.Azure.Configuration.TenantOption)"> <summary> Compares two tenant options to determine if they are equal. </summary> </member> <member name="M:PSRule.Rules.Azure.Configuration.TenantOption.GetHashCode"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Configuration.TenantOption.CountryCode"> <summary> A country code identifier for the tenant. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.TenantOption.Id"> <summary> A unique identifier for the tenant. </summary> <remarks> This is a calculated property based on TenantId. </remarks> </member> <member name="P:PSRule.Rules.Azure.Configuration.TenantOption.TenantId"> <summary> The unique GUID associated with the tenant. </summary> </member> <member name="P:PSRule.Rules.Azure.Configuration.TenantOption.DisplayName"> <summary> The display name of the tenant. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Bicep.BicepHelper"> <summary> A helper for calling the Bicep CLI. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Bicep.BicepHelper.Version"> <summary> The version of Bicep. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Bicep.BicepHelper.GetResources(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext)"> <summary> Get resulting resources from expansion. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Bicep.BicepHelper.GetBicepEnvironmentVariable"> <summary> Check if the <c>PSRULE_AZURE_BICEP_PATH</c> environment variable is set and use this path if set. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Bicep.BicepHelper.GetBicepBinary"> <summary> Get the file name of the Bicep CLI binary. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Bicep.BicepHelper.GetAzBinaryName"> <summary> Get the file name of the Azure CLI binary. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Bicep.BicepHelper.GetBicepBuildAdditionalArgs"> <summary> Check if the <c>PSRULE_AZURE_BICEP_ARGS</c> environment variable is set. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Bicep.BicepHelper.UseAzCLI"> <summary> Check if the <c>PSRULE_AZURE_BICEP_USE_AZURE_CLI</c> environment variable is set. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.CloudEnvironment"> <summary> Properties of an Azure Cloud Environment. This object is exposed by the ARM <c>environment()</c> function. See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-deployment#environment">docs</seealso>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.Name"> <summary> The name of the cloud environment. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.Gallery"> <summary> The gallery endpoint. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.Graph"> <summary> The Microsoft Graph endpoint. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.Portal"> <summary> The Azure Portal endpoint. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.GraphAudience"> <summary> The audience for Microsoft Graph. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.ActiveDirectoryDataLake"> <summary> The audience for Azure Data Lake. Defaults to <c>https://datalake.azure.net/</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.Batch"> <summary> The audience for Azure Branch. Defaults to <c>https://batch.core.windows.net/</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.Media"> <summary> The audience for Azure Media Services. Defaults to <c>https://rest.media.azure.net</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.SqlManagement"> <summary> The audience for Sql Management. Defaults to <c>https://management.core.windows.net:8443/</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.VmImageAliasDoc"> <summary> Documentation reference for VM image aliases. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.ResourceManager"> <summary> The URL for Azure Resource Manager. Defaults to <c>https://management.azure.com/</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.Authentication"> <summary> Authentication properties for the cloud environment. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironment.Suffixes"> <summary> A list of common suffixes that may be cloud environment specific. Use these values instead of hard coding in IaC. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.CloudEnvironmentAuthentication"> <summary> Authentication properties for the cloud environment. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironmentAuthentication.loginEndpoint"> <summary> Azure AD login endpoint. Defaults to <c>https://login.microsoftonline.com/</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironmentAuthentication.audiences"> <summary> Azure Resource Manager audiences. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironmentAuthentication.tenant"> <summary> Azure AD tenant to use. Default to <c>common</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironmentAuthentication.identityProvider"> <summary> The identity provider to use. Defaults to <c>AAD</c>. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.CloudEnvironmentSuffixes"> <summary> Endpoints for Azure cloud environments. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironmentSuffixes.acrLoginServer"> <summary> The suffix for ACR login. Defaults to <c>.azurecr.io</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironmentSuffixes.azureDatalakeAnalyticsCatalogAndJob"> <summary> Defaults to <c>azuredatalakeanalytics.net</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironmentSuffixes.azureDatalakeStoreFileSystem"> <summary> Defaults to <c>azuredatalakestore.net</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironmentSuffixes.azureFrontDoorEndpointSuffix"> <summary> The suffix for Front Door endpoints. Defaults to <c>azurefd.net</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironmentSuffixes.keyvaultDns"> <summary> The suffix for Key Vaults. Defaults to <c>.vault.azure.net</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironmentSuffixes.sqlServerHostname"> <summary> The suffix for Azure SQL Database logical servers. Defaults to <c>.database.windows.net</c>. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.CloudEnvironmentSuffixes.storage"> <summary> The base suffix for Azure Storage services. Defaults to <c>core.windows.net</c>. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.EnvironmentData"> <summary> Defines a datastore of Azure environment data. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.EnvironmentData._Settings"> <summary> Settings for JSON deserialization. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.EnvironmentData.ReadEnvironments(System.String)"> <summary> Deserialize an environments from JSON. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Metadata.ITemplateLink"> <summary> A naming or metadata link between a parameter file to a template or Bicep code. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Metadata.ITemplateLink.TemplateFile"> <summary> The linked template or Bicep code. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Metadata.ITemplateLink.ParameterFile"> <summary> The linked parameter file. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Network.INetworkSecurityGroupEvaluator"> <summary> Evaluates NSG rules to determine resulting access. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Network.INetworkSecurityGroupEvaluator.Outbound(System.String,System.Int32)"> <summary> Determine the resulting outbound access after evaluating NSG rules. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Network.Access"> <summary> The result after evaluating a rule. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Network.Access.Default"> <summary> The result is denies or allowed based on NSG defaults. A specific NSG rule has not been configured to allow or deny. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Network.Access.Allow"> <summary> Access has been permitted. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Network.Access.Deny"> <summary> Access has been denied. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Network.NetworkSecurityGroupEvaluator"> <summary> A basic implementation of an evaluator for checking NSG rules. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Network.NetworkSecurityGroupEvaluator.Outbound(System.String,System.Int32)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Data.Policy.AssignmentReadException"> <summary> An exception that occurs on reading assignments. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.AssignmentReadException.#ctor"> <summary> Creates an assignment read exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.AssignmentReadException.#ctor(System.String)"> <summary> Creates an assignment read exception. </summary> <param name="message">The detail of the exception.</param> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.AssignmentReadException.#ctor(System.String,System.Exception)"> <summary> Creates an assignment read 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.Rules.Azure.Data.Policy.AssignmentReadException.#ctor(System.String,System.Exception,System.String)"> <summary> Create an assignment read exception that reports the related assignment source file. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.AssignmentReadException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create the exception from serialized data. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.AssignmentReadException.AssignmentFile"> <summary> The file path to an Assignment file. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.AssignmentReadException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serialize the exception. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionException"> <summary> A base class for exceptions processing policy definitions. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionException.#ctor"> <summary> Creates a policy definition exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionException.#ctor(System.String)"> <summary> Creates a policy definition exception. </summary> <param name="message">The detail of the exception.</param> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionException.#ctor(System.String,System.Exception)"> <summary> Creates a policy definition 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.Rules.Azure.Data.Policy.PolicyDefinitionException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create the exception from serialized data. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionEmptyConditionException"> <summary> An exception that occurs when a policy definition returns no valid rule condition. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionEmptyConditionException.#ctor"> <summary> Creates an empty condition exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionEmptyConditionException.#ctor(System.String)"> <summary> Creates an empty condition exception. </summary> <param name="message">The detail of the exception.</param> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionEmptyConditionException.#ctor(System.String,System.Exception)"> <summary> Creates an empty condition 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.Rules.Azure.Data.Policy.PolicyDefinitionEmptyConditionException.#ctor(System.String,System.String,System.String,System.String)"> <summary> Creates an empty condition exception based on an assignment and policy definition. </summary> <param name="message">The detail of the exception.</param> <param name="sourceFile">The source file.</param> <param name="assignmentId">Specifies Id of the assignment the exception relates to.</param> <param name="policyDefinitionId">Specifies the Id of the policy definition the exception relates to.</param> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionEmptyConditionException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create the exception from serialized data. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionEmptyConditionException.AssignmentId"> <summary> The unique identifier for the assignment within Azure. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionEmptyConditionException.PolicyDefinitionId"> <summary> The unique identifer for the policy definition within Azure. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyDefinitionEmptyConditionException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serialize the exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.LoggerExtensions.VerbosePolicyIgnoreConfigured(PSRule.Rules.Azure.Pipeline.ILogger,System.String)"> <summary> Policy definition has been ignored based on configuration: {0} </summary> <param name="logger">A logger instance.</param> <param name="definitionId">The policy definition ID.</param> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.LoggerExtensions.VerbosePolicyIgnoreNotApplicable(PSRule.Rules.Azure.Pipeline.ILogger,System.String)"> <summary> Policy definition has been ignored because it is not applicable to Infrastructure as Code: {0} </summary> <param name="logger">A logger instance.</param> <param name="definitionId">The policy definition ID.</param> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.LoggerExtensions.VerbosePolicyIgnoreDuplicate(PSRule.Rules.Azure.Pipeline.ILogger,System.String,System.String)"> <summary> Policy definition has been ignored because a similar built-in rule already exists ({1}): {0} </summary> <param name="logger">A logger instance.</param> <param name="definitionId">The policy definition ID.</param> <param name="ruleName">The name of the built-in rule.</param> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.LoggerExtensions.VerbosePolicyIgnoreDisabled(PSRule.Rules.Azure.Pipeline.ILogger,System.String)"> <summary> Policy definition has been ignored because it is disabled: {0} </summary> <param name="logger">A logger instance.</param> <param name="definitionId">The policy definition ID.</param> </member> <member name="T:PSRule.Rules.Azure.Data.Policy.PolicyDefinition"> <summary> Defines an Azure Policy Definition represented as a PSRule rule. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.Parameters"> <summary> The policy definition parameters </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.DefinitionId"> <summary> The policy definition id. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.Name"> <summary> The name of the rule. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.Description"> <summary> The synopsis of the rule. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.DisplayName"> <summary> The display name of the rule. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.Value"> <summary> The raw original policy definition. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.Condition"> <summary> The spec condition for the rule. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.Where"> <summary> The spec where pre-condition for the rule. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.With"> <summary> The spec with pre-condition for the rule. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.Types"> <summary> The spec type pre-condition for the rule. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.Category"> <summary> An optional metadata category of the policy. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyDefinition.Version"> <summary> An optional metadata version of the policy. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor"> <summary> This visitor processes each assignment to convert the assignment in to one or mny rules. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext"> <summary> A context state used during expanding policy assignments and definitions. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext.AssignmentId"> <summary> A unique identifier for the current assignment that is being processed. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext.PolicyDefinitionId"> <summary> A unique identifier for the current policy definition that is being processed. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext.PropertyNameComparer"> <summary> Comparer class which orders certain properties before others </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext.ExpandPolicyRule(Newtonsoft.Json.Linq.JToken,System.Collections.Generic.IList{System.String})"> <summary> Converts the policy condition to a PSRule rule condition. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext.EnterAssignment(System.String)"> <summary> Set the Id for the assignment that is being processed. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext.ExitAssignment"> <summary> Clean up after processing an assignment. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext.ExitDefinition"> <summary> Clean up after processing a definition. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext.SetPolicyDefinitionId(System.String)"> <summary> Set the Id for the policy definition that is being processed. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext.ShouldIgnorePolicyDefinition(System.String)"> <summary> Determines if the policy definition should be skipped. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext.TryLambdaVariable(System.String,System.Object@)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.Assignment(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,Newtonsoft.Json.Linq.JObject)"> <summary> Process each policy assignment and linked definitions. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.AssignmentParameters(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,Newtonsoft.Json.Linq.JObject)"> <summary> Add parameters for the assignment to the context. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.AssignmentNonComplianceMessages(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JObject})"> <summary> Add any non-compliance messages. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.Definitions(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JObject})"> <summary> Process each policy definition of the assignment. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.ParametersEqual(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,PSRule.Rules.Azure.Data.Policy.IParameterValue,PSRule.Rules.Azure.Data.Policy.IParameterValue)"> <summary> Checks if two parameters are equal </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.TryPolicyDefinition(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,Newtonsoft.Json.Linq.JObject,System.String,PSRule.Rules.Azure.Data.Policy.PolicyDefinition@)"> <summary> Convert each definition into <see cref="T:PSRule.Rules.Azure.Data.Policy.PolicyDefinition"/>. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.VisitPolicyRule(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,PSRule.Rules.Azure.Data.Policy.PolicyDefinition,Newtonsoft.Json.Linq.JObject,System.String)"> <summary> Visit the policyRule node. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.VisitCondition(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,PSRule.Rules.Azure.Data.Policy.PolicyDefinition,Newtonsoft.Json.Linq.JObject)"> <summary> Visit a policy condition node. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.ConvertQuantifiers(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,Newtonsoft.Json.Linq.JObject)"> <summary> Convert quantifiers from policy to PSRule expressions. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.GetPolicyRuleHash(System.String,Newtonsoft.Json.Linq.JObject,Newtonsoft.Json.Linq.JObject,System.Int32)"> <summary> Get hash of definitionID + condition + pre-condition </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.EffectConditions(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,PSRule.Rules.Azure.Data.Policy.PolicyDefinition,Newtonsoft.Json.Linq.JObject,System.String)"> <summary> Handle conditions or pre-conditions associated with the effect of the policy definition. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.IsIfNotExistsEffect(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,Newtonsoft.Json.Linq.JObject)"> <summary> Determines if the effect is AuditIfNotExists or DeployIfNotExists. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.DefaultEffectConditions(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,Newtonsoft.Json.Linq.JObject)"> <summary> Update the condition if then policy effect is Audit, Deny, Modify, or Append. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.TrimPolicyRule(Newtonsoft.Json.Linq.JObject)"> <summary> Removes unneeded properties from the policy rule object. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.ShouldFilterRule(PSRule.Rules.Azure.Data.Policy.PolicyAssignmentVisitor.PolicyAssignmentContext,System.String,Newtonsoft.Json.Linq.JObject,System.String)"> <summary> Determines if the policy definition should be skipped and not generate a rule. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Policy.PolicyJsonRuleMapper"> <summary> Serializes a policy definition to a rule. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyJsonRuleMapper.WriteType(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonSerializer,PSRule.Rules.Azure.Data.Policy.PolicyDefinition)"> <summary> Emit type pre-conditions. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyJsonRuleMapper.WriteWhere(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonSerializer,PSRule.Rules.Azure.Data.Policy.PolicyDefinition)"> <summary> Emit sub-selector pre-condition. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Policy.PolicyJsonRuleMapper.WriteWith(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonSerializer,PSRule.Rules.Azure.Data.Policy.PolicyDefinition)"> <summary> Emit selector pre-condition. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Policy.PolicyMode"> <summary> A list of supported policy modes. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.PolicyIgnoreReason.Duplicate"> <summary> The policy is excluded because it was duplicated with an existing rule. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.PolicyIgnoreReason.NotApplicable"> <summary> The policy is excluded because it is not testable or not applicable for IaC. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.PolicyIgnoreReason.Configured"> <summary> An exclusion configured by the user. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.PolicyIgnoreData._Settings"> <summary> Settings for JSON deserialization. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.ProviderDataExtensions"> <summary> Defines extension methods for Azure resource provider data. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.ProviderData"> <summary> Defines a datastore of Azure resource provider data. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.ProviderData._Settings"> <summary> Settings for JSON deserialization. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.ProviderData.ReadIndex(System.String)"> <summary> Deserialize an index from JSON. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.ProviderData.ReadProviderTypes(System.String)"> <summary> Deserialize resource provider types from JSON. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.ResourceLoader"> <summary> A base class for a helper that loads resources from the assembly. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.ResourceLoader.#ctor"> <summary> Create an instance of the resource loader. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.ResourceLoader.GetContent(System.String)"> <summary> Get the content of a resource stream by name. </summary> <param name="name">The name of the resource stream.</param> <returns>The string content of the resource stream.</returns> <exception cref="T:System.ArgumentNullException">Returns if the name of the resource stream is null or empty.</exception> <exception cref="T:System.ArgumentException">Returned when the specified name does not exist as a resource stream.</exception> </member> <member name="T:PSRule.Rules.Azure.Data.ResourceManagerVisitor"> <summary> A base class for all Azure Resource Manager visitors that implement common methods. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.ResourceProviderType"> <summary> An Azure Resource Type. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.ResourceProviderType.Aliases"> <summary> A list of policy aliases for the resource provider. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.ResourceProviderType.ResourceType"> <summary> The resource type name. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.ResourceProviderType.Locations"> <summary> An array of locations/ regions for the resource provider. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.ResourceProviderType.ApiVersions"> <summary> An array of valid API versions for the resource provider. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.ResourceProviderType.ZoneMappings"> <summary> An array of Availablity Zone mappings for the resource provider. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.AvailabilityZoneMapping"> <summary> An Azure Availability Zone mapping between location and zones. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.AvailabilityZoneMapping.Location"> <summary> The location/ region where AZ is available. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.AvailabilityZoneMapping.Zones"> <summary> The zone names available at the location. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.SecretTemplateData"> <summary> Defines a datastore of possible secret templates that can be used with the list*() functions. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.SecretTemplateData._Settings"> <summary> Settings for JSON deserialization. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.SecretTemplateData.TryGetValue(System.String,System.String,Newtonsoft.Json.Linq.JObject@)"> <summary> Get a template for a secret. </summary> <param name="resourceType">The resource type.</param> <param name="method">The secret method to call. e.g. <c>listKeys</c>.</param> <param name="value">The <seealso cref="T:Newtonsoft.Json.Linq.JObject"/> for the template.</param> <returns>Return <c>true</c> when the resource type and method were found. Otherwise, <c>false</c> is returned.</returns> </member> <member name="M:PSRule.Rules.Azure.Data.SecretTemplateData.ReadSecretTemplate(System.String)"> <summary> Deserialize a secret template from JSON. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.BaseTemplateContext"> <summary> A base implementation for template contexts. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ICidrInfo"> <summary> Defines information for a CIDR. </summary> <remarks> See <seealso href="https://learn.microsoft.com/dotnet/fundamentals/networking/ipv6-overview"/>. </remarks> </member> <member name="T:PSRule.Rules.Azure.Data.Template.CustomTypeTopologyGraph"> <summary> A graph that tracks dependencies between type definitions. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.CustomTypeTopologyGraph.Node.Color"> <summary> The color of the node in the graph. 0 = white, 1 = gray, 2 = black. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.CustomTypeTopologyGraph.Add(System.String,Newtonsoft.Json.Linq.JObject)"> <summary> Add a custom type to the graph. </summary> <param name="name">The custom type node to add to the graph.</param> <param name="value">The definition of the custom type.</param> </member> <member name="M:PSRule.Rules.Azure.Data.Template.CustomTypeTopologyGraph.GetOrdered"> <summary> Get a list of ordered custom types. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.CustomTypeTopologyGraph.Visit(PSRule.Rules.Azure.Data.Template.CustomTypeTopologyGraph.Node,System.Collections.Generic.List{System.Collections.Generic.KeyValuePair{System.String,Newtonsoft.Json.Linq.JObject}})"> <summary> Traverse a node and parent type. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.DebugSymbol"> <summary> A symbol used for debugging and runtime information. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.FunctionErrorType"> <summary> The type of function error. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.FunctionErrorType.MismatchingResourceSegments"> <summary> An error cause by mismatching resource segements. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.TemplateException"> <summary> A base class for an exception relating to a template. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateException.#ctor"> <summary> Create an instance of a template exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateException.#ctor(System.String)"> <summary> Create an instance of a template exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateException.#ctor(System.String,System.Exception)"> <summary> Create an instance of a template exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create an instance of a template exception. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.TemplateParameterException"> <summary> An exception relating to a template parameter. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateParameterException.#ctor"> <summary> Create an instance of a template parameter exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateParameterException.#ctor(System.String)"> <summary> Create an instance of a template parameter exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateParameterException.#ctor(System.String,System.Exception)"> <summary> Create an instance of a template parameter exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateParameterException.#ctor(System.String,System.String)"> <summary> Create an instance of a template parameter exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateParameterException.#ctor(System.String,System.String,System.Exception)"> <summary> Create an instance of a template parameter exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateParameterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create an instance of a template parameter exception. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.TemplateParameterException.ParameterName"> <summary> The name of the parameter. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateParameterException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Data.Template.TemplateOutputException"> <summary> An exception relating to a template output. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateOutputException.#ctor"> <summary> Create an instance of a template output exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateOutputException.#ctor(System.String)"> <summary> Create an instance of a template output exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateOutputException.#ctor(System.String,System.Exception)"> <summary> Create an instance of a template output exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateOutputException.#ctor(System.String,System.String)"> <summary> Create an instance of a template output exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateOutputException.#ctor(System.String,System.String,System.Exception)"> <summary> Create an instance of a template output exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateOutputException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create an instance of a template output exception. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.TemplateOutputException.OutputName"> <summary> The name of the output. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateOutputException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Data.Template.TemplateFunctionException"> <summary> An exception relating to a template function. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateFunctionException.#ctor"> <summary> Create an instance of a template function exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateFunctionException.#ctor(System.String)"> <summary> Create an instance of a template function exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateFunctionException.#ctor(System.String,System.Exception)"> <summary> Create an instance of a template function exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateFunctionException.#ctor(System.String,PSRule.Rules.Azure.Data.Template.FunctionErrorType,System.String)"> <summary> Create an instance of a template function exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateFunctionException.#ctor(System.String,PSRule.Rules.Azure.Data.Template.FunctionErrorType,System.String,System.Exception)"> <summary> Create an instance of a template function exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateFunctionException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create an instance of a template function exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateFunctionException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Data.Template.TemplateFunctionException.FunctionName"> <summary> The name of the function. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.TemplateFunctionException.ErrorType"> <summary> The type of error raised. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ExpressionException"> <summary> A base class for an exception relating to an expression. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionException.#ctor"> <summary> Create an instance of an expression exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionException.#ctor(System.String)"> <summary> Create an instance of an expression exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionException.#ctor(System.String,System.Exception)"> <summary> Create an instance of an expression exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionException.#ctor(System.String,System.String)"> <summary> Create an instance of an expression exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionException.#ctor(System.String,System.String,System.Exception)"> <summary> Create an instance of an expression exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create an instance of an expression exception. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.ExpressionException.Expression"> <summary> The expression that caused the exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ExpressionParseException"> <summary> An exception relating to expression parsing. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionParseException.#ctor"> <summary> Create an instance of an expression pasring exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionParseException.#ctor(System.String)"> <summary> Create an instance of an expression pasring exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionParseException.#ctor(System.String,System.Exception)"> <summary> Create an instance of an expression pasring exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionParseException.#ctor(System.String,System.String)"> <summary> Create an instance of an expression pasring exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionParseException.#ctor(System.String,System.String,System.Exception)"> <summary> Create an instance of an expression pasring exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionParseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create an instance of an expression pasring exception. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.ExpressionParseException.Expression"> <summary> The expression that caused the exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionParseException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ExpressionReferenceException"> <summary> An exception relating to an expression reference. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionReferenceException.#ctor"> <summary> Create an instance of an expression reference exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionReferenceException.#ctor(System.String)"> <summary> Create an instance of an expression reference exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionReferenceException.#ctor(System.String,System.Exception)"> <summary> Create an instance of an expression reference exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionReferenceException.#ctor(System.String,System.String)"> <summary> Create an instance of an expression reference exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionReferenceException.#ctor(System.String,System.String,System.Exception)"> <summary> Create an instance of an expression reference exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionReferenceException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create an instance of an expression reference exception. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.ExpressionReferenceException.Expression"> <summary> The expression that caused the exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionReferenceException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ExpressionEvaluationException"> <summary> An exception relating to expression evaluation. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionEvaluationException.#ctor"> <summary> Create an instance of an expression evaluation exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionEvaluationException.#ctor(System.String)"> <summary> Create an instance of an expression evaluation exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionEvaluationException.#ctor(System.String,System.Exception)"> <summary> Create an instance of an expression evaluation exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionEvaluationException.#ctor(System.String,System.String)"> <summary> Create an instance of an expression evaluation exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionEvaluationException.#ctor(System.String,System.String,System.Exception)"> <summary> Create an instance of an expression evaluation exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionEvaluationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create an instance of an expression evaluation exception. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.ExpressionEvaluationException.Expression"> <summary> The expression that caused the exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionEvaluationException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ExpressionArgumentException"> <summary> An exception relating to expression arguments. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionArgumentException.#ctor"> <summary> Create an instance of an expression argument exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionArgumentException.#ctor(System.String)"> <summary> Create an instance of an expression argument exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionArgumentException.#ctor(System.String,System.Exception)"> <summary> Create an instance of an expression argument exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionArgumentException.#ctor(System.String,System.String)"> <summary> Create an instance of an expression argument exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionArgumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create an instance of an expression argument exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionArgumentException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ExpressionFactory"> <summary> Build and cache descriptors for functions that are implemented in the Azure Resource Manager (ARM) template language. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionFactory.TryDescriptor(System.String,PSRule.Rules.Azure.Data.Template.IFunctionDescriptor@)"> <summary> Try to get a descriptor for a function by name. </summary> <param name="name">The name of the ARM function.</param> <param name="descriptor">A matching descriptor for the function implementation.</param> <returns>Return <c>true</c> when the function is known. Otherwise <c>false</c> is returned.</returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionFactory.With(PSRule.Rules.Azure.Data.Template.IFunctionDescriptor)"> <summary> Add a function to the factory. This is called internally to load built-in functions, but also when user-defined functions are loaded. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionHelpers.TryLong(System.Object,System.Int64@)"> <summary> Try to get an int from the existing object. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionHelpers.TryConvertLong(System.Object,System.Int64@)"> <summary> Try to get an int from the existing type and allow conversion from string. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionHelpers.TryInt(System.Object,System.Int32@)"> <summary> Try to get an int from the existing object. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionHelpers.TryConvertInt(System.Object,System.Int32@)"> <summary> Try to get an int from the existing type and allow conversion from string. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionHelpers.TryBool(System.Object,System.Boolean@)"> <summary> Try to get an bool from the existing object. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionHelpers.TryConvertBool(System.Object,System.Boolean@)"> <summary> Try to get an bool from the existing type and allow conversion from string or int. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionHelpers.UnionObject(System.Object[])"> <summary> Union an object by merging in properties. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionHelpers.TryDateTime(System.Object,System.DateTime@)"> <summary> Try to get DateTime from the existing object. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionHelpers.TryConvertDateTime(System.Object,System.DateTime@,System.Globalization.DateTimeStyles)"> <summary> Try to get DateTime from the existing type and allow conversion from string. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ExpressionParser"> <summary> A helper class used to parse template expressions. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionParser.Parse(System.String)"> <summary> Tokenize an expression. </summary> <param name="expression">The expression.</param> <returns>A stream of tokens representing the expression.</returns> <example> [parameters('vnetName')] [concat('route-', parameters('subnets')[copyIndex('routeIndex')].name)] [concat(split(parameters('addressPrefix')[0], '/')[0], '/27')] </example> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionParser.Function(PSRule.Rules.Azure.Data.Template.ExpressionStream,PSRule.Rules.Azure.Data.Template.TokenStream)"> <summary> Enter a function. </summary> <example> function() </example> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionParser.Index(PSRule.Rules.Azure.Data.Template.ExpressionStream,PSRule.Rules.Azure.Data.Template.TokenStream)"> <summary> Enter an index. </summary> <example> function()[0] </example> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionParser.Inner(PSRule.Rules.Azure.Data.Template.ExpressionStream,PSRule.Rules.Azure.Data.Template.TokenStream)"> <summary> Parse inner tokens. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ExpressionStream"> <summary> A string stream for reading tokenizing template expressions. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.ExpressionStream._Position"> <summary> The current character position in the expression string. Call Next() to change the position. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.ExpressionStream.Current"> <summary> The character at the current position in the stream. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionStream.SkipWhitespace"> <summary> Skip if the current character is whitespace. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionStream.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.Rules.Azure.Data.Template.ExpressionStream.GetEscapeCount(System.Int32)"> <summary> Count excape is used to offset a position if an escape sequence exists. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ExpressionStream.GetDoubleQuoteCount(System.Int32)"> <summary> Count dobule quote is used to offset a postion if double quoting exists with an apostrophe. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.FunctionDescriptor"> <summary> A wrapper for the function definition that can be invoked. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.FunctionDescriptor.Name"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.FunctionDescriptor.Invoke(PSRule.Rules.Azure.Data.Template.ITemplateContext,PSRule.Rules.Azure.Data.Template.DebugSymbol,PSRule.Rules.Azure.Data.Template.ExpressionFnOuter[])"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Data.Template.Functions"> <summary> Implementation of Azure Resource Manager template functions as ExpressionFn. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.Functions.Policy"> <summary> Functions specific to Azure Policy. See <seealso href="https://learn.microsoft.com/azure/governance/policy/concepts/definition-structure#policy-functions">Policy Functions</seealso>. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Array(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> array(convertToArray) See <see href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-array#array"/>. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Coalesce(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> coalesce(arg1, arg2, arg3, ...) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-comparison#coalesce"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Concat(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> concat(arg1, arg2, arg3, ...) </summary> <remarks> Combines multiple arrays and returns the concatenated array, or combines multiple string values and returns the concatenated string. See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-array#concat"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Contains(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> contains(container, itemToFind) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-array#contains"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.CreateArray(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> createArray (arg1, arg2, arg3, ...) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-array#createarray"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.CreateObject(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> createObject(key1, value1, key2, value2, ...) </summary> <remarks> https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-object#createobject </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.First(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> first(arg1) </summary> <remarks> https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-array#first </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Flatten(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> flatten(arrayToFlatten) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/bicep/bicep-functions-array#flatten"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Items(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> items(object) </summary> <remarks> https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-object#items </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Null(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> null() </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Last(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> last(arg1) </summary> <remarks> https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-array#last </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Union(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> union(arg1, arg2, arg3, ...) </summary> <remarks> Returns a single array or object with all elements from the parameters. For arrays, duplicate values are included once. For objects, duplicate property names are only included once. See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-object#union"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Deployment(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> deployment() </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Environment(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> environment() </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Parameters(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> parameters(parameterName) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Variables(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> variables(variableName) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ExtensionResourceId(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> extensionResourceId(resourceId, resourceType, resourceName1, [resourceName2], ...) </summary> <returns> {scope}/providers/{extensionResourceProviderNamespace}/{extensionResourceType}/{extensionResourceName} </returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.List(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> list{Value}(resourceName or resourceIdentifier, apiVersion, functionValues) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.PickZones(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> pickZones(providerNamespace, resourceType, location, [numberOfZones], [offset]) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Reference(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> reference(resourceName or resourceIdentifier, [apiVersion], ['Full']) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ResourceId(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> resourceId([subscriptionId], [resourceGroupName], resourceType, resourceName1, [resourceName2], ...) </summary> <returns> /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} </returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.SubscriptionResourceId(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> subscriptionResourceId([subscriptionId], resourceType, resourceName1, [resourceName2], ...) </summary> <returns> /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} </returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.TenantResourceId(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> tenantResourceId(resourceType, resourceName1, [resourceName2], ...) </summary> <returns> /providers/{resourceProviderNamespace}/{resourceType}/{resourceName} </returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ManagementGroupResourceId(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> managementGroupResourceId(resourceType, resourceName1, [resourceName2], ...) See <see href="https://learn.microsoft.com/azure/azure-resource-manager/bicep/bicep-functions-resource#managementgroupresourceid"/>. </summary> <returns> /providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/{resourceType}/{resourceName} </returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ResourceGroup(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> resourceGroup() </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Subscription(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> subscription() </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Tenant(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> tenant() </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ManagementGroup(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> managementGroup() </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Equals(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> equals(arg1, arg2) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Greater(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> greater(arg1, arg2) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.GreaterOrEquals(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> greaterOrEquals(arg1, arg2) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Less(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> less(arg1, arg2) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.LessOrEquals(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> lessOrEquals(arg1, arg2) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.DateTimeAdd(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> dateTimeAdd(base, duration, [format]) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-date#datetimeadd"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.DateTimeFromEpoch(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> dateTimeFromEpoch(epochTime) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.DateTimeToEpoch(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> dateTimeToEpoch(dateTime) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.UtcNow(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> utcNow(format) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.And(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> and(arg1, arg2, ...) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Bool(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> bool(arg1) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.False(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> false() </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.If(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> if(condition, trueValue, falseValue) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Not(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> not(arg1) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Or(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> or(arg1, arg2, ...) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.True(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> true() </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.IndexOf(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> indexOf(stringToSearch, stringToFind) indexOf(arrayToSearch, itemToFind) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.IndexOfString(System.String,System.String)"> <summary> indexOf(stringToSearch, stringToFind) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-string#indexof"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.IndexOfArray(System.Object,System.Object,System.Boolean)"> <summary> indexOf(arrayToSearch, itemToFind) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-array#indexof"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.LastIndexOf(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> lastIndexOf(stringToSearch, stringToFind) lastIndexOf(arrayToSearch, itemToFind) </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Join(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> join(inputArray, delimiter) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-string#join"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Trim(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> trim(stringToTrim) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-string#trim"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.UniqueString(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> uniqueString(baseString, ...) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-string#uniquestring"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Split(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> split(inputString, delimiter) </summary> <remarks> https://learn.microsoft.com/azure/azure-resource-manager/templates/template-functions-string#split </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Filter(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> filter(inputArray, lambda expression) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/bicep/bicep-functions-lambda#filter"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Map(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> map(inputArray, lambda expression) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/bicep/bicep-functions-lambda#map"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Reduce(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> reduce(inputArray, initialValue, lambda expression) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/bicep/bicep-functions-lambda#reduce"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Sort(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> sort(inputArray, lambda expression) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/bicep/bicep-functions-lambda#sort"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.Lambda(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> Evaluate a lambda expression. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.LambdaVariables(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> Get a lambda variable. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ParseCidr(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> parseCidr(network) </summary> <remarks> See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/bicep/bicep-functions-cidr#parsecidr"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.CidrSubnet(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> cidrSubnet(network, newCIDR, subnetIndex) </summary> <remarks> Splits the specified IP address range in CIDR notation into subnets with a new CIDR value and returns the IP address range of the subnet with the specified index. See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/bicep/bicep-functions-cidr#cidrsubnet"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.CidrHost(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> cidrHost(network, hostIndex) </summary> <remarks> Calculates the usable IP address of the host with the specified index on the specified IP address range in CIDR notation. See <seealso href="https://learn.microsoft.com/azure/azure-resource-manager/bicep/bicep-functions-cidr#cidrhost"/>. </remarks> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ArgumentsOutOfRange(System.String,System.Object[])"> <summary> The number of arguments '{1}' is not within the allowed range for '{0}'. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ArgumentFormatInvalid(System.String)"> <summary> The arguments for '{0}' are not in the expected format or type. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ArgumentInvalidInteger(System.String,System.String)"> <summary> The argument '{0}' for '{1}' is not a valid integer. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ArgumentInvalidDateTime(System.String,System.String)"> <summary> The argument '{0}' for '{1}' is not a valid time. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ArgumentInvalidBoolean(System.String,System.String)"> <summary> The argument '{0}' for '{1}' is not a valid boolean. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ArgumentInvalidString(System.String,System.String)"> <summary> The argument '{0}' for '{1}' is not a valid string. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ArgumentInvalidStringArray(System.String,System.String)"> <summary> The argument '{0}' for '{1}' is not a valid string array. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ArgumentInvalidResourceType(System.String,System.String,System.String)"> <summary> The resource type '{1}/{2}' for '{0}' is not known. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.MismatchingResourceSegments(System.String)"> <summary> The number of resource segments needs to match the provided resource type. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Functions.ArgumentNullNotExpected(System.String)"> <summary> One or more arguments for '{0}' are null when null was not expected. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.IFunctionDescriptor"> <summary> A common interface for defining and invoking ARM functions. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.IFunctionDescriptor.Name"> <summary> The name of the function. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.IFunctionDescriptor.Invoke(PSRule.Rules.Azure.Data.Template.ITemplateContext,PSRule.Rules.Azure.Data.Template.DebugSymbol,PSRule.Rules.Azure.Data.Template.ExpressionFnOuter[])"> <summary> Invoke the function. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ITemplateContext"> <summary> An interface for a template context. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.ITemplateContext.Deployment"> <summary> The current deployment. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ITemplateContext.TryParameter(System.String,System.Object@)"> <summary> Get a parameter from the current context. </summary> <param name="parameterName">The name of the parameter. Parameter names are case-insensitive.</param> <param name="value">The returned value of the parameter.</param> <returns>Returns <c>true</c> if the parameter exists or <c>false</c> if a parameter with the specified name could not be found.</returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ITemplateContext.TryVariable(System.String,System.Object@)"> <summary> Get a variable from the current context. </summary> <param name="variableName">The name of the variable. Variable names are case-insensitive.</param> <param name="value">The returned value of the variable.</param> <returns>Returns <c>true</c> if the variable exists or <c>false</c> if a variable with the specified name could not be found.</returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ITemplateContext.TryLambdaVariable(System.String,System.Object@)"> <summary> Get a lambda variable from the current context scope. This will throw an exception if the current context is not within a lambda expression. </summary> <param name="variableName">The name of the variable. Variable names are case-insensitive.</param> <param name="value">The returned value of the variable.</param> <returns>Returns <c>true</c> if the variable exists or <c>false</c> if a variable with the specified name could not be found.</returns> <exception cref="T:System.NotImplementedException">A lambda variable can not be evaluated outside a lambda expression.</exception> </member> <member name="T:PSRule.Rules.Azure.Data.Template.IValidationContext"> <summary> An interface for a validation context. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.IValidationContext.AddValidationIssue(System.String,System.String,System.String,System.String,System.Object[])"> <summary> Track a validation issue. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.IValidationContext.GetResourceType(System.String,System.String)"> <summary> Lookup a resource type. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.IValidationContext.IsSecureValue(System.Object)"> <summary> Determines if the value is a previously identified secure value. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.LambdaExpressionFn"> <summary> An expression for resolving lambda functions. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.LambdaExpressionFn.#ctor(System.Object[])"> <summary> Create an instance of a lambda function with the specified arguments for the function. </summary> <param name="args">An array of arguments for the function.</param> </member> <member name="M:PSRule.Rules.Azure.Data.Template.LambdaExpressionFn.Filter(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> Call the <c>filter</c> function to filter the input array to items that meet the condition. </summary> <param name="context">The current context.</param> <param name="inputArray">An array of inputs.</param> <returns>An array of items that meet the condition. If not items meet the condition an empty array will be returned.</returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.LambdaExpressionFn.Map(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> Call the <c>map</c> function to transform the input array into items based on the input elements based on a custom function. </summary> <param name="context">The current context.</param> <param name="inputArray">An array of inputs.</param> <returns>An array of transformed items.</returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.LambdaExpressionFn.Reduce(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[],System.Object)"> <summary> Call the <c>reduce</c> function to combine the input array using a custom combining function. </summary> <param name="context">The current context.</param> <param name="inputArray">An array of inputs.</param> <param name="initialValue"></param> <returns>A combined output result from the custom function.</returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.LambdaExpressionFn.Sort(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.Object[])"> <summary> Call the <c>sort</c> function to reorder the input array elements using a custom sorting function. </summary> <param name="context">The current context.</param> <param name="inputArray">An array of inputs.</param> <returns>An array of reordered items.</returns> </member> <member name="T:PSRule.Rules.Azure.Data.Template.Mock.MockUnknownObject"> <summary> Mock an unknown property or value. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.Mock.MockValue"> <summary> Mock a simple value. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Mock.TryMutate``1(Newtonsoft.Json.Linq.JToken,``0@)"> <summary> Tokens are mutated when originally the type of token is unknown. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Mock.TryMutate(PSRule.Rules.Azure.Data.Template.TypePrimitive,Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Linq.JToken@)"> <summary> Tokens are mutated when originally the type of token is unknown. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.Mock.GetBaseObject(System.Object)"> <summary> Unwrap the base object from a JToken. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.MockSecretBuilder"> <summary> A helper class that builds a mock secret. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.MockSecretBuilder.Build(System.String,System.String)"> <summary> Return a mock for a resource type secret. </summary> <param name="resourceId">The identifier for the resource.</param> <param name="symbolName">The name of the symbol that was used for the call. e.g. <c>listKeys</c>.</param> <returns>A mock.</returns> </member> <member name="T:PSRule.Rules.Azure.Data.Template.NestedTemplateContext"> <summary> A implementation for nested template contexts. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.NestedTemplateContext.TryParameter(System.String,System.Object@)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.NestedTemplateContext.TryVariable(System.String,System.Object@)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.NestedTemplateContext.TryLambdaVariable(System.String,System.Object@)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.NestedTemplateContext.TryDefinition(System.String,PSRule.Rules.Azure.Data.Template.ITypeDefinition@)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.NestedTemplateContext.AddValidationIssue(System.String,System.String,System.String,System.String,System.Object[])"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.NestedTemplateContext.GetResourceType(System.String,System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.NestedTemplateContext.IsSecureValue(System.Object)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ResourceDependencyGraph"> <summary> A graph that tracks resource dependencies in scope of a deployment. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ResourceDependencyGraph.Sort(PSRule.Rules.Azure.Data.Template.IResourceValue[])"> <summary> Sort the provided resources based on dependency graph. </summary> <param name="resources">The resources to sort.</param> <returns>An ordered set of resources.</returns> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ResourceDependencyGraph.Track(PSRule.Rules.Azure.Data.Template.IResourceValue,System.String[])"> <summary> Add a resource to the graph. </summary> <param name="resource">The resource node to add to the graph.</param> <param name="dependencies">Any dependencies for the node.</param> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ResourceDependencyGraph.Visit(PSRule.Rules.Azure.Data.Template.ResourceDependencyGraph.Node,System.Collections.Generic.HashSet{System.String},System.Collections.Generic.List{PSRule.Rules.Azure.Data.Template.IResourceValue})"> <summary> Traverse a node and dependencies. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.ResourceValueExtensions.IsExisting(PSRule.Rules.Azure.Data.Template.IResourceValue)"> <summary> Determines if the resource is flagged as an existing reference. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.RuleDataExportVisitor"> <summary> A template visitor for generating rule data. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.RuleDataExportVisitor.BuildMaterializedView(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,PSRule.Rules.Azure.Data.Template.IResourceValue[])"> <summary> Build materialized views. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.RuleDataExportVisitor.ProjectEffectiveProperties(PSRule.Rules.Azure.Data.Template.IResourceValue)"> <summary> Project caulcauted properties into the resourcce. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.RuleDataExportVisitor.ProjectRuntimeProperties(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,PSRule.Rules.Azure.Data.Template.IResourceValue)"> <summary> Project runtime properties that are commonly referenced. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.RuleDataExportVisitor.MergeResource(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,PSRule.Rules.Azure.Data.Template.IResourceValue,System.Collections.Generic.List{PSRule.Rules.Azure.Data.Template.IResourceValue},System.Collections.Generic.HashSet{System.String})"> <summary> Merge resources based on duplicates which could occur across modules. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.RuleDataExportVisitor.MergeResourceLeft(Newtonsoft.Json.Linq.JObject,Newtonsoft.Json.Linq.JObject,System.Collections.Generic.HashSet{System.String})"> <summary> Merge specific resources and thier sub-resources. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.RuleDataExportVisitor.MergeResourceRight(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,PSRule.Rules.Azure.Data.Template.IResourceValue,System.Collections.Generic.List{PSRule.Rules.Azure.Data.Template.IResourceValue},System.Collections.Generic.HashSet{System.String})"> <summary> Merge resources based on duplicates which could occur across modules. Last instance wins but sub-resources are accumulated. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.RuleDataExportVisitor.MergeResourceRight(Newtonsoft.Json.Linq.JObject,Newtonsoft.Json.Linq.JObject,System.Collections.Generic.HashSet{System.String})"> <summary> Merge resources sub-resources only. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.RuleDataExportVisitor.MoveResource(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,PSRule.Rules.Azure.Data.Template.IResourceValue)"> <summary> Move sub-resources based on parent resource relationship. This process nests sub-resources so that relationship can be analyzed. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.RuleDataExportVisitor.ShouldMove(System.String)"> <summary> Determines if the specific sub-resource type should be nested. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.RuleDataExportVisitor.ShouldMergeLeft(System.String)"> <summary> Determines if the specific resource type should be merged. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateContextExtensions.TryLambdaVariable``1(PSRule.Rules.Azure.Data.Template.ITemplateContext,System.String,``0@)"> <summary> Get a lambda variable from the current context scope. This will throw an exception if the current context is not within a lambda expression. </summary> <param name="context">An instance of a <see cref="T:PSRule.Rules.Azure.Data.Template.ITemplateContext"/>.</param> <param name="variableName">The name of the variable. Variable names are case-insensitive.</param> <param name="value">The returned value of the variable.</param> <returns>Returns <c>true</c> if the variable exists or <c>false</c> if a variable with the specified name could not be found.</returns> <exception cref="T:System.NotImplementedException">A lambda variable can not be evaluated outside a lambda expression.</exception> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateLinkHelper.IsParameterFile(Newtonsoft.Json.Linq.JObject)"> <summary> Check the JSON object is an ARM template parameter file. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateLinkHelper.TryMetadata(Newtonsoft.Json.Linq.JObject,System.String,Newtonsoft.Json.Linq.JObject@,System.String@)"> <summary> Try to find the template file from a root metadata property. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateLinkHelper.TryTemplateByName(System.String,System.String,System.String@)"> <summary> Try to match using templateName.parameters.json. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.StringExpression`1"> <summary> A string expression. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.TemplateVisitor"> <summary> The base class for a template visitor. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext.Deployment"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext.RootDeployment"> <summary> The top level deployment. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext.TrackSecureValue(System.String,PSRule.Rules.Azure.Data.Template.ParameterType,System.Object)"> <summary> Keeps track of secure values. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext.IsSecureValue(System.Object)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext.TryParameter(System.String,System.Object@)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext.TryVariable(System.String,System.Object@)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext.GetResourceType(System.String,System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext.AddValidationIssue(System.String,System.String,System.String,System.String,System.Object[])"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext.TryLambdaVariable(System.String,System.Object@)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext.TrackDependencies(PSRule.Rules.Azure.Data.Template.IResourceValue,System.String[])"> <summary> Track dependencies against the resource. </summary> <param name="resource">The resource with dependencies to track.</param> <param name="dependencies">An array of dependencies as resource IDs or symbolic names.</param> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TryParameterDefaultValue(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,System.String,Newtonsoft.Json.Linq.JObject)"> <summary> Try to fill parameter from default value. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TryParameterNullable(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,System.String,Newtonsoft.Json.Linq.JObject)"> <summary> Handle cases when the parameter has been marked as nullable. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.ResourceExpand(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,System.String,Newtonsoft.Json.Linq.JObject)"> <summary> Expand copied resources. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.Trim(Newtonsoft.Json.Linq.JToken)"> <summary> Trim objects to remove null properties. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.TryDeploymentResource(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,Newtonsoft.Json.Linq.JObject)"> <summary> Handle a nested deployment resource. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.ResolveProperties(PSRule.Rules.Azure.Data.Template.ITemplateContext,Newtonsoft.Json.Linq.JObject)"> <summary> Expand each property. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.GetPropertyIterator(PSRule.Rules.Azure.Data.Template.ITemplateContext,Newtonsoft.Json.Linq.JObject)"> <summary> Get a property based iterator copy. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.GetOutputIterator(PSRule.Rules.Azure.Data.Template.ITemplateContext,Newtonsoft.Json.Linq.JObject)"> <summary> Get an iterator for outputs. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.GetResourceIterator(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,Newtonsoft.Json.Linq.JObject)"> <summary> Get a resource based iterator copy. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.Emit(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,PSRule.Rules.Azure.Data.Template.IResourceValue)"> <summary> Emit a resource object. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.SortResources(PSRule.Rules.Azure.Data.Template.TemplateVisitor.TemplateContext,PSRule.Rules.Azure.Data.Template.IResourceValue[])"> <summary> Sort resources by dependencies. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.ThrowTemplateParameterException(System.String)"> <summary> The type for parameter '{0}' was not defined or invalid. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TemplateVisitor.ThrowTemplateOutputException(System.String)"> <summary> The type for output '{0}' was not defined or invalid. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ExpressionTokenType"> <summary> The available token types used for Azure Resource Manager expressions. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.ExpressionTokenType.None"> <summary> Null token. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.ExpressionTokenType.Element"> <summary> A function name. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.ExpressionTokenType.Property"> <summary> A property <c>.property_name</c>. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.ExpressionTokenType.String"> <summary> A string literal. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.ExpressionTokenType.Numeric"> <summary> A numeric literal. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.ExpressionTokenType.GroupStart"> <summary> Start a grouping <c>'('</c>. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.ExpressionTokenType.GroupEnd"> <summary> End a grouping <c>')'</c>. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.ExpressionTokenType.IndexStart"> <summary> Start an index <c>'['</c>. </summary> </member> <member name="F:PSRule.Rules.Azure.Data.Template.ExpressionTokenType.IndexEnd"> <summary> End an index <c>']'</c>. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.ExpressionToken"> <summary> An individual expression token. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.TokenStreamExtensions"> <summary> Add an expression token to a token stream. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.TokenStream"> <summary> A stream of template expression tokens. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.Template.TokenStreamValidator"> <summary> A validator which checks a stream of tokens. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TokenStreamValidator.HasLiteralValue(PSRule.Rules.Azure.Data.Template.TokenStream)"> <summary> Look for literal values or use of variables(). </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TokenStreamValidator.GetParameterTokenValue(PSRule.Rules.Azure.Data.Template.TokenStream)"> <summary> Get the names of parameters that would be assigned as values. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TokenStreamValidator.UsesListKeysFunction(PSRule.Rules.Azure.Data.Template.TokenStream)"> <summary> Returns true if an expression contains a call to the listKeys function. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TokenStreamValidator.UsesReferenceFunction(PSRule.Rules.Azure.Data.Template.TokenStream)"> <summary> Returns true if an expression contains a call to the reference function. </summary> </member> <member name="M:PSRule.Rules.Azure.Data.Template.TokenStreamValidator.SkipIndex(PSRule.Rules.Azure.Data.Template.TokenStream)"> <summary> Skip index-based properties of an object or array. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.TypeIndexEntry"> <summary> An index location. </summary> </member> <member name="T:PSRule.Rules.Azure.Data.TypeIndex"> <summary> Defines an index of Azure resource provider types. </summary> </member> <member name="P:PSRule.Rules.Azure.Data.TypeIndex.Resources"> <summary> Available resource types, indexed by resource type name. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.AccessToken"> <summary> An OAuth2 access token. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.AccessToken.#ctor(System.String,System.DateTimeOffset,System.String)"> <summary> Create an instance of an access token. </summary> <param name="token">The base64 encoded token.</param> <param name="expiry">An offset for when the token expires.</param> <param name="tenantId">A unique identifier for the Azure AD tenent associated to the token.</param> </member> <member name="P:PSRule.Rules.Azure.Pipeline.AccessToken.Token"> <summary> The base64 encoded token. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.AccessToken.Expiry"> <summary> An offset for when the token expires. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.AccessToken.TenantId"> <summary> A unique identifier for the Azure AD tenent associated to the token. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.AccessToken.ShouldRefresh"> <summary> Determine if the access token should be refreshed. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.PipelineException"> <summary> A base class for all pipeline exceptions. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineException.#ctor"> <summary> Creates a pipeline exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineException.#ctor(System.String)"> <summary> Creates a pipeline exception. </summary> <param name="message">The detail of the exception.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineException.#ctor(System.String,System.Exception)"> <summary> Creates a pipeline 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.Rules.Azure.Pipeline.PipelineException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create the exception from serialized data. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.PipelineSerializationException"> <summary> A serialization exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineSerializationException.#ctor"> <summary> Creates a serialization exception. </summary> </member> <member name="M:PSRule.Rules.Azure.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.Rules.Azure.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.Rules.Azure.Pipeline.PipelineSerializationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create the exception from serialized data. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineSerializationException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serialize the exception. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.TemplateReadException"> <summary> An exception related to reading templates. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplateReadException.#ctor"> <summary> Creates a template read exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplateReadException.#ctor(System.String)"> <summary> Creates a template read exception. </summary> <param name="message">The detail of the exception.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplateReadException.#ctor(System.String,System.Exception)"> <summary> Creates a template read 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.Rules.Azure.Pipeline.TemplateReadException.#ctor(System.String,System.Exception,System.String,System.String)"> <summary> Creates a template read exception. </summary> <param name="message">The detail of the exception.</param> <param name="innerException">A nested exception that caused the issue.</param> <param name="templateFile">The path to the ARM template file that is being used.</param> <param name="parameterFile">The path to the ARM template parameter file that is being used.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplateReadException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create the exception from serialized data. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.TemplateReadException.TemplateFile"> <summary> The file path to an Azure Template. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.TemplateReadException.ParameterFile"> <summary> The file path to an Azure Template parameter file. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplateReadException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serialize the exception. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.InvalidTemplateLinkException"> <summary> An exception related to template linking. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.InvalidTemplateLinkException.#ctor"> <summary> Creates a template linking exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.InvalidTemplateLinkException.#ctor(System.String)"> <summary> Creates a template linking exception. </summary> <param name="message">The detail of the exception.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.InvalidTemplateLinkException.#ctor(System.String,System.Exception)"> <summary> Creates a template linking 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.Rules.Azure.Pipeline.InvalidTemplateLinkException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create the exception from serialized data. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.InvalidTemplateLinkException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serialize the exception. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.BicepCompileException"> <summary> An exception related to compiling Bicep source files. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.BicepCompileException.#ctor"> <summary> Creates a Bicep compile exception. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.BicepCompileException.#ctor(System.String)"> <summary> Creates a Bicep compile exception. </summary> <param name="message">The detail of the exception.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.BicepCompileException.#ctor(System.String,System.Exception)"> <summary> Creates a Bicep compile 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.Rules.Azure.Pipeline.BicepCompileException.#ctor(System.String,System.Exception,System.String,System.String)"> <summary> Creates a Bicep compile exception. </summary> <param name="message">The detail of the exception.</param> <param name="innerException">A nested exception that caused the issue.</param> <param name="sourceFile">The path to the Bicep source file.</param> <param name="version">Specifies the version of Bicep runtime being used.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.BicepCompileException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Create the exception from serialized data. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.BicepCompileException.SourceFile"> <summary> The file path to an Azure Bicep source file. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.BicepCompileException.Version"> <summary> The version of the Bicep binary. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.BicepCompileException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serialize the exception. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.Export.AccessTokenCache"> <summary> Define a cache for storing and refreshing tokens. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.AccessTokenCache.#ctor(PSRule.Rules.Azure.Pipeline.GetAccessTokenFn)"> <summary> Create an instance of a token cache. </summary> <param name="getToken">A delegate method to get a token for a tenant.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.AccessTokenCache.RefreshAll"> <summary> Check and refresh all tokens as required. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.AccessTokenCache.RefreshToken(System.String)"> <summary> Refresh a token for the specified tenant. </summary> <param name="tenantId">The tenant Id of the specific tenant to refresh the token for.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.AccessTokenCache.GetToken(System.String)"> <summary> Get an access token for the specified tenant. The token will be synchronized to the main thread. </summary> <param name="tenantId">The tenant Id of the specific tenant to get a token for.</param> <returns>An access token or <c>null</c>.</returns> </member> <member name="T:PSRule.Rules.Azure.Pipeline.Export.ExportDataContext"> <summary> A base context to export data from Azure. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.IResourceExportContext.GetAsync(System.String,System.String,System.String)"> <summary> Get a resource. </summary> <param name="tenantId">The tenant Id for the request.</param> <param name="requestUri">The resource URI.</param> <param name="apiVersion">The apiVersion of the resource provider.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.IResourceExportContext.ListAsync(System.String,System.String,System.String,System.Boolean)"> <summary> List resources. </summary> <param name="tenantId">The tenant Id for the request.</param> <param name="requestUri">The resource URI.</param> <param name="apiVersion">The apiVersion of the resource provider.</param> <param name="ignoreNotFound">Determines if not found status is ignored. Otherwise a warning is logged.</param> </member> <member name="T:PSRule.Rules.Azure.Pipeline.Export.ResourceExportContext"> <summary> A context to export an Azure resource. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.ResourceExportContext.GetAsync(System.String,System.String,System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.ResourceExportContext.ListAsync(System.String,System.String,System.String,System.Boolean)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Pipeline.Export.ResourceExportVisitor"> <summary> Defines a class that gets and sets additional properties and sub-resources of a resource from an Azure subscription. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.ResourceExportVisitor.GetProperties(PSRule.Rules.Azure.Pipeline.Export.ResourceExportVisitor.ResourceContext,Newtonsoft.Json.Linq.JObject,System.String,System.String)"> <summary> Get the <c>properties</c> property for a resource if it hasn't been already expanded. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.ResourceExportVisitor.SetResourceIdentifiers(Newtonsoft.Json.Linq.JObject,System.String,System.String)"> <summary> Set <c>subscriptionId</c> and <c>resourceGroupName</c> on the resource based on the provided <c>resourceId</c>. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.ResourceExportVisitor.GetDiagnosticSettings(PSRule.Rules.Azure.Pipeline.Export.ResourceExportVisitor.ResourceContext,Newtonsoft.Json.Linq.JObject,System.String)"> <summary> Get diagnostics for the specified resource type. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.ISubscriptionExportContext.GetResourcesAsync"> <summary> Get resources from an Azure subscription. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.ISubscriptionExportContext.GetResourceGroupsAsync"> <summary> Get resource groups from an Azure subscription. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.ISubscriptionExportContext.GetSubscriptionAsync"> <summary> Get a resource for the Azure subscription. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.ISubscriptionExportContext.GetResourceAsync(System.String)"> <summary> Get a specified Azure resource from a subscription. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.Export.ISubscriptionExportContext.SubscriptionId"> <summary> The subscription Id of the context subscription. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.Export.ISubscriptionExportContext.TenantId"> <summary> The tenant Id of the context tenant. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.Export.SubscriptionExportContext"> <summary> A context to export an Azure subscription. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.SubscriptionExportContext.#ctor(PSRule.Rules.Azure.Pipeline.PipelineContext,PSRule.Rules.Azure.Pipeline.ExportSubscriptionScope,PSRule.Rules.Azure.Pipeline.Export.AccessTokenCache,System.Collections.Hashtable)"> <summary> Create a context to export an Azure subscription. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.Export.SubscriptionExportContext.SubscriptionId"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Pipeline.Export.SubscriptionExportContext.TenantId"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.SubscriptionExportContext.GetResourcesAsync"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.SubscriptionExportContext.GetResourceGroupsAsync"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.SubscriptionExportContext.GetSubscriptionAsync"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Export.SubscriptionExportContext.GetResourceAsync(System.String)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Pipeline.ExportDataPipeline"> <summary> A base class for a pipeline that exports data from Azure. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.ExportDataPipeline.PoolSize"> <summary> The size of the thread pool for the pipeline. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.GetAccessTokenFn"> <summary> A delegate that returns an Access Token. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.IExportDataPipelineBuilder"> <summary> A builder to configure the pipeline to export data. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IExportDataPipelineBuilder.AccessToken(PSRule.Rules.Azure.Pipeline.GetAccessTokenFn)"> <summary> Configures a method to request an Access Token. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.ExportDataPipelineBuilder"> <summary> A helper to build a pipeline to export data from Azure. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ExportDataPipelineBuilder.AccessToken(PSRule.Rules.Azure.Pipeline.GetAccessTokenFn)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ExportDataPipelineBuilder.RetryCount(System.Int32)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ExportDataPipelineBuilder.RetryInterval(System.Int32)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Pipeline.ExportSubscriptionScope"> <summary> The details for a subscription to export. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ExportSubscriptionScope.#ctor(System.String,System.String)"> <summary> Create a scope structure containing details for the subscription to export. </summary> <param name="subscriptionId">The subscription Id for the subscription to export.</param> <param name="tenantId">The tenant Id associated to the subscription being exported.</param> </member> <member name="P:PSRule.Rules.Azure.Pipeline.ExportSubscriptionScope.SubscriptionId"> <summary> The subscription Id for the subscription to export. This is a <seealso cref="T:System.Guid"/> identifier. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.ExportSubscriptionScope.TenantId"> <summary> The tenant Id associated to the subscription being exported. This is a <seealso cref="T:System.Guid"/> identifier. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.LoggingExtensions"> <summary> Extensions for logging to the pipeline. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.LoggingExtensions.VerboseGetResources(PSRule.Rules.Azure.Pipeline.ILogger,System.String)"> <summary> Getting resources from subscription: {0} </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.LoggingExtensions.VerboseGetResourcesResult(PSRule.Rules.Azure.Pipeline.ILogger,System.Int32,System.String)"> <summary> Added {0} resources from subscription '{1}'. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.LoggingExtensions.VerboseGetResource(PSRule.Rules.Azure.Pipeline.ILogger,System.String)"> <summary> Getting resource: {0} </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.LoggingExtensions.VerboseExpandingResource(PSRule.Rules.Azure.Pipeline.ILogger,System.String)"> <summary> Expanding resource: {0} </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.LoggingExtensions.VerboseRetryIn(PSRule.Rules.Azure.Pipeline.ILogger,System.String,System.TimeSpan,System.Int32)"> <summary> Retrying '{0}' in {1}, attept {2}. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.LoggingExtensions.WarnFailedToGet(PSRule.Rules.Azure.Pipeline.ILogger,System.String,System.Net.HttpStatusCode,System.String,System.String)"> <summary> Failed to get '{0}': status={1}, correlation-id={2}, {3} </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.Output.FileOutputWriter"> <summary> An output writer that writes output to disk. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.Output.PSPipelineWriter"> <summary> An output writer that returns output to the host PowerShell runspace. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Output.PSPipelineWriter.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.Rules.Azure.Pipeline.Output.PSPipelineWriter.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.Rules.Azure.Pipeline.Output.PSPipelineWriter.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.Rules.Azure.Pipeline.Output.PSPipelineWriter.WriteInformation(System.Management.Automation.InformationRecord)"> <summary> Core method to hand off information messages to logger. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.Output.PSPipelineWriter.WriteDebug(System.Management.Automation.DebugRecord)"> <summary> Core method to hand off debug messages to logger. </summary> </member> <member name="T:PSRule.Rules.Azure.Pipeline.PathBuilder"> <summary> A helper to build a list of rule sources for discovery. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PathBuilder.GetSearchParameters(System.String,System.String@,System.IO.SearchOption@)"> <summary> Split a search path into components based on wildcards. </summary> </member> <member name="M:PSRule.Rules.Azure.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="T:PSRule.Rules.Azure.Pipeline.PipelineBuilder"> <summary> A helper class for building a pipeline from PowerShell. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineBuilder.Template(PSRule.Rules.Azure.Configuration.PSRuleOption)"> <summary> Create a builder for a template expanding pipeline. </summary> <param name="option">Options that configure PSRule for Azure.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineBuilder.TemplateLink(System.String)"> <summary> Create a builder for a template link discovery pipeline. </summary> <param name="path">The base path to search from.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineBuilder.Assignment(PSRule.Rules.Azure.Configuration.PSRuleOption)"> <summary> Create a builder for a policy assignment export pipeline. </summary> <param name="option">Options that configure PSRule for Azure.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineBuilder.AssignmentSearch(System.String)"> <summary> Create a builder for a policy to rule generation pipeline. </summary> <param name="path">The base path to search from.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineBuilder.ResourceData(PSRule.Rules.Azure.Configuration.PSRuleOption)"> <summary> Create a builder for creating a pipeline to exporting resource data from Azure. </summary> <param name="option">Options that configure PSRule for Azure.</param> <returns>A builder object to configure the pipeline.</returns> </member> <member name="T:PSRule.Rules.Azure.Pipeline.IPipelineBuilder"> <summary> A helper to build a PSRule for Azure pipeline. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IPipelineBuilder.UseCommandRuntime(System.Management.Automation.PSCmdlet)"> <summary> Configure the pipeline with cmdlet runtime information. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IPipelineBuilder.UseExecutionContext(System.Management.Automation.EngineIntrinsics)"> <summary> Configure the pipeline with a PowerShell execution context. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IPipelineBuilder.Configure(PSRule.Rules.Azure.Configuration.PSRuleOption)"> <summary> Configure the pipeline with options. </summary> <param name="option">Options that configure PSRule for Azure.</param> <returns></returns> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IPipelineBuilder.Build"> <summary> Build the pipeline. </summary> <returns>An instance of a configured pipeline.</returns> </member> <member name="T:PSRule.Rules.Azure.Pipeline.IPipeline"> <summary> An instance of a PSRule for Azure pipeline. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IPipeline.Begin"> <summary> Initalize the pipeline and results. Call this method once prior to calling Process. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IPipeline.Process(System.Management.Automation.PSObject)"> <summary> Process an object through the pipeline. </summary> <param name="sourceObject">The object to process.</param> </member> <member name="M:PSRule.Rules.Azure.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.Rules.Azure.Pipeline.PipelineBuilderBase.UseCommandRuntime(System.Management.Automation.PSCmdlet)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineBuilderBase.UseExecutionContext(System.Management.Automation.EngineIntrinsics)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineBuilderBase.Configure(PSRule.Rules.Azure.Configuration.PSRuleOption)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineBuilderBase.Build"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineBase.Begin"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineBase.Process(System.Management.Automation.PSObject)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PipelineBase.End"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PolicyAssignmentPipeline.Process(System.Management.Automation.PSObject)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Pipeline.IPolicyAssignmentPipelineBuilder"> <summary> A builder for a policy assignment export pipeline. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IPolicyAssignmentPipelineBuilder.PassThru(System.Boolean)"> <summary> Enable pass-through of output from the pipeline. </summary> <param name="passThru">Enable pass-through.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IPolicyAssignmentPipelineBuilder.KeepDuplicates(System.Boolean)"> <summary> Determines if policy definitions that duplicate existing built-in rules are exported. </summary> <param name="keepDuplicates">Enable exporting duplicates.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PolicyAssignmentPipelineBuilder.PassThru(System.Boolean)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PolicyAssignmentPipelineBuilder.KeepDuplicates(System.Boolean)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PolicyAssignmentPipelineBuilder.Build"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PolicyAssignmentSearchPipeline.Process(System.Management.Automation.PSObject)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Pipeline.IPolicyAssignmentSearchPipelineBuilder"> <summary> A builder for a policy to rule generation pipeline. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PolicyAssignmentSearchPipelineBuilder.Build"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Pipeline.PolicyAssignmentSource"> <summary> A policy assignment source file. </summary> </member> <member name="P:PSRule.Rules.Azure.Pipeline.PolicyAssignmentSource.AssignmentFile"> <summary> The assignment source file. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.PolicyAssignmentSource.#ctor(System.String)"> <summary> Create an assignment instance. </summary> <param name="assignmentFile">The assignment source file.</param> </member> <member name="T:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline"> <summary> A pipeline to export resource data from Azure. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline.Begin"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline.Process(System.Management.Automation.PSObject)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline.End"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline.WriteOutput"> <summary> Write output to file or pipeline. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline.GetResourceById(System.String)"> <summary> Get a resource for expansion by resource Id. </summary> <param name="resourceId">The specified resource Id.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline.GetResourceAsync(PSRule.Rules.Azure.Pipeline.Export.ISubscriptionExportContext,System.String)"> <summary> Get a specific resource by Id. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline.GetResourceBySubscription(PSRule.Rules.Azure.Pipeline.ExportSubscriptionScope)"> <summary> Get resources, resource groups and the specified subscription within the subscription scope. Resources are then queued for expansion. </summary> <param name="scope">The subscription scope.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline.GetSubscriptionAsync(PSRule.Rules.Azure.Pipeline.Export.ISubscriptionExportContext)"> <summary> Get a subscription resource. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline.GetResourceGroupsAsync(PSRule.Rules.Azure.Pipeline.Export.ISubscriptionExportContext)"> <summary> Get a list of resource groups for a subscription. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline.GetResourcesAsync(PSRule.Rules.Azure.Pipeline.Export.ISubscriptionExportContext)"> <summary> Get a list of resources for a subscription. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipeline.ExpandResource(System.Int32)"> <summary> Expand resources from the queue. </summary> <param name="poolSize">The size of the thread pool to use.</param> </member> <member name="T:PSRule.Rules.Azure.Pipeline.IResourceDataPipelineBuilder"> <summary> A builder to configure the pipeline to export Azure resource data. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IResourceDataPipelineBuilder.ResourceGroup(System.String[])"> <summary> Specifies any resource group filters to be used. </summary> <param name="resourceGroup">If any are specified, only these resource groups will be included in results.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IResourceDataPipelineBuilder.Subscription(PSRule.Rules.Azure.Pipeline.ExportSubscriptionScope[])"> <summary> Specifies any subscriptions filters to be used. </summary> <param name="scope">If any are specified, only these subscriptions will be included in results.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IResourceDataPipelineBuilder.Tag(System.Collections.Hashtable)"> <summary> Specifies additional tags to filter resources by. </summary> <param name="tag">A hashtable of tags to use for filtering resources.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IResourceDataPipelineBuilder.OutputPath(System.String)"> <summary> Specifies the path to write output. </summary> <param name="path">The directory path to write output.</param> </member> <member name="M:PSRule.Rules.Azure.Pipeline.IResourceDataPipelineBuilder.Tenant(System.String)"> <summary> Specifies the default tenant to use when the tenant is unknown. </summary> <param name="tenantId">The tenant Id of the default tenant.</param> </member> <member name="T:PSRule.Rules.Azure.Pipeline.ResourceDataPipelineBuilder"> <summary> A helper to build a pipeline that exports resource data from Azure. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipelineBuilder.ResourceGroup(System.String[])"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipelineBuilder.Subscription(PSRule.Rules.Azure.Pipeline.ExportSubscriptionScope[])"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipelineBuilder.Tag(System.Collections.Hashtable)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipelineBuilder.OutputPath(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipelineBuilder.Tenant(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ResourceDataPipelineBuilder.Build"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplateLinkPipeline.Process(System.Management.Automation.PSObject)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Pipeline.ITemplateLinkPipelineBuilder"> <summary> A helper to build a template link pipeline. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ITemplateLinkPipelineBuilder.SkipUnlinked(System.Boolean)"> <summary> Determines if unlinked parameter files are skipped or error. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplateLinkPipelineBuilder.SkipUnlinked(System.Boolean)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplateLinkPipelineBuilder.Build"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplatePipeline.Process(System.Management.Automation.PSObject)"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Pipeline.ITemplatePipelineBuilder"> <summary> A helper for building a template expansion pipeline. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ITemplatePipelineBuilder.Deployment(System.String)"> <summary> Configures the name of the deployment. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ITemplatePipelineBuilder.ResourceGroup(PSRule.Rules.Azure.Configuration.ResourceGroupOption)"> <summary> Configures properties of the resource group. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ITemplatePipelineBuilder.Subscription(PSRule.Rules.Azure.Configuration.SubscriptionOption)"> <summary> Configures properties of the subscription. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.ITemplatePipelineBuilder.PassThru(System.Boolean)"> <summary> Determines if expanded resources are passed through to the pipeline. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplatePipelineBuilder.Deployment(System.String)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplatePipelineBuilder.ResourceGroup(PSRule.Rules.Azure.Configuration.ResourceGroupOption)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplatePipelineBuilder.Subscription(PSRule.Rules.Azure.Configuration.SubscriptionOption)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplatePipelineBuilder.PassThru(System.Boolean)"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplatePipelineBuilder.GetOutput"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplatePipelineBuilder.PrepareWriter"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplatePipelineBuilder.Build"> <inheritdoc/> </member> <member name="T:PSRule.Rules.Azure.Pipeline.TemplateSource"> <summary> A source for template expansion. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplateSource.#ctor(System.String,System.String[])"> <summary> Create a source. </summary> </member> <member name="M:PSRule.Rules.Azure.Pipeline.TemplateSource.#ctor(System.String)"> <summary> Create a source. </summary> </member> <member name="T:PSRule.Rules.Azure.Resources.Diagnostics"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.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.Rules.Azure.Resources.Diagnostics.DebugRunningBicep"> <summary> Looks up a localized string similar to Running bicep from '{0}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.VerboseExpandingResource"> <summary> Looks up a localized string similar to Expanding resource: {0}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.VerboseFindFiles"> <summary> Looks up a localized string similar to Searching for files in '{0}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.VerboseFoundFile"> <summary> Looks up a localized string similar to Found file '{0}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.VerboseGetResource"> <summary> Looks up a localized string similar to Getting resource: {0}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.VerboseGetResources"> <summary> Looks up a localized string similar to Getting resources from subscription: {0}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.VerboseGetResourcesResult"> <summary> Looks up a localized string similar to Added {0} resources from subscription '{1}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.VerboseMetadataNotFound"> <summary> Looks up a localized string similar to The parameter file '{0}' does not contain a metadata property.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.VerboseRetryIn"> <summary> Looks up a localized string similar to Retrying '{0}' in {1}, attept {2}.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.VerboseTemplateFileNotFound"> <summary> Looks up a localized string similar to Unable to find the specified template file '{0}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.VerboseTemplateLinkNotFound"> <summary> Looks up a localized string similar to The parameter file '{0}' does not reference a linked template.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.Diagnostics.WarnFailedToGet"> <summary> Looks up a localized string similar to Failed to get '{0}': status={1}, correlation-id={2}, {3}. </summary> </member> <member name="T:PSRule.Rules.Azure.Resources.PSRuleResources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSRule.Rules.Azure.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.Rules.Azure.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.Rules.Azure.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.Rules.Azure.Resources.PSRuleResources.ArgumentInvalidCIDR"> <summary> Looks up a localized string similar to The specified CIDR '{0}' is not valid.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ArgumentInvalidCIDRLength"> <summary> Looks up a localized string similar to The specified prefix length '{0}' is out of range for the CIDR '{1}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ArgumentInvalidDateTime"> <summary> Looks up a localized string similar to The argument '{0}' for '{1}' is not a valid time.. </summary> </member> <member name="P:PSRule.Rules.Azure.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.Rules.Azure.Resources.PSRuleResources.ArgumentInvalidResourceType"> <summary> Looks up a localized string similar to The resource type '{1}/{2}' for '{0}' is not known.. </summary> </member> <member name="P:PSRule.Rules.Azure.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.Rules.Azure.Resources.PSRuleResources.ArgumentInvalidStringArray"> <summary> Looks up a localized string similar to The argument '{0}' for '{1}' is not a valid string array.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ArgumentNullNotExpected"> <summary> Looks up a localized string similar to One or more arguments for '{0}' are null when null was not expected.. </summary> </member> <member name="P:PSRule.Rules.Azure.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.Rules.Azure.Resources.PSRuleResources.AssignmentFileExpandFailed"> <summary> Looks up a localized string similar to Unable to expand the specified assignment file '{0}'. {1}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.AssignmentFileNotFound"> <summary> Looks up a localized string similar to Unable to find the specified assignment file '{0}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.BicepCommandError"> <summary> Looks up a localized string similar to An exception was raised attempting to call the Bicep CLI: {0}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.BicepCompileError"> <summary> Looks up a localized string similar to Bicep ({0}) compilation of '{1}' failed with: {2}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.BicepCompileTimeout"> <summary> Looks up a localized string similar to Bicep compilation hasn't completed within the timeout window. This can be caused by errors or warnings. Check the Bicep output by running bicep build and addressing any issues.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.BicepExpandInvalid"> <summary> Looks up a localized string similar to Unable to expand resources because the source file '{0}' was not valid. {1}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.BicepNotFound"> <summary> Looks up a localized string similar to Bicep CLI can not be found. Consider installing Bicep or setting the PSRULE_AZURE_BICEP_PATH environment variable to resolve this issue.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.CloudEnvironmentInvalid"> <summary> Looks up a localized string similar to Failed to read cloud environment content.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.EmptyConditionExpandResult"> <summary> Looks up a localized string similar to The expand resulted in an empty condition being returned for '{0}' from '{1}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ExpressionEvaluateError"> <summary> Looks up a localized string similar to An error occurred evaluating expression '{0}' line {1}. {2}. </summary> </member> <member name="P:PSRule.Rules.Azure.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.Rules.Azure.Resources.PSRuleResources.FunctionInvalidString"> <summary> Looks up a localized string similar to The specified parameter is not a valid string.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.FunctionNotFound"> <summary> Looks up a localized string similar to The function "{0}" was not found.. </summary> </member> <member name="P:PSRule.Rules.Azure.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.Rules.Azure.Resources.PSRuleResources.JsonFileFormatInvalid"> <summary> Looks up a localized string similar to Unable to read file '{0}' because the JSON format was not valid. {1}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ManifestResourceNotFound"> <summary> Looks up a localized string similar to Unable to find '{0}' in manifest.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.MetadataNotFound"> <summary> Looks up a localized string similar to The parameter file '{0}' does not contain a metadata property.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.MismatchingResourceSegments"> <summary> Looks up a localized string similar to The number of resource segments needs to match the provided resource type.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.OutputTypeInvalid"> <summary> Looks up a localized string similar to The type for output '{0}' was not defined or invalid.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ParameterFileNotFound"> <summary> Looks up a localized string similar to Unable to find the specified parameter file '{0}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ParameterNotFound"> <summary> Looks up a localized string similar to The parameter named '{0}' was not set or a defaultValue was defined.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ParameterTypeInvalid"> <summary> Looks up a localized string similar to The type for parameter '{0}' was not defined or invalid.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.PathTraversal"> <summary> Looks up a localized string similar to The template file '{0}' must be within the current working directory.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.PolicyIgnoreConfigured"> <summary> Looks up a localized string similar to Policy definition has been ignored based on configuration: {0}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.PolicyIgnoreDisabled"> <summary> Looks up a localized string similar to Policy definition has been ignored because it is disabled: {0}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.PolicyIgnoreDuplicate"> <summary> Looks up a localized string similar to Policy definition has been ignored because a similar built-in rule already exists ({1}): {0}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.PolicyIgnoreInvalid"> <summary> Looks up a localized string similar to Failed to the policy ignore content.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.PolicyIgnoreNotApplicable"> <summary> Looks up a localized string similar to Policy definition has been ignored because it is not applicable to Infrastructure as Code: {0}. </summary> </member> <member name="P:PSRule.Rules.Azure.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.Rules.Azure.Resources.PSRuleResources.ProviderContentInvalid"> <summary> Looks up a localized string similar to Failed to read provider data content.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ProviderIndexInvalid"> <summary> Looks up a localized string similar to Failed to read provider data index.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ReadJsonFailed"> <summary> Looks up a localized string similar to Read JSON failed.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.SerializeNullPSObject"> <summary> Looks up a localized string similar to Can not serialize a null PSObject.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ShouldCreatePath"> <summary> Looks up a localized string similar to Create path. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.ShouldWriteFile"> <summary> Looks up a localized string similar to Write file. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.TemplateExpandInvalid"> <summary> Looks up a localized string similar to Unable to expand resources because the template '{0}' was not valid with parameters '{1}'. {2}. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.TemplateExpressionTooLong"> <summary> Looks up a localized string similar to The template expression '{0}' exceeded the maximum length of 100K characters.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.TemplateFileNotFound"> <summary> Looks up a localized string similar to Unable to find the specified template file '{0}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.TemplateFileReferenceNotFound"> <summary> Looks up a localized string similar to Unable to find template referenced within parameter file '{0}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.TemplateLinkNotFound"> <summary> Looks up a localized string similar to The parameter file '{0}' does not reference a linked template.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.TemplateParameterInvalid"> <summary> Looks up a localized string similar to The template parameter '{0}' does not use the required format.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.PSRuleResources.VariableNotFound"> <summary> Looks up a localized string similar to The variable named '{0}' was not defined in the template.. </summary> </member> <member name="T:PSRule.Rules.Azure.Resources.ReasonStrings"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.ReasonStrings.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:PSRule.Rules.Azure.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.Rules.Azure.Resources.ReasonStrings.ExpressionLength"> <summary> Looks up a localized string similar to The expression '{0}' is longer then the maximum length {1}.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.ReasonStrings.InvalidLocation"> <summary> Looks up a localized string similar to The value '{0}' for parameter '{1}' was not a valid location.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.ReasonStrings.NotResourceType"> <summary> Looks up a localized string similar to The value '{0}' for parameter '{1}' is not of the resource type '{2}'.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.ReasonStrings.NotString"> <summary> Looks up a localized string similar to The value '{0}' for parameter '{1}' is not a string.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.ReasonStrings.OutputSecureAssignment"> <summary> Looks up a localized string similar to The output '{0}' exposes a secure value.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.ReasonStrings.ParameterSecureAssignment"> <summary> Looks up a localized string similar to The parameter '{0}' exposes a secure value.. </summary> </member> <member name="P:PSRule.Rules.Azure.Resources.ReasonStrings.UnsecureValue"> <summary> Looks up a localized string similar to The parameter '{0}' uses a value from an unsecured source.. </summary> </member> <member name="T:PSRule.Rules.Azure.Runtime.Helper"> <summary> Helper methods exposed to PowerShell. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.CreateService(System.String,System.Int32)"> <summary> Create a singleton context for running within PSRule. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.GetBicepVersion(PSRule.Rules.Azure.Runtime.IService)"> <summary> Get information about the installed Bicep version. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.CompressExpression(System.String)"> <summary> Parse and reformat the expression by removing whitespace. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.HasLiteralValue(System.String)"> <summary> Look for literals and variable usage. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.GetParameterTokenValue(System.String)"> <summary> Get the name of parameters that would be assigned as values. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.UsesListKeysFunction(System.String)"> <summary> Returns true if an expression contains a call to the listKeys function. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.UsesReferenceFunction(System.String)"> <summary> Returns true if an expression contains a call to the reference function. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.HasSecureValue(System.String,System.String[])"> <summary> Checks if the value of the expression is secure, whether by using secure parameters, references to KeyVault, or the ListKeys function. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.IsTemplateExpression(System.String)"> <summary> Check it the string is an expression. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.GetResources(PSRule.Rules.Azure.Runtime.IService,System.String)"> <summary> Expand resources from a parameter file and linked template/ bicep files. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.GetBicepResources(PSRule.Rules.Azure.Runtime.IService,System.String)"> <summary> Expand resources from a bicep file. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.GetBicepParamResources(PSRule.Rules.Azure.Runtime.IService,System.String)"> <summary> Expand resources from a bicep param file. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.GetMetadataLinkPath(System.String,System.String)"> <summary> Get the linked template path. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.GetNetworkSecurityGroup(System.Management.Automation.PSObject[])"> <summary> Evaluate NSG rules. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.GetResourceType(System.String,System.String)"> <summary> Get resource type information. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.Helper.GetSubResourceName(System.String)"> <summary> Get the last element in the sub-resource name by splitting the name by '/' separator. </summary> <param name="resourceName">The sub-resource name to split.</param> <returns>The name of the sub-resource.</returns> </member> <member name="T:PSRule.Rules.Azure.Runtime.IService"> <summary> A context when running within PSRule. </summary> </member> <member name="T:PSRule.Rules.Azure.Runtime.IRuntimeService"> <summary> A context when running within PSRule. </summary> </member> <member name="P:PSRule.Rules.Azure.Runtime.IRuntimeService.Timeout"> <summary> Configures the timeout for Bicep expansion. </summary> </member> <member name="P:PSRule.Rules.Azure.Runtime.IRuntimeService.Minimum"> <summary> The minimum version of Bicep. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.IRuntimeService.WithAllowedLocations(System.String[])"> <summary> Specified the allowed locations for the organization. </summary> <param name="locations">Configures the allowed list of locations.</param> </member> <member name="M:PSRule.Rules.Azure.Runtime.IRuntimeService.IsAllowedLocation(System.String)"> <summary> Determines if the specified location is within the allowed set. </summary> <param name="location">The location to check.</param> <returns>Returns <c>true</c> when the location is allowed. Otherwise <c>false</c> is returned.</returns> </member> <member name="T:PSRule.Rules.Azure.Runtime.RuntimeService"> <summary> A singleton context when running is PSRule. </summary> </member> <member name="M:PSRule.Rules.Azure.Runtime.RuntimeService.#ctor(System.String,System.Int32)"> <summary> Create a runtime service. </summary> <param name="minimum">The minimum version of Bicep.</param> <param name="timeout">The timeout in seconds for expansion.</param> </member> <member name="P:PSRule.Rules.Azure.Runtime.RuntimeService.Timeout"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Runtime.RuntimeService.Minimum"> <inheritdoc/> </member> <member name="P:PSRule.Rules.Azure.Runtime.RuntimeService.Bicep"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Runtime.RuntimeService.WithAllowedLocations(System.String[])"> <inheritdoc/> </member> <member name="M:PSRule.Rules.Azure.Runtime.RuntimeService.IsAllowedLocation(System.String)"> <inheritdoc/> </member> </members> </doc> |