Gets size of buffer required to engine ID.
Checks consent for a specific workload.
Gets the recommended WXP (Windows, Excel, Powerpoint) metadata version, currently 0 for old verion 1 for co-authoring enabled version.
Enables or disables functionality.
Sets delegated user.
Sets base URL for all service requests.
Sets cloud which affects endpoint URLs for all service requests.
Sets the session ID that can be used to correlate logs and telemetry.
Configures custom settings, used for feature gating and testing.
Sets the client data that will be stored opaquely alongside this engine and persist across sessions.
Create a settings object used to load an existing policy engine by engine ID if it already exists, else create a new engine.
Create a settings object used to create a brand new policy engine.
Gets sensitivity types data xml.
Gets size of sensitivity types data xml.
Gets policy data xml.
Gets size of policy data xml.
Gets tenant ID.
Gets size of tenant ID.
Logs an application specific event to the audit pipeline.
Create a Policy Handler to execute policy-related functions.
Gets the sensitivity types associated with the policy engine.
Gets the number of sensitivity types associated with the policy engine.
Gets sensitivity label by ID.
Gets the sensitivity labels associated with the policy engine.
Gets the number of sensitivity labels associated with the policy engine.
Gets the time when the policy was last fetched.
Gets whether or not the policy has automatic or recommendation rules.
Gets whether or not the policy dictates a justification for downgrade operations is required.
Gets whether or not the policy dictates that a document must be labeled.
Get client data associated with a policy engine.
Gets the size of client data associated with a policy engine.
Gets engine ID.
- Parameters
-
engine | Policy engine |
idSize | [Output] Size of buffer to hold engine ID (in number of chars) |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
idBuffer | [Output] Buffer the id will be copied into. |
idBufferSize | Size (in number of chars) of the idBuffer. |
actualIdSize | [Output] Number of chars written to the buffer |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If idBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualIdSize will be set to the minimum required buffer size.
- Parameters
-
engine | Policy engine |
moreInfoUrlSize | [Output] Size of client data (in number of chars) |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
moreInfoUrlBuffer | [Output] Buffer the client data will be copied into |
moreInfoUrlBufferSize | Size (in number of chars) of moreInfoUrlBuffer. |
actualMoreInfoUrlSize | [Output] Number of chars written to the buffer |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If moreInfoUrlBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualMoreInfoUrlSize will be set to the minimum required buffer size.
- Parameters
-
engine | Policy engine |
isLabelingRequired | [Output] Whether or not policy dictates that a document must be labeled |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
isDowngradeJustificationRequired | [Output] Whether or a justification for downgrade operations is required. |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
policyFileIdSize | [Output] Size of client data (in number of chars) |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
policyFileIdBuffer | [Output] Buffer the client data will be copied into |
policyFileIdBufferSize | Size (in number of chars) of policyFileIdBuffer. |
actualPolicyFileIdSize | [Output] Number of chars written to the buffer |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If policyFileIdBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualPolicyFileIdSize will be set to the minimum required buffer size.
- Parameters
-
engine | Policy engine |
sensitivityFileIdSize | [Output] Size of client data (in number of chars) |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
sensitivityFileIdBuffer | [Output] Buffer the client data will be copied into |
sensitivityFileIdBufferSize | Size (in number of chars) of sensitivityFileIdBuffer. |
actualSensitivityFileIdSize | [Output] Number of chars written to the buffer |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If sensitivityFileIdBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualSensitivityFileIdSize will be set to the minimum required buffer size.
- Parameters
-
engine | Policy engine |
hasClassificationRules | [Output] Whether or not policy has automatic or recommendation rules |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
lastPolicyFetchTime | [Output] Time when the policy was last fetched (in seconds since epoch) |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
labelsSize | [Output] Number of labels |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
labelBuffer | [Output] Buffer the labels will be copied into. Labels are owned by the client application and must be released with MIP_CC_ReleaseLabel. |
labelBufferSize | Size (in number of labels) of the labelBuffer. |
actualLabelsSize | [Output] Number of labels written to the buffer |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If labelBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualLabelsSize will be set to the minimum required buffer size
- Parameters
-
engine | Policy engine |
labelId | Label ID |
label | [Output] Sensitivity label. This value is owned by the caller and must be released with MIP_CC_ReleaseLabel. |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
sensitivityTypesSize | [Output] Number of sensitivity types |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
sensitivityTypeBuffer | [Output] Buffer the sensitivity types will be copied into. Sensitivity types are owned by the caller and must be released with MIP_CC_ReleaseSensitivityType. |
sensitivityTypeBufferSize | Size (in number of sensitivity types) of the sensitivityTypeBuffer. |
actualSensitivityTypesSize | [Output] Number of sensitivity types written to the buffer |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If sensitivityTypeBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualSensitivityTypesSize will be set to the minimum required buffer size
- Parameters
-
engine | Policy engine |
isAuditDiscoveryEnabled | Whether or not audit discovery is enabled |
handler | [Output] Newly-created Policy Handler instance |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
level | Level of the event: Info/Error/Warning |
eventType | A description of the type of event |
eventData | The data associated with the event |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
tenantIdSize | [Output] Size of tenant ID (in number of chars) |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
tenantIdBuffer | [Output] Buffer the tenant ID will be copied into. |
tenantIdBufferSize | Size (in number of chars) of the tenantIdBuffer. |
actualTenantIdSize | [Output] Number of chars written to the buffer |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If tenantIdBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualTenantIdSize will be set to the minimum required buffer size.
- Parameters
-
engine | Policy engine |
xmlSize | [Output] Size of policy data xml (in number of chars) |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
xmlBuffer | [Output] Buffer the xml will be copied into. |
xmlBufferSize | Size (in number of chars) of the xmlBuffer. |
actualXmlSize | [Output] Number of chars written to the buffer |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If xmlBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualXmlSize will be set to the minimum required buffer size.
- Parameters
-
engine | Policy engine |
clientDataSize | [Output] Size of client data (in number of chars) |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
clientDataBuffer | [Output] Buffer the client data will be copied into |
clientDataBufferSize | Size (in number of chars) of clientDataBuffer. |
actualClientDataSize | [Output] Number of chars written to the buffer |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If clientDataBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualClientDataSize will be set to the minimum required buffer size.
- Parameters
-
identity | Identity that will be associated with PolicyEngine |
authCallback | Callback object to be used for authentication, implemented by client application |
clientData | Customizable client data that is stored alongside the engine |
locale | Locale in which text results will output |
loadSensitivityTypes | Whether or not sensitivity types data (for classification) should also be loaded |
settings | [Output] Newly-created settings instance |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- 'loadSensitivityTypes' should be 'true' only if application expects to later call MIP_CC_PolicyEngine_GetSensitivityTypes. Otherwise, it should be false to avoid an unnecessary HTTP operation.
- Parameters
-
engineId | ID of existing cached engine |
identity | (Optional) Identity that will be associated with PolicyEngine |
authCallback | Callback object to be used for authentication, implemented by client application |
clientData | Customizable client data that is stored alongside the engine |
locale | Locale in which text results will output |
loadSensitivityTypes | Whether or not sensitivity types data (for classification) should also be loaded |
settings | [Output] Newly-created settings instance |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- 'loadSensitivityTypes' should be 'true' only if application expects to later call MIP_CC_PolicyEngine_GetSensitivityTypes. Otherwise, it should be false to avoid an unnecessary HTTP operation.
-
'identity' will only be used for new engines. If an engine with the specified engine id already exists in the local cache, the identity from the cached engine will be used instead.
- Parameters
-
settings | Engine settings |
clientData | Client data |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
settings | Engine settings |
customSettings | Key/value pairs of custom settings |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
settings | Engine settings |
sessionId | Session ID that represents the lifetime of a policy engine |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
settings | Engine settings |
cloud | Cloud identifier (default = Unknown) |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If cloud is not specified, then it will default to global cloud.
- Parameters
-
- Returns
- Result code indicating success or failure
- Note
- This value will only be read and must be set for Cloud = MIP_CLOUD_CUSTOM
- Parameters
-
settings | Engine settings |
delegatedUserEmail | Email address of delegated user |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- A delegated user is specified when the authenticating user/application is acting on behalf of another user
- Parameters
-
settings | Engine settings |
labelFilter | enum representing type to configure |
enabled | True to enable, False to disable |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
engine | Policy engine |
metadataVersion | [Output] WXP metadata version. |
errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure