PolicyType

PolicyType

Represents a PolicyType defined within a Mod.

For more information, please see Policy Types & Categories and Mods.

categoryControlCategoryThe category information for this PolicyType.
categoryUriString!Unique identifier for the category.
childrenPolicyTypesThe immediate children for this PolicyType.
controlsControlsReturns any controls for this PolicyType that you have permission to get, subject to the optional filter and paging arguments.
defaultTemplateStringOptional Nunjucks template used to calculate the default policy value for any targeted resources.
defaultTemplateInputScalarOptional GraphQL query used to calculate the default policy value for any targeted resources.
descendantsPolicyTypesThe descendants of this PolicyType.
descriptionStringShort human-friendly description.
iconStringFontAwesome icon reference, used for display in the product and documentation. Will be in the format fal-<icon>, far-<icon> or fas-<icon> for light, regular and solid icon classes respectively.
input[String]
modUriString!Unique identifier for the defining mod.
policySettingsPolicySettingsReturns any policySettings for this PolicyType that you have permission to get, subject to the optional filter and paging arguments.
policyValuesPolicyValuesReturns any policyValues for this PolicyType that you have permission to get, subject to the optional filter and paging arguments.
readOnlyBooleanIf true user-defined policy settings are blocked from being created.
resolvedSchemaScalarJSON schema with fully-resolved URI references, defining the allowed schema for policy values for any targeted resources.
resourcesResourcesThe resources of this PolicyType, subject to the optional filter and paging arguments.
schemaScalarJSON schema defining the allowed schema for policy values for any targeted resources.
secretBooleanIf true any non-calculated policy settings and policy values for targeted resources will be encrypted at rest.
secretLevelSecretLevel
targets[String!]Target resource interface / type URIs.
titleString!Display title.
trunkTrunkItemsThe trunk for this PolicyType, subject to the optional filter and paging arguments. This will show the resource type hierarchy from the root down to this PolicyType.
turbotTurbotPolicyTypeMetadata!Turbot metadata for this PolicyType.
uriString!Mod-specific unique identifier.
hiddenBooleanDEPRECATED: Unused field. Will be removed in a forthcoming release.