FileOperations Klasse

FileOperations-Vorgänge.

Sie sollten diese Klasse nicht direkt instanziieren, sondern einen Client instance erstellen, der sie für Sie erstellt und als Attribut anfügen wird.

Vererbung

builtins.object

FileOperations

Konstruktor

FileOperations(client, config, serializer, deserializer)

Parameter

client

Erforderlich

Client für Dienstanforderungen.

config

Erforderlich

Konfiguration des Dienstclients.

serializer

Erforderlich

Ein Objektmodellserialisierungsprogramm.

deserializer

Erforderlich

Ein Objektmodell-Deserialisierer.

Variablen

api_version

API-Version, die für die Anforderung verwendet werden soll. Konstanter Wert: "2023-05-01.17.0".

Methoden

delete_from_compute_node	Löscht die angegebene Datei aus dem Computeknoten.
delete_from_task	Löscht die angegebene Taskdatei aus dem Computeknoten, auf dem der Task ausgeführt wurde.
get_from_compute_node	Gibt den Inhalt der angegebenen Computeknotendatei zurück.
get_from_task	Gibt den Inhalt der angegebenen Taskdatei zurück.
get_properties_from_compute_node	Ruft die Eigenschaften der angegebenen Computeknotendatei ab.
get_properties_from_task	Ruft die Eigenschaften der angegebenen Taskdatei ab.
list_from_compute_node	Listet alle Dateien in Taskverzeichnissen auf dem angegebenen Computeknoten auf.
list_from_task	Listet die Dateien im Verzeichnis einer Aufgabe auf dem zugehörigen Computeknoten auf.

delete_from_compute_node

Löscht die angegebene Datei aus dem Computeknoten.

delete_from_compute_node(pool_id, node_id, file_path, recursive=None, file_delete_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

pool_id

str

Erforderlich

Die ID des Pools, der den Computeknoten enthält.

node_id

str

Erforderlich

Die ID des Computeknotens, aus dem Sie die Datei löschen möchten.

file_path

str

Erforderlich

Der Pfad zu der Datei oder dem Verzeichnis, die Sie löschen möchten.

recursive

bool

Standardwert: None

Gibt an, ob untergeordnete Elemente eines Verzeichnisses gelöscht werden sollen. Wenn der filePath-Parameter ein Verzeichnis anstelle einer Datei darstellt, können Sie rekursiv auf TRUE festlegen, um das Verzeichnis und alle darin enthaltenen Dateien und Unterverzeichnisse zu löschen. Wenn rekursiv false ist, muss das Verzeichnis leer sein, andernfalls schlägt das Löschen fehl.

file_delete_from_compute_node_options

FileDeleteFromComputeNodeOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

None oder ClientRawResponse if raw=true

Rückgabetyp

None,

ClientRawResponse

Ausnahmen

BatchErrorException

delete_from_task

Löscht die angegebene Taskdatei aus dem Computeknoten, auf dem der Task ausgeführt wurde.

delete_from_task(job_id, task_id, file_path, recursive=None, file_delete_from_task_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_id

str

Erforderlich

Die ID des Auftrags, der den Task enthält.

task_id

str

Erforderlich

Die ID der Aufgabe, deren Datei Sie löschen möchten.

file_path

str

Erforderlich

Der Pfad zu der Taskdatei oder dem Verzeichnis, die Bzw. das Sie löschen möchten.

recursive

bool

Standardwert: None

Gibt an, ob untergeordnete Elemente eines Verzeichnisses gelöscht werden sollen. Wenn der filePath-Parameter ein Verzeichnis anstelle einer Datei darstellt, können Sie rekursiv auf TRUE festlegen, um das Verzeichnis und alle darin enthaltenen Dateien und Unterverzeichnisse zu löschen. Wenn rekursiv false ist, muss das Verzeichnis leer sein, andernfalls schlägt das Löschen fehl.

file_delete_from_task_options

FileDeleteFromTaskOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

None oder ClientRawResponse if raw=true

Rückgabetyp

None,

ClientRawResponse

Ausnahmen

BatchErrorException

get_from_compute_node

Gibt den Inhalt der angegebenen Computeknotendatei zurück.

get_from_compute_node(pool_id, node_id, file_path, file_get_from_compute_node_options=None, custom_headers=None, raw=False, callback=None, **operation_config)

Parameter

pool_id

str

Erforderlich

Die ID des Pools, der den Computeknoten enthält.

node_id

str

Erforderlich

Die ID des Computeknotens, der die Datei enthält.

file_path

str

Erforderlich

Der Pfad zur Computeknotendatei, deren Inhalt Sie abrufen möchten.

file_get_from_compute_node_options

FileGetFromComputeNodeOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

callback

Callable[<xref:Bytes>, <xref:response=None>]

Standardwert: None

Wenn angegeben, wird mit jedem Datenblock aufgerufen, der gestreamt wird. Der Rückruf sollte zwei Argumente annehmen: die Bytes des aktuellen Datenblocks und das Antwortobjekt. Wenn die Daten hochgeladen werden, lautet die Antwort Keine.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

object oder ClientRawResponse if raw=true

Rückgabetyp

Generator,

ClientRawResponse

Ausnahmen

BatchErrorException

get_from_task

Gibt den Inhalt der angegebenen Taskdatei zurück.

get_from_task(job_id, task_id, file_path, file_get_from_task_options=None, custom_headers=None, raw=False, callback=None, **operation_config)

Parameter

job_id

str

Erforderlich

Die ID des Auftrags, der den Task enthält.

task_id

str

Erforderlich

Die ID der Aufgabe, deren Datei Sie abrufen möchten.

file_path

str

Erforderlich

Der Pfad zu der Taskdatei, deren Inhalt Sie abrufen möchten.

file_get_from_task_options

FileGetFromTaskOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

callback

Callable[<xref:Bytes>, <xref:response=None>]

Standardwert: None

Wenn angegeben, wird mit jedem Datenblock aufgerufen, der gestreamt wird. Der Rückruf sollte zwei Argumente annehmen: die Bytes des aktuellen Datenblocks und das Antwortobjekt. Wenn die Daten hochgeladen werden, lautet die Antwort Keine.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

object oder ClientRawResponse if raw=true

Rückgabetyp

Generator,

ClientRawResponse

Ausnahmen

BatchErrorException

get_properties_from_compute_node

Ruft die Eigenschaften der angegebenen Computeknotendatei ab.

get_properties_from_compute_node(pool_id, node_id, file_path, file_get_properties_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

pool_id

str

Erforderlich

Die ID des Pools, der den Computeknoten enthält.

node_id

str

Erforderlich

Die ID des Computeknotens, der die Datei enthält.

file_path

str

Erforderlich

Der Pfad zur Computeknotendatei, deren Eigenschaften Sie abrufen möchten.

file_get_properties_from_compute_node_options

FileGetPropertiesFromComputeNodeOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

None oder ClientRawResponse if raw=true

Rückgabetyp

None,

ClientRawResponse

Ausnahmen

BatchErrorException

get_properties_from_task

Ruft die Eigenschaften der angegebenen Taskdatei ab.

get_properties_from_task(job_id, task_id, file_path, file_get_properties_from_task_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_id

str

Erforderlich

Die ID des Auftrags, der den Task enthält.

task_id

str

Erforderlich

Die ID der Aufgabe, deren Datei Sie die Eigenschaften abrufen möchten.

file_path

str

Erforderlich

Der Pfad zur Taskdatei, deren Eigenschaften Sie abrufen möchten.

file_get_properties_from_task_options

FileGetPropertiesFromTaskOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

None oder ClientRawResponse if raw=true

Rückgabetyp

None,

ClientRawResponse

Ausnahmen

BatchErrorException

list_from_compute_node

Listet alle Dateien in Taskverzeichnissen auf dem angegebenen Computeknoten auf.

list_from_compute_node(pool_id, node_id, recursive=None, file_list_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

pool_id

str

Erforderlich

Die ID des Pools, der den Computeknoten enthält.

node_id

str

Erforderlich

Die ID des Computeknotens, dessen Dateien Sie auflisten möchten.

recursive

bool

Standardwert: None

Gibt an, ob untergeordnete Elemente eines Verzeichnisses aufgelistet werden sollen.

file_list_from_compute_node_options

FileListFromComputeNodeOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

Ein Iterator wie instance von NodeFile

Rückgabetyp

NodeFilePaged[NodeFile]

Ausnahmen

BatchErrorException

list_from_task

Listet die Dateien im Verzeichnis einer Aufgabe auf dem zugehörigen Computeknoten auf.

list_from_task(job_id, task_id, recursive=None, file_list_from_task_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

job_id

str

Erforderlich

Die ID des Auftrags, der den Task enthält.

task_id

str

Erforderlich

Die ID der Aufgabe, deren Dateien Sie auflisten möchten.

recursive

bool

Standardwert: None

Gibt an, ob untergeordnete Elemente des Aufgabenverzeichnisses aufgelistet werden sollen. Dieser Parameter kann in Kombination mit dem Filterparameter verwendet werden, um einen bestimmten Dateityp auflisten zu können.

file_list_from_task_options

FileListFromTaskOptions

Standardwert: None

Zusätzliche Parameter für den Vorgang

custom_headers

dict

Standardwert: None

Header, die der Anforderung hinzugefügt werden

raw

bool

Standardwert: False

gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

Ein Iterator wie instance von NodeFile

Rückgabetyp

NodeFilePaged[NodeFile]

Ausnahmen

BatchErrorException

Attribute

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>