Image Classe
Interagir avec des images
- Héritage
-
Image
Constructeur
Image(freta)
Méthodes
| analyze |
Analyser (ou ré-analyser) une image chargée. Exemple TODO |
| cancel_analysis |
Annuler l’analyse d’une image chargée. Exemple TODO |
| delete |
Supprimez une image, ainsi que l’un de ses rapports générés et d’autres artefacts. |
| formats |
Obtenez la liste des formats d’image actuellement pris en charge. Exemple de résultat :
|
| list |
Obtenez la liste des images et leurs états. Exemple de résultat :
|
| search_filters |
Répertorie les filtres de recherche actuellement pris en charge. Exemple de résultat :
|
| status |
Obtenir l’état d’une seule image. Exemple de résultat :
|
| update |
Mettre à jour les métadonnées d’une image. Exemple TODO |
| upload |
Chargez un fichier image et envoyez-le pour analyse. Exemple de résultat :
|
| upload_sas |
Obtenez des URI SAP autorisant (uniquement) le chargement d’une image et d’un profil. Cette méthode ne met pas l’image en file d’attente pour analyse. Appelez self.analyze() avec le image_id retourné après avoir écrit les données de l’image. Exemple de résultat :
|
analyze
Analyser (ou ré-analyser) une image chargée.
Exemple TODO
analyze(image_id: str, owner_id: typing.Union[str, NoneType] = None)
Paramètres
- image_id
Identificateur d’image.
- owner_id
Pour les images appartenant au groupe, userid du propriétaire de l’image.
Retours
True
cancel_analysis
Annuler l’analyse d’une image chargée.
Exemple TODO
cancel_analysis(image_id: str, owner_id: typing.Union[str, NoneType] = None)
Paramètres
- image_id
Identificateur d’image.
- owner_id
Pour les images appartenant au groupe, userid du propriétaire de l’image.
Retours
True
delete
Supprimez une image, ainsi que l’un de ses rapports générés et d’autres artefacts.
delete(image_id: str, owner_id: typing.Union[str, NoneType] = None)
Paramètres
- image_id
Identificateur freta pour l’image.
- owner_id
Userid facultatif du propriétaire de l’image (Pour les images appartenant au groupe)
Retours
True
formats
Obtenez la liste des formats d’image actuellement pris en charge.
Exemple de résultat :
{
"lime": "LiME image",
"raw": "Raw Physical Memory Dump",
"vmrs": "Hyper-V Memory Snapshot"
}
formats()
Retours
dict
list
Obtenez la liste des images et leurs états.
Exemple de résultat :
[
{
"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)
Paramètres
- search_filter
Filtrez les résultats de la recherche, appelez <xref:freta.Freta.search_filters> pour les valeurs autorisées.
Retours
Liste des dicts contenant des clés, comme indiqué ci-dessous.
search_filters
Répertorie les filtres de recherche actuellement pris en charge.
Exemple de résultat :
[
"my_images",
"my_images_and_samples"
]
search_filters()
Retours
[str]
status
Obtenir l’état d’une seule image.
Exemple de résultat :
{
"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)
Paramètres
- image_id
Identificateur freta pour l’image.
- owner_id
userid du propriétaire de l’image (pour les images appartenant au groupe)
Retours
dict
update
Mettre à jour les métadonnées d’une image.
Exemple TODO
update(image_id: str, owner_id: typing.Union[str, NoneType] = None, name: typing.Union[str, NoneType] = None)
Paramètres
- image_id
Identificateur Freta pour l’image
- owner_id
Pour les images appartenant au groupe, userid du propriétaire de l’image.
- name
Si vous le souhaitez, définissez l’identificateur de machine spécifié par l’utilisateur pour l’image
upload
Chargez un fichier image et envoyez-le pour analyse.
Exemple de résultat :
{
'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)
Paramètres
- name
Nom spécifié par l’utilisateur pour l’image.
- image_type
Format de l’image. Consultez <xref:freta.Freta.formats> pour connaître les valeurs autorisées.
- region
Région dans laquelle stocker et traiter l’image. Consultez <xref:freta.Freta.regions> pour connaître les valeurs autorisées.
- image
Chemin d’accès du système de fichiers au fichier image.
- profile
Chemin d’accès du système de fichiers au profil du noyau. (facultatif)
Retours
dict
upload_sas
Obtenez des URI SAP autorisant (uniquement) le chargement d’une image et d’un profil.
Cette méthode ne met pas l’image en file d’attente pour analyse. Appelez self.analyze() avec le image_id retourné après avoir écrit les données de l’image.
Exemple de résultat :
{
"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)
Paramètres
- name
Nom de l’image.
- image_type
Format de l’image. Consultez <xref:freta.Freta.formats> pour connaître les valeurs autorisées.
- region
Région dans laquelle stocker et traiter l’image. Consultez Freta.regions pour connaître les valeurs autorisées. Lien TODO
Retours
dict