Прочитать на английском

Поделиться через


Image Класс

Взаимодействие с изображениями

Наследование
Image

Конструктор

Image(freta)

Методы

analyze

Проанализируйте (или повторно проанализируйте) отправленное изображение.

Пример TODO

cancel_analysis

Отмена анализа отправленного изображения.

Пример TODO

delete

Удалите изображение вместе с любыми созданными отчетами и другими артефактами.

formats

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

Пример результата:


   {
       "lime": "LiME image",
       "raw": "Raw Physical Memory Dump",
       "vmrs": "Hyper-V Memory Snapshot"
   }
list

Получение списка изображений и их состояний.

Пример результата:


   [
       {
           "Timestamp": "2019-05-13 18:50:01",
           "image_id": "7fe75a61-b346-4a64-81f1-6389d12901f2",
           "image_type": "lime",
           "machine_id": "ubuntu-16.04-4.15.0-1040-azure",
           "owner_id": "986c3ebe-18e9-4c89-afad-1178c21603e1",
           "region": "eastus",
           "state": "Report available"
       }
   ]
search_filters

Список поддерживаемых в настоящее время фильтров поиска.

Пример результата:


   [
       "my_images",
       "my_images_and_samples"
   ]
status

Получение состояния одного изображения.

Пример результата:


   {
       "Timestamp": "2019-06-11 19:03:17",
       "analysis_version": "0.0.0",
       "image_id": "23ca6dbe-4c6f-41c0-898e-82cdd56fcf4e",
       "image_type": "vmrs",
       "machine_id": "testing_upload_sas",
       "owner_id": "309fc32f-a06b-4821-a97b-194c271f9cc5",
       "region": "australiaeast",
       "state": "Upload started"
   }
update

Обновление метаданных для образа.

Пример TODO

upload

Отправьте файл изображения и отправьте его для анализа.

Пример результата:


   {
       'image_id': '[guid string]',
       'owner_id': '[guid string]'
   }
upload_sas

Получение URI SAS для авторизации (только) отправки изображения и профиля.

Этот метод не ставит изображение в очередь для анализа. Вызовите self.analyze() с возвращенным image_id после записи данных изображения.

Пример результата:


    {
       "image": {
           "sas_url": "https://fretaNNNN.blob.core.windows.net/..."
       },
       "image_id": "23ca6dbe-4c6f-41c0-898e-82cdd56fcf4e",
       "profile": {
           "sas_url": "https://fretaNNNN.blob.core.windows.net/..."
       },
       "result": True
   }

analyze

Проанализируйте (или повторно проанализируйте) отправленное изображение.

Пример TODO

analyze(image_id: str, owner_id: typing.Union[str, NoneType] = None)

Параметры

image_id
Обязательно

Идентификатор изображения.

owner_id
Обязательно

Для образов, принадлежащих группе, — userid владельца образа.

Возвращаемое значение

True

cancel_analysis

Отмена анализа отправленного изображения.

Пример TODO

cancel_analysis(image_id: str, owner_id: typing.Union[str, NoneType] = None)

Параметры

image_id
Обязательно

Идентификатор изображения.

owner_id
Обязательно

Для образов, принадлежащих группе, — userid владельца образа.

Возвращаемое значение

True

delete

Удалите изображение вместе с любыми созданными отчетами и другими артефактами.

delete(image_id: str, owner_id: typing.Union[str, NoneType] = None)

Параметры

image_id
Обязательно

Идентификатор Freta для изображения.

owner_id
Обязательно

Необязательный идентификатор пользователя владельца образа (для образов, принадлежащих группе)

Возвращаемое значение

True

formats

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

Пример результата:


   {
       "lime": "LiME image",
       "raw": "Raw Physical Memory Dump",
       "vmrs": "Hyper-V Memory Snapshot"
   }
formats()

Возвращаемое значение

dict

list

Получение списка изображений и их состояний.

Пример результата:


   [
       {
           "Timestamp": "2019-05-13 18:50:01",
           "image_id": "7fe75a61-b346-4a64-81f1-6389d12901f2",
           "image_type": "lime",
           "machine_id": "ubuntu-16.04-4.15.0-1040-azure",
           "owner_id": "986c3ebe-18e9-4c89-afad-1178c21603e1",
           "region": "eastus",
           "state": "Report available"
       }
   ]
list(search_filter: typing.Union[str, NoneType] = None)

Параметры

search_filter
Обязательно

Фильтрация результатов поиска, вызов <xref:freta.Freta.search_filters> допустимых значений.

Возвращаемое значение

Список диктов с ключами, как показано ниже.

search_filters

Список поддерживаемых в настоящее время фильтров поиска.

Пример результата:


   [
       "my_images",
       "my_images_and_samples"
   ]
search_filters()

Возвращаемое значение

[str]

status

Получение состояния одного изображения.

Пример результата:


   {
       "Timestamp": "2019-06-11 19:03:17",
       "analysis_version": "0.0.0",
       "image_id": "23ca6dbe-4c6f-41c0-898e-82cdd56fcf4e",
       "image_type": "vmrs",
       "machine_id": "testing_upload_sas",
       "owner_id": "309fc32f-a06b-4821-a97b-194c271f9cc5",
       "region": "australiaeast",
       "state": "Upload started"
   }
status(image_id: str, owner_id: typing.Union[str, NoneType] = None)

Параметры

image_id
Обязательно

Идентификатор Freta для изображения.

owner_id
Обязательно

userid владельца образа (для образов, принадлежащих группе)

Возвращаемое значение

dict

update

Обновление метаданных для образа.

Пример TODO

update(image_id: str, owner_id: typing.Union[str, NoneType] = None, name: typing.Union[str, NoneType] = None)

Параметры

image_id
Обязательно

Идентификатор Freta для изображения

owner_id
Обязательно

Для образов, принадлежащих группе, — идентификатор пользователя владельца образа.

name
Обязательно

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

upload

Отправьте файл изображения и отправьте его для анализа.

Пример результата:


   {
       'image_id': '[guid string]',
       'owner_id': '[guid string]'
   }
upload(name: str, image_type: str, region: str, image: <function NewType.<locals>.new_type at 0x000001E3C872E840>, profile: typing.Union[File, NoneType] = None)

Параметры

name
Обязательно

Указанное пользователем имя образа.

image_type
Обязательно

Формат изображения. Сведения о допустимых значениях приведены в <xref:freta.Freta.formats>.

region
Обязательно

Регион для хранения и обработки изображения. Сведения о допустимых значениях приведены в <xref:freta.Freta.regions>.

image
Обязательно

Путь к файловой системе к файлу образа.

profile
Обязательно

Путь к файловой системе к профилю ядра. (необязательно)

Возвращаемое значение

dict

upload_sas

Получение URI SAS для авторизации (только) отправки изображения и профиля.

Этот метод не ставит изображение в очередь для анализа. Вызовите self.analyze() с возвращенным image_id после записи данных изображения.

Пример результата:


    {
       "image": {
           "sas_url": "https://fretaNNNN.blob.core.windows.net/..."
       },
       "image_id": "23ca6dbe-4c6f-41c0-898e-82cdd56fcf4e",
       "profile": {
           "sas_url": "https://fretaNNNN.blob.core.windows.net/..."
       },
       "result": True
   }
upload_sas(name: str, image_type: str, region: str)

Параметры

name
Обязательно

Имя изображения.

image_type
Обязательно

Формат изображения. Сведения о допустимых значениях приведены в <xref:freta.Freta.formats>.

region
Обязательно

Регион для хранения и обработки изображения. Сведения о допустимых значениях см. в разделе Freta.regions. Ссылка на TODO

Возвращаемое значение

dict