Image Classe

Interagir com Imagens

Herança
Image

Construtor

Image(freta)

Métodos

analyze

Analisar (ou analisar novamente) uma imagem carregada.

Exemplo de TODO

cancel_analysis

Cancelar a análise de uma imagem carregada.

Exemplo de TODO

delete

Elimine uma imagem juntamente com qualquer um dos respetivos relatórios gerados e outros artefactos.

formats

Obtenha a lista de formatos de imagem atualmente suportados.

Resultado de exemplo:


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

Obtenha a lista de imagens e os respetivos estados.

Resultado de exemplo:


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

Lista os filtros de pesquisa atualmente suportados.

Resultado de exemplo:


   [
       "my_images",
       "my_images_and_samples"
   ]
status

Obtenha o estado de uma única imagem.

Resultado de exemplo:


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

Atualizar metadados para uma imagem.

Exemplo de TODO

upload

Carregue um ficheiro de imagem e submeta-o para análise.

Resultado de exemplo:


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

Obtenha URIs de SAS que autorizam (apenas) o carregamento de uma imagem e de um perfil.

Este método não coloca a imagem em fila para análise. Chame self.analyze() com o image_id devolvido depois de escrever os dados da imagem.

Resultado de exemplo:


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

Analisar (ou analisar novamente) uma imagem carregada.

Exemplo de TODO

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

Parâmetros

image_id
Necessário

Identificador de imagem.

owner_id
Necessário

Para imagens pertencentes ao grupo, userid do proprietário da imagem.

Devoluções

Verdadeiro

cancel_analysis

Cancelar a análise de uma imagem carregada.

Exemplo de TODO

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

Parâmetros

image_id
Necessário

Identificador de imagem.

owner_id
Necessário

Para imagens pertencentes ao grupo, userid do proprietário da imagem.

Devoluções

Verdadeiro

delete

Elimine uma imagem juntamente com qualquer um dos respetivos relatórios gerados e outros artefactos.

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

Parâmetros

image_id
Necessário

Identificador freta para a imagem.

owner_id
Necessário

Userid opcional do proprietário da imagem (Para imagens pertencentes ao grupo)

Devoluções

Verdadeiro

formats

Obtenha a lista de formatos de imagem atualmente suportados.

Resultado de exemplo:


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

Devoluções

dict

list

Obtenha a lista de imagens e os respetivos estados.

Resultado de exemplo:


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

Parâmetros

search_filter
Necessário

Filtrar os resultados da pesquisa, pedir <xref:freta.Freta.search_filters> valores permitidos.

Devoluções

Lista de ditados com chaves, conforme mostrado abaixo.

search_filters

Lista os filtros de pesquisa atualmente suportados.

Resultado de exemplo:


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

Devoluções

[str]

status

Obtenha o estado de uma única imagem.

Resultado de exemplo:


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

Parâmetros

image_id
Necessário

Identificador freta para a imagem.

owner_id
Necessário

userid do proprietário da imagem (Para imagens pertencentes ao grupo)

Devoluções

dict

update

Atualizar metadados para uma imagem.

Exemplo de TODO

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

Parâmetros

image_id
Necessário

Identificador freta para a imagem

owner_id
Necessário

Para imagens pertencentes a um grupo, o userid do proprietário da imagem.

name
Necessário

Opcionalmente, defina o identifer do computador especificado pelo utilizador para a imagem

upload

Carregue um ficheiro de imagem e submeta-o para análise.

Resultado de exemplo:


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

Parâmetros

name
Necessário

Nome especificado pelo utilizador para a imagem.

image_type
Necessário

Formato da imagem. Veja <xref:freta.Freta.formats> os valores permitidos.

region
Necessário

Região na qual armazenar e processar a imagem. Veja <xref:freta.Freta.regions> os valores permitidos.

image
Necessário

Caminho do sistema de ficheiros para o ficheiro de imagem.

profile
Necessário

Caminho do sistema de ficheiros para o perfil kernel. (Opcional)

Devoluções

dict

upload_sas

Obtenha URIs de SAS que autorizam (apenas) o carregamento de uma imagem e de um perfil.

Este método não coloca a imagem em fila para análise. Chame self.analyze() com o image_id devolvido depois de escrever os dados da imagem.

Resultado de exemplo:


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

Parâmetros

name
Necessário

Nome da imagem.

image_type
Necessário

Formato da imagem. Veja <xref:freta.Freta.formats> os valores permitidos.

region
Necessário

Região na qual armazenar e processar a imagem. Veja Freta.regions para obter os valores permitidos. Ligação TODO

Devoluções

dict