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