Export (0) Print
Expand All

ADMX Schema Summary

A summary of all types defined in the ADMX schema are provided in the following tables.

ADMX Base Types Schema

The ADMX Base Types Schema provides the base types shared by the schema types in the ADMX Policy Definition Types Schema.

Base Types Element NameDescription
Annotation String comment base definition for ADMX files. Strings added to this tag will not be processed by GP tools.
fileName A valid file name. The file name must be specified without a file path.
GUID Represents a globally unique identifier (GUID) {12345678-1234-1234-1234-123456789abcd} style string.
itemName String representing all defined type names, e.g. categories.
itemReference String representing all references to defined types, e.g. categories.
LocalizedString A localized string.
presentationReference String representing a reference to a policy parameter presentation definition in the localized presentation table.
registryKey A valid registry key path. This must be specified without reference to local system or user hive.
registryValueName A valid registry value name.
resourceID A localized string id used in the localized string table.
stringReference A reference to a localized string in the localized string table.
versionString String value representing decimal version associated with the major and minor ADMX schema version updates.

 

ADMX Policy Definition File Structure Schema

The ADMX policy definition file structure schema defines the structure of the .admx and .adml files. The .admx files define the neutral policy setting information. The .adml files provide the language-based resource information for the .admx files.

ADMX Policy Definition File Structure Element NameDescription
annotation (PolicyDefinitionResources) String comment for .adml files. Strings added to this tag will not be processed by GP tools.
annotation (PolicyDefinitions) String comment for .admx files. Strings added to this tag will not be processed by GP tools.
categories (PolicyDefinitions) List of category elements. Up to one list of categories can be defined in an .admx file.
category (CategoryList) Single grouping of policy definitions based on the definition of the Category type.
CategoryList List of category elements.
definitions (SupportedOnTable) Single grouping of SupportedOnDefinitions.
description (PolicyDefinitionResources) Localized description of policy settings contained in.adml file. Unsupported by current Group Policy tools.
displayName (PolicyDefinitionResources) Localized friendly name of policy settings file. Unsupported by current Group Policy tools.
FileReference Reference to a fileName. The fileName type must be specified without a file path.
Localization A table of referenced localized strings and policy presentations.
localization (LocalizationTable) .adml implementation of a table of referenced localized strings and policy presentations.
LocalizationResourceReference Specifies the minimum revision for the associated .adml file and, optionally, the default language to use. The default language culture used will be en-US, unless specified.
LocalizationTable A table of localization tables, one per language. Not supported in current ADMX files.
policies (PolicyDefinitions) A list of policy elements.
PolicyDefinitionResources (base type) The base type for localized .adml files with a single language/culture per file. Localization files are always in the namespace of the associated .admx file and never reference definitions from other namespaces.
policyDefinitionResources An .adml implementation of the localized resource file with a single language/culture per file for each supported language/culture.
PolicyDefinitions (base type) The base type for .admx files.
policyDefinitions A single .admx file for defining a set of policy definitions.
PolicyNamespaces Defines a single PolicyNamespaceAssociation to reference the policy information defined in an .admx file and a set of PolicyNamespaceAssociation types referenced by an .admx file.
policyNamespaces (PolicyDefinitions) .admx implementation of a PolicyNamespaces type.
policy (PolicyList) Represents a single policy setting definition.
PolicyList A grouping of one or more policy setting definitions.
PolicyNamespaceAssociation A prefix associated with a namespace to be used as an identifier.
presentation (presentationTable) A presentation element representing parameters for a policy setting.
presentationTable (Localization) Table of presentation elements representing policy setting parameters.
products (SupportedOnTable) Single grouping of SupportedProducts. Not supported by current GP tools.
resources (PolicyDefinitionResources) .adml implementation of the LocalizationTable.
resources (PolicyDefinitions) .admx implementation of the PolicyDefinitionResources. The minimum version of the .adml file is required.
string (stringTable) A localized string. This can represent policy setting titles or help text strings.
stringTable (Localization) Table of localized strings.
supersededAdm (PolicyDefinitions) Reference to the file name for an .adm file. Group Policy Editor will not read any .adm file designated as superseded.
supportedOn (PolicyDefinitions) Maximum of one SupportedOnTable element.
SupportedOnTable Set of maximum one each products and definitions types.
target (PolicyNamespaces) A PolicyNamespaceAssociation to reference an .admx file. A target element should be unique for each .admx file. The Group Policy Editor will report a duplicate namespace error if it reads more than one ADMX file with the same target namespace.
using (PolicyNamespaces) A set of PolicyNamespaceAssociation types referenced by an .admx file.

 

ADMX Policy Definition Types Schema

The ADMX Policy Definition Types Schema provides the schema elements and types used to define the required information for creating individual policy settings. These elements define the category, supported on and individual policy setting definition information, including the localized presentation portions.

ADMX Policy Definition Types Schema Element/Group NameDescription
and (SupportedOnDefinition) All conditions must be true.
annotation (BaseDescriptiveGroup) String comment for categories and policy definitions. Strings added to this tag will not be processed by GP tools.
BaseDescriptiveAttributeGroup Common group attribute declarations for use by categories and policy definitions.
BaseDescriptiveGroup Common group element declarations for use by categories and policy definitions.
boolean (PolicyElements) Of type BooleanElement.
BooleanElement Describes a choice element in a policy with associated values for the true and false cases.
Category A grouping of policy definitions.
CategoryReference A reference to an already defined category.
CheckBox Represents a checkbox display element. Must be associated with a BooleanElement when defined in the <elements> PolicyDefinition element.
checkBox (PolicyPresentation) Of type CheckBox.
ComboBox Represents a combobox display element with default/suggested entries. Must be associated with a TextElement when defined in the <elements> PolicyDefinition element.
comboBox (PolicyPresentation) Of type ComboBox.
DataElement Represents optional parameters for a policy setting definition with a logical name for ComboBox Types.
DataElementContent Represents optional parameters for a policy setting definition with a logical name.
decimal (PolicyElements) Of type DecimalElement.
decimal (Value) Represents an unsigned integer numeric value.
DecimalElement Describes a number/decimal element in a policy. The number can be defined to be stored as either a numeric or string representative value.
DecimalTextBox Represents a text box with or without a spin control for entering decimal numbers as a policy setting parameter. Must be associated with either a DecimalElement or TextElement when defined in the <elements> PolicyDefinition element.
decimalTextBox (PolicyPresentation) Of type DecimalTextBox.
default (ComboBox) Specifies a default string.
defaultValue (TextBox) Specifies a default value. This can be used for either string or numeric data.
definition (SupportedOnDefinitions) Of type SupportedOnDefinition.
delete (Value) Represents a deleted registry value or key.
disabledList (PolicyDefinition) A list of ValueItems representing a registry value name set to disabled value.
disabledValue (PolicyDefinition) A registry value name set to disabled value.
DropdownList Represents a dropdown list display element which a user can pick one of the displayed entries. Must be associated with an EnumerationElement when defined in the <elements> PolicyDefinition element.
dropdownList (PolicyPresentation) Of type DropdownList.
elements (PolicyDefinition) Of type PolicyElements.
enabledList (PolicyDefinition) A list of ValueItems representing a registry value name set to enabled value.
enabledValue (PolicyDefinition) A registry value name set to enabled value.
enum (PolicyElements) Of type EnumerationElement.
EnumerationElement Describes an enumeration element in a policy. This element should always contain at least one item.
falseList (BooleanElement) A list of values to be set when the item is set to a false state.
falseValue (BooleanElement) A value to be set when the item is set to a false state.
item (EnumerationElement) Represents an item in the EnumerationElement.
item (ValueList) Represents an item in a list.
keywords (BaseDescriptiveGroup) Optional keywords associated with categories and policy definitions. Not supported by Group Policy tools.
label (ComboBox) Text associated with input box to provide prompt text.
label (TextBox) Text associated with input box to provide prompt text.
ListBox Represents a list box with Add and Remove buttons. This is the only type that can be used to manage multiple values under one key. Must be associated with a ListElement when defined in the <elements> PolicyDefinition element.
listBox (PolicyPresentation) Of type ListBox.
list (PolicyElements) Of type ListElement.
ListElement Describes a list element in a policy.
majorVersion (SupportedProduct) A major version of a product.
minorVersion (SupportedMajorVersion) Single version of a component.
or (SupportedOnDefinition) At least one condition must be true.
parentCategory (BaseDescriptiveGroup) References parent category to the current Category.
PolicyClass An enumeration of the 3 possible classes of a policy definition. The class determines whether the policy setting will be applicable to a user, machine or both.
PolicyDefinition Represents a policy setting.
PolicyElementAttributeGroup Attribute group that all policy elements must have:. string ID, GUID representing the client extension, registry key set, registry valuename.
PolicyElements Represents the types of optional parameters defined in a policy setting. The number and type of PolicyElements must match the policy presentation elements.
PolicyPresentation Represents optional parameters and other elements requiring localization for a policy setting definition.
product (SupportedProducts) A potentially supported product.
range (SupportedAndCondition) Supported version range.
range (SupportedOrCondition) Supported version range.
reference (SupportedAndCondition) Reference to a supported product definition (single version or complex definition).
reference (SupportedOrCondition) Reference to a supported product definition (single version or complex definition).
seeAlso (BaseDescriptiveGroup) Optional string descriptor used to reference related policy definitions. Unsupported by Group Policy tools.
string (Value) String type limited to 255 characters long.
suggestion (ComboBox) A list of suggestions to be placed in the drop-down list. Suggestions are separated with spaces and must be enclosed by double quotation marks when a value includes spaces. If a suggestion name includes white space, it must be enclosed in quotes.
SupportedAndCondition A group of supported components that must all be true for the policy definition to be supported.
SupportedMajorVersion A major version of a product that can be referenced by a policy as being supported on.
SupportedMinorVersion Single version of a component to facilitate simple ranking of versions.
supportedOn (PolicyDefinition) A table of potentially supported products.
SupportedOnDefinition Definition of complex supported product major and/or minor versions represented by a logical name and a displayName attribute. The displayName attribute must be a linguistic representation of the complex SupportedOnDefinition.
SupportedOnDefinitions Table of supported components definitions.
SupportedOnRange Supported version range.
SupportedOnReference Reference to a supported product definition (single version or complex definition).
SupportedOrCondition A group of supported components where at least one must be true for the policy definition to be supported.
SupportedProduct A potentially supported product that can be referenced by a policy as being supported on.
SupportedProducts A table of potentially supported products.
TextBox Represents a textbox display element. Must be associated with a TextElement when defined in the <elements> PolicyDefinition element.
textBox (PolicyPresentation) Of type TextBox.
text (PolicyElements) Of type TextElement.
text (PolicyPresentation) A localized string.
TextElement Describes a text element in a policy.
trueList (BooleanElement) A list of values to be set when the item is set to a true state.
trueValue (BooleanElement) A value to be set when the item is set to a true state.
value (item) A specified item with an associated registry key and value.
value (ValueItem) Represents either a deleted value, decimal, or string.
Value Represents either a deleted value, decimal, or string.
ValueItem Represents a registry value name.
valueList (item) A list of items with an associated registry key and value.
ValueList A list of ValueItems representing a registry value name. This element should always contain at least one ValueItem.

 

 

 

Send comments about this topic to Microsoft

Build date: 10/15/2013

Community Additions

Show:
© 2014 Microsoft