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

1 つのイメージの状態を取得します。

結果の例:


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

1 つのイメージの状態を取得します。

結果の例:


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

必要に応じて、イメージのユーザー指定のマシン identifer を設定します

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