PolicyDefinition Class

The policy definition.

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

Inheritance
PolicyDefinition

Constructor

PolicyDefinition(*, policy_type: typing.Union[str, _ForwardRef('PolicyType'), NoneType] = None, mode: typing.Union[str, _ForwardRef('PolicyMode'), NoneType] = None, display_name: typing.Union[str, NoneType] = None, description: typing.Union[str, NoneType] = None, policy_rule: typing.Union[typing.Any, NoneType] = None, metadata: typing.Union[typing.Any, NoneType] = None, parameters: typing.Union[typing.Any, NoneType] = None, **kwargs)

Parameters

policy_type
str or PolicyType
Required

The type of policy definition. Possible values are NotSpecified, BuiltIn, and Custom. Possible values include: "NotSpecified", "BuiltIn", "Custom".

mode
str or PolicyMode
Required

The policy definition mode. Possible values are NotSpecified, Indexed, and All. Possible values include: "NotSpecified", "Indexed", "All".

display_name
str
Required

The display name of the policy definition.

description
str
Required

The policy definition description.

policy_rule
any
Required

The policy rule.

metadata
any
Required

The policy definition metadata.

parameters
any
Required

Required if a parameter is used in policy rule.

Variables

id
str

The ID of the policy definition.

name
str

The name of the policy definition.