Image Klass

Interagera med bilder

Arv
Image

Konstruktor

Image(freta)

Metoder

analyze

Analysera (eller analysera om) en uppladdad bild.

TODO-exempel

cancel_analysis

Avbryt analysen av en uppladdad bild.

TODO-exempel

delete

Ta bort en bild tillsammans med någon av dess genererade rapporter och andra artefakter.

formats

Hämta listan över bildformat som stöds för närvarande.

Exempelresultat:


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

Hämta listan över bilder och deras statusar.

Exempelresultat:


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

Visar de sökfilter som stöds för närvarande.

Exempelresultat:


   [
       "my_images",
       "my_images_and_samples"
   ]
status

Hämta status för en enskild avbildning.

Exempelresultat:


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

Uppdatera metadata för en bild.

TODO-exempel

upload

Ladda upp en bildfil och skicka den för analys.

Exempelresultat:


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

Hämta SAS-URI:er som auktoriserar (endast) uppladdning av en bild och en profil.

Den här metoden placerar inte bilden i kö för analys. Anropa self.analyze() med den returnerade image_id när du har skrivit bilddata.

Exempelresultat:


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

Analysera (eller analysera om) en uppladdad bild.

TODO-exempel

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

Parametrar

image_id
Obligatorisk

Bildidentifierare.

owner_id
Obligatorisk

För gruppägda avbildningar använder du avbildningsägarens användar-ID.

Returer

Sant

cancel_analysis

Avbryt analysen av en uppladdad bild.

TODO-exempel

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

Parametrar

image_id
Obligatorisk

Bildidentifierare.

owner_id
Obligatorisk

För gruppägda avbildningar använder du avbildningsägarens användar-ID.

Returer

Sant

delete

Ta bort en bild tillsammans med någon av dess genererade rapporter och andra artefakter.

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

Parametrar

image_id
Obligatorisk

Freta-identifierare för bilden.

owner_id
Obligatorisk

Valfritt användar-ID för avbildningsägaren (för gruppägda avbildningar)

Returer

Sant

formats

Hämta listan över bildformat som stöds för närvarande.

Exempelresultat:


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

Returer

dict

list

Hämta listan över bilder och deras statusar.

Exempelresultat:


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

Parametrar

search_filter
Obligatorisk

Filtrera sökresultat, anropa <xref:freta.Freta.search_filters> tillåtna värden.

Returer

Lista över diktamen med nycklar enligt nedan.

search_filters

Visar de sökfilter som stöds för närvarande.

Exempelresultat:


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

Returer

[str]

status

Hämta status för en enskild avbildning.

Exempelresultat:


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

Parametrar

image_id
Obligatorisk

Freta-identifierare för bilden.

owner_id
Obligatorisk

användar-ID för avbildningsägaren (för gruppägda avbildningar)

Returer

dict

update

Uppdatera metadata för en bild.

TODO-exempel

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

Parametrar

image_id
Obligatorisk

Freta-identifierare för bilden

owner_id
Obligatorisk

För gruppägda avbildningar använder du avbildningsägarens användar-ID.

name
Obligatorisk

Du kan också ange användarens angivna dator som identifierare för avbildningen

upload

Ladda upp en bildfil och skicka den för analys.

Exempelresultat:


   {
       '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)

Parametrar

name
Obligatorisk

Användardefingivet namn på avbildningen.

image_type
Obligatorisk

Bildens format. Se <xref:freta.Freta.formats> för tillåtna värden.

region
Obligatorisk

Region där avbildningen ska lagras och bearbetas. Se <xref:freta.Freta.regions> för tillåtna värden.

image
Obligatorisk

Filsystemsökväg till avbildningsfilen.

profile
Obligatorisk

Filsystemsökväg till kernelprofil. (Valfritt)

Returer

dict

upload_sas

Hämta SAS-URI:er som auktoriserar (endast) uppladdning av en bild och en profil.

Den här metoden placerar inte bilden i kö för analys. Anropa self.analyze() med den returnerade image_id när du har skrivit bilddata.

Exempelresultat:


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

Parametrar

name
Obligatorisk

Namnet på avbildningen.

image_type
Obligatorisk

Bildens format. Se <xref:freta.Freta.formats> för tillåtna värden.

region
Obligatorisk

Region där avbildningen ska lagras och bearbetas. Tillåtna värden finns i Freta.regions. ToDO-länk

Returer

dict