class PolicyEngine::Параметры

  • Статья

Определяет параметры, связанные с PolicyEngine.

Итоги

Участники Descriptions
public Параметры(const std::string&engineId, const std::shared_ptr<AuthDelegate& authDelegate>, const std::string& clientData, const std::string& locale, bool loadSensitivityTypes) Конструктор PolicyEngine::Параметры для загрузки существующего модуля.
public Параметры(const Identity&identity, const std::shared_ptr<AuthDelegate& authDelegate>, const std::string&clientData, const std::string&locale, bool loadSensitivityTypes) Конструктор PolicyEngine::Параметры для создания нового модуля.
public const std::string& GetEngineId() const Получите идентификатор обработчика.
public void SetEngineId(const std::string&id) Задайте идентификатор обработчика.
public const Identity& GetIdentity() const Получите объект Identity.
public void SetIdentity(const Identity&identity) Задайте объект Identity.
public const std::string& GetClientData() const Получите набор данных клиента в параметрах.
public void SetClientData(const std::string& clientData) Задайте строку данных клиента.
public const std::string& GetLocale() const Получите языковой стандарт в параметрах.
public void SetCustom Параметры(const std::vector<std::p air<std::string, std::string>>& custom Параметры) Задайте настраиваемые параметры, используемые для выделения и тестирования компонентов.
public const std::vector<std::p air<std::string, std::string>>& GetCustom Параметры() const Получите настраиваемые параметры, используемые для выделения и тестирования компонентов.
public void SetSessionId(const std::string& sessionId) Задайте идентификатор сеанса, используемый для определяемой клиентом телеметрии и чтобы упростить сопоставление событий приложения с соответствующими запросами REST службы политик.
public const std::string& GetSessionId() const Получите идентификатор сеанса, уникальный идентификатор.
public bool IsLoadSensitivityTypesEnabled() const Получите флаг, указывающий, включена ли метка конфиденциальности нагрузки.
public void SetCloud(Cloud) При необходимости задает целевое облако.
public Cloud GetCloud() const Возвращает целевое облако, используемое всеми запросами на обслуживание.
public void SetDataBoundary (DataBoundary dataBoundary) При необходимости задает целевой регион диагностики.
public DataBoundary GetDataBoundary() const Возвращает область границы данных.
public void SetCloudEndpointBaseUrl(const std::string& cloudEndpointBaseUrl) Задает базовый URL-адрес облачной конечной точки для пользовательского облака.
public const std::string& GetCloudEndpointBaseUrl() const Возвращает url-адрес облачной базы, используемый всеми запросами службы, если он указан.
public void SetDelegatedUserEmail(const std::string& делегатUserEmail) Задает делегированного пользователя.
public const std::string& GetDelegatedUserEmail() const Возвращает делегированного пользователя.
public void SetLabelFilter(const std::vector<LabelFilterType>& deprecatedLabelFilters) Задает фильтр меток.
public const std::vector<LabelFilterType>& GetLabelFilter() const Возвращает фильтры меток, заданные с помощью устаревшей функции SetLabelFilter.
public void ConfigureFunctionality(Функциональные возможностиFilterTypeyFilterType, логическое значение включено) Включает или отключает функции.
public const std::map<FunctionalityFilterType, bool>& GetConfiguredFunctionality() const Возвращает настроенные функции.
public void SetVariableTextMarkingType(VariableTextMarkingType variableTextMarkingType) Задает тип маркировки текста переменной.
public VariableTextMarkingType GetVariableTextMarkingType() const Возвращает тип маркировки текста переменной.
public void SetAuthDelegate(const std::shared_ptr<AuthDelegate>& authDelegate) Задайте делегат проверки подлинности обработчика.
public std::shared_ptr<AuthDelegate GetAuthDelegate> () const Получите делегат проверки подлинности обработчика.
public const std::shared_ptr<void>& GetLoggerContext() const Получение контекста средства ведения журнала, который будет непрозрачно передан делегату средства ведения журнала для журналов, связанных с созданным механизмом.
public void SetLoggerContext(const std::shared_ptr<void>& loggerContext) Задает контекст средства ведения журнала, который будет непрозрачно передан делегату средства ведения журнала для журналов, связанных с созданным механизмом.

Участники

функция Параметры

Конструктор PolicyEngine::Параметры для загрузки существующего модуля.

Параметры:

  • engineId: задайте для него уникальный идентификатор обработчика, созданный AddEngineAsync или один самогенерированный. При загрузке существующего модуля повторно используйте идентификатор, кроме того, будет создан новый модуль.

  • authDelegate: делегат проверки подлинности, используемый пакетом SDK для получения маркеров проверки подлинности, переопределит PolicyProfile::Параметры::authDelegate, если оба указаны

  • clientData: настраиваемые клиентские данные, которые могут храниться с подсистемой при выгрузке, можно получить из загруженного ядра.

  • языковой стандарт: локализованные выходные данные подсистемы будут предоставлены в этом языковом стандарте.

  • Необязательный: флаг, указывающий, когда подсистема загружается также пользовательские типы конфиденциальности, если в профиле будет вызываться true OnPolicyChange Observer для обновлений пользовательских типов конфиденциальности, а также изменений политики. Если вызов false ListSensitivityTypes всегда возвращает пустой список.

функция Параметры

Конструктор PolicyEngine::Параметры для создания нового модуля.

Параметры:

  • удостоверение: сведения об удостоверении пользователя, связанного с новым обработчиком.

  • authDelegate: делегат проверки подлинности, используемый пакетом SDK для получения маркеров проверки подлинности, переопределит PolicyProfile::Параметры::authDelegate, если оба указаны

  • clientData: настраиваемые клиентские данные, которые могут храниться с подсистемой при выгрузке, можно получить из загруженного ядра.

  • языковой стандарт: локализованные выходные данные подсистемы будут предоставлены в этом языковом стандарте.

  • Необязательный: флаг, указывающий, когда подсистема загружается также пользовательские типы конфиденциальности, если в профиле будет вызываться true OnPolicyChange Observer для обновлений пользовательских типов конфиденциальности, а также изменений политики. Если вызов false ListSensitivityTypes всегда возвращает пустой список.

Функция GetEngineId

Получите идентификатор обработчика.

Возвращает: уникальная строка, определяющая подсистему.

Функция SetEngineId

Задайте идентификатор обработчика.

Параметры:

  • id: идентификатор обработчика.

Функция GetIdentity

Получите объект Identity.

Возвращает: ссылка на удостоверение в объекте settings.

См. также: mip::Identity

Функция SetIdentity

Задайте объект Identity.

Параметры:

  • удостоверение: уникальное удостоверение пользователя.

См. также: mip::Identity

Функция GetClientData

Получите набор данных клиента в параметрах.

Возвращает: строка данных, указанных клиентом.

Функция SetClientData

Задайте строку данных клиента.

Параметры:

  • clientData: указанные пользователем данные.

Функция GetLocale

Получите языковой стандарт в параметрах.

Возвращает: языковой стандарт.

Функция SetCustom Параметры

Задайте настраиваемые параметры, используемые для выделения и тестирования компонентов.

Параметры:

  • custom Параметры: список пар name/value.

Функция GetCustom Параметры

Получите настраиваемые параметры, используемые для выделения и тестирования компонентов.

Возвращает: список пар name/value.

Функция SetSessionId

Задайте идентификатор сеанса, используемый для определяемой клиентом телеметрии и чтобы упростить сопоставление событий приложения с соответствующими запросами REST службы политик.

Параметры:

  • sessionId: идентификатор (обычно указанный как GUID) для уникальной идентификации этой операции.

Функция GetSessionId

Получите идентификатор сеанса, уникальный идентификатор.

Возвращает: идентификатор сеанса.

Функция IsLoadSensitivityTypesEnabled

Получите флаг, указывающий, включена ли метка конфиденциальности нагрузки.

Возвращает значение: True, если включено другое значение false.

Функция SetCloud

При необходимости задает целевое облако.

Параметры:

  • облако: облако

Если облако не указано, оно по умолчанию будет использоваться для коммерческого облака.

Функция GetCloud

Возвращает целевое облако, используемое всеми запросами на обслуживание.

Возвращает: Облако

Функция SetDataBoundary

При необходимости задает целевой регион диагностики.

Параметры:

  • граница данных: область границы данных

Если граница данных не указана, по умолчанию будет использоваться глобальный регион диагностики.

Функция GetDataBoundary

Возвращает область границы данных.

Возвращает: граница данных

Функция SetCloudEndpointBaseUrl

Задает базовый URL-адрес облачной конечной точки для пользовательского облака.

Параметры:

  • cloudEndpointBaseUrl: базовый URL-адрес, используемый всеми запросами службы (например, "https://dataservice.protection.outlook.com")

Это значение будет считываться только и должно быть задано для Cloud = Custom

Функция GetCloudEndpointBaseUrl

Возвращает url-адрес облачной базы, используемый всеми запросами службы, если он указан.

Возвращается: базовый URL-адрес

Функция SetDelegatedUserEmail

Задает делегированного пользователя.

Параметры:

  • делегатUserEmail: сообщение электронной почты делегирования.

Делегированный пользователь указывается, когда проверка подлинности пользователя или приложения действует от имени другого пользователя

Функция GetDelegatedUserEmail

Возвращает делегированного пользователя.

Возвращается: делегированный пользователь Делегированный пользователь указывается при проверке подлинности пользователя или приложения от имени другого пользователя.

Функция SetLabelFilter

Задает фильтр меток.

Параметры:

  • labelFilter: фильтр меток.

Метки по умолчанию фильтруются по область, этот API позволяет фильтровать по возможным действиям. Если параметр HyokProtection и DoubleKeyProtection не задан, фильтруются.

Функция GetLabelFilter

Возвращает фильтры меток, заданные с помощью устаревшей функции SetLabelFilter.

Возвращает: фильтр меток. Метки по умолчанию фильтруются по область, этот API позволяет фильтровать по возможным действиям.

Настройка функции ConfigureFunctionality

Включает или отключает функции.

Параметры:

  • функцияFilterType: тип функциональности.

  • enabled: True, чтобы включить, false для отключения

HyokProtection, DoubleKeyProtection, DoubleKeyUserDefinedProtection отключены по умолчанию и должны быть включены

Функция GetConfiguredFunctionality

Возвращает настроенные функции.

Возвращает: карта типов с логическим значением, указывающим, включена ли она или нет.

Функция SetVariableTextMarkingType

Задает тип маркировки текста переменной.

Параметры:

  • variableTextMarkingType: тип маркировки текста переменной.

Функция GetVariableTextMarkingType

Возвращает тип маркировки текста переменной.

Возвращает: тип маркировки текста переменной.

Функция SetAuthDelegate

Задайте делегат проверки подлинности обработчика.

Параметры:

  • authDelegate: делегат проверки подлинности

Функция GetAuthDelegate

Получите делегат проверки подлинности обработчика.

Возвращается: делегат проверки подлинности обработчика.

Функция GetLoggerContext

Получение контекста средства ведения журнала, который будет непрозрачно передан делегату средства ведения журнала для журналов, связанных с созданным механизмом.

Возвращается: контекст средства ведения журнала

Функция SetLoggerContext

Задает контекст средства ведения журнала, который будет непрозрачно передан делегату средства ведения журнала для журналов, связанных с созданным механизмом.

Параметры:

  • loggerContext: контекст средства ведения журнала