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

获取仅) 上传图像和配置文件 (授权的 SAS URI。

此方法不会将图像排队进行分析。 在写入图像数据后,使用返回 image_id 调用 self.analyze () 。

示例结果:


    {
       "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
必需

映像所有者的可选 userid (组拥有的映像)

返回

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
必需

对于组拥有的映像,为映像所有者的 userid。

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

获取仅) 上传图像和配置文件 (授权的 SAS URI。

此方法不会将图像排队进行分析。 在写入图像数据后,使用返回 image_id 调用 self.analyze () 。

示例结果:


    {
       "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