PolicySetDefinition Class

The policy set definition.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

PolicySetDefinition(*, policy_type: str | _models.PolicyType | None = None, display_name: str | None = None, description: str | None = None, metadata: MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterDefinitionsValue] | None = None, policy_definitions: List[_models.PolicyDefinitionReference] | None = None, policy_definition_groups: List[_models.PolicyDefinitionGroup] | None = None, version: str | None = None, versions: List[str] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
policy_type	str or PolicyType The type of policy set definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. Known values are: "NotSpecified", "BuiltIn", "Custom", and "Static". Default value: None
display_name	str The display name of the policy set definition. Default value: None
description	str The policy set definition description. Default value: None
metadata	JSON The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. Default value: None
parameters	dict[str, ParameterDefinitionsValue] The policy set definition parameters that can be used in policy definition references. Default value: None
policy_definitions	list[PolicyDefinitionReference] An array of policy definition references. Default value: None
policy_definition_groups	list[PolicyDefinitionGroup] The metadata describing groups of policy definition references within the policy set definition. Default value: None
version	str The policy set definition version in #.#.# format. Default value: None
versions	list[str] A list of available versions for this policy set definition. Default value: None

Variables

Name	Description
id	str The ID of the policy set definition.
name	str The name of the policy set definition.
type	str The type of the resource (Microsoft.Authorization/policySetDefinitions).
system_data	SystemData The system metadata relating to this resource.
policy_type	str or PolicyType The type of policy set definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. Known values are: "NotSpecified", "BuiltIn", "Custom", and "Static".
display_name	str The display name of the policy set definition.
description	str The policy set definition description.
metadata	<xref:JSON> The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
parameters	dict[str, ParameterDefinitionsValue] The policy set definition parameters that can be used in policy definition references.
policy_definitions	list[PolicyDefinitionReference] An array of policy definition references.
policy_definition_groups	list[PolicyDefinitionGroup] The metadata describing groups of policy definition references within the policy set definition.
version	str The policy set definition version in #.#.# format.
versions	list[str] A list of available versions for this policy set definition.