Image Clase
Interacción con imágenes
- Herencia
-
Image
Constructor
Image(freta)
Métodos
| analyze |
Analice (o vuelva a analizar) una imagen cargada. Ejemplo de TODO |
| cancel_analysis |
Cancele el análisis de una imagen cargada. Ejemplo de TODO |
| delete |
Elimine una imagen junto con cualquiera de sus informes generados y otros artefactos. |
| formats |
Obtenga la lista de formatos de imagen admitidos actualmente. Resultado de ejemplo:
|
| list |
Obtenga la lista de imágenes y sus estados. Resultado de ejemplo:
|
| search_filters |
Enumera los filtros de búsqueda admitidos actualmente. Resultado de ejemplo:
|
| status |
Obtiene el estado de una sola imagen. Resultado de ejemplo:
|
| update |
Actualice los metadatos de una imagen. Ejemplo de TODO |
| upload |
Cargue un archivo de imagen y envíelo para su análisis. Resultado de ejemplo:
|
| upload_sas |
Obtenga la carga de URI de SAS (solo) de una imagen y un perfil. Este método no pone en cola la imagen para su análisis. Llame a self.analyze() con el image_id devuelto después de escribir los datos de la imagen. Resultado de ejemplo:
|
analyze
Analice (o vuelva a analizar) una imagen cargada.
Ejemplo de TODO
analyze(image_id: str, owner_id: typing.Union[str, NoneType] = None)
Parámetros
- image_id
Identificador de imagen.
- owner_id
En el caso de las imágenes propiedad del grupo, userid del propietario de la imagen.
Devoluciones
Verdadero
cancel_analysis
Cancele el análisis de una imagen cargada.
Ejemplo de TODO
cancel_analysis(image_id: str, owner_id: typing.Union[str, NoneType] = None)
Parámetros
- image_id
Identificador de imagen.
- owner_id
En el caso de las imágenes propiedad del grupo, userid del propietario de la imagen.
Devoluciones
Verdadero
delete
Elimine una imagen junto con cualquiera de sus informes generados y otros artefactos.
delete(image_id: str, owner_id: typing.Union[str, NoneType] = None)
Parámetros
- image_id
Identificador freta de la imagen.
- owner_id
Userid opcional del propietario de la imagen (para imágenes propiedad del grupo)
Devoluciones
Verdadero
formats
Obtenga la lista de formatos de imagen admitidos actualmente.
Resultado de ejemplo:
{
"lime": "LiME image",
"raw": "Raw Physical Memory Dump",
"vmrs": "Hyper-V Memory Snapshot"
}
formats()
Devoluciones
dict
list
Obtenga la lista de imágenes y sus estados.
Resultado de ejemplo:
[
{
"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
Filtrar los resultados de la búsqueda, llamar a <xref:freta.Freta.search_filters> los valores permitidos.
Devoluciones
Lista de dicts que tienen claves como se muestra a continuación.
search_filters
Enumera los filtros de búsqueda admitidos actualmente.
Resultado de ejemplo:
[
"my_images",
"my_images_and_samples"
]
search_filters()
Devoluciones
[str]
status
Obtiene el estado de una sola imagen.
Resultado de ejemplo:
{
"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
Identificador freta de la imagen.
- owner_id
userid del propietario de la imagen (para imágenes propiedad del grupo)
Devoluciones
dict
update
Actualice los metadatos de una imagen.
Ejemplo de TODO
update(image_id: str, owner_id: typing.Union[str, NoneType] = None, name: typing.Union[str, NoneType] = None)
Parámetros
- image_id
Identificador de Freta para la imagen
- owner_id
En el caso de las imágenes propiedad del grupo, el identificador de usuario del propietario de la imagen.
- name
Opcionalmente, establezca el identificador de equipo especificado por el usuario para la imagen.
upload
Cargue un archivo de imagen y envíelo para su análisis.
Resultado de ejemplo:
{
'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
Nombre especificado por el usuario para la imagen.
- image_type
Formato de la imagen. Consulte <xref:freta.Freta.formats> para ver los valores permitidos.
- region
Región en la que se va a almacenar y procesar la imagen. Consulte <xref:freta.Freta.regions> para ver los valores permitidos.
- image
Ruta de acceso del sistema de archivos al archivo de imagen.
- profile
Ruta de acceso del sistema de archivos al perfil de kernel. (Opcional)
Devoluciones
dict
upload_sas
Obtenga la carga de URI de SAS (solo) de una imagen y un perfil.
Este método no pone en cola la imagen para su análisis. Llame a self.analyze() con el image_id devuelto después de escribir los datos de la imagen.
Resultado de ejemplo:
{
"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
Nombre de la imagen.
- image_type
Formato de la imagen. Consulte <xref:freta.Freta.formats> para ver los valores permitidos.
- region
Región en la que se va a almacenar y procesar la imagen. Consulte Freta.regions para conocer los valores permitidos. Vínculo TODO
Devoluciones
dict