ComputeNodeOperations Klasse

ComputeNodeOperations-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

ComputeNodeOperations

Konstruktor

ComputeNodeOperations(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

add_user	Fügt dem angegebenen Computeknoten ein Benutzerkonto hinzu. Sie können einem Computeknoten ein Benutzerkonto nur hinzufügen, wenn es sich im Leerlauf- oder Ausführungszustand befindet.
delete_user	Löscht ein Benutzerkonto aus dem angegebenen Computeknoten. Sie können ein Benutzerkonto nur in einem Computeknoten löschen, wenn es sich im Leerlauf- oder Ausführungszustand befindet.
disable_scheduling	Deaktiviert die Aufgabenplanung auf dem angegebenen Computeknoten. Sie können die Aufgabenplanung auf einem Computeknoten nur deaktivieren, wenn der aktuelle Planungsstatus aktiviert ist.
enable_scheduling	Aktiviert die Aufgabenplanung auf dem angegebenen Computeknoten. Sie können die Aufgabenplanung auf einem Computeknoten nur aktivieren, wenn der aktuelle Planungszustand deaktiviert ist.
get	Ruft Informationen zum angegebenen Computeknoten ab.
get_remote_desktop	Ruft die Remotedesktopprotokolldatei für den angegebenen Computeknoten ab. Bevor Sie mithilfe der RDP-Datei auf einen Computeknoten zugreifen können, müssen Sie ein Benutzerkonto auf dem Computeknoten erstellen. Diese API kann nur für Pools aufgerufen werden, die mit einer Clouddienstkonfiguration erstellt wurden. Informationen zu Pools, die mit einer VM-Konfiguration erstellt wurden, finden Sie unter GetRemoteLoginSettings-API.
get_remote_login_settings	Ruft die Einstellungen ab, die für die Remoteanmeldung bei einem Computeknoten erforderlich sind. Bevor Sie sich remote bei einem Computeknoten mithilfe der Remoteanmeldungseinstellungen anmelden können, müssen Sie ein Benutzerkonto auf dem Computeknoten erstellen. Diese API kann nur für Pools aufgerufen werden, die mit der Konfigurationseigenschaft des virtuellen Computers erstellt wurden. Informationen zu Pools, die mit einer Clouddienstkonfiguration erstellt wurden, finden Sie in der GetRemoteDesktop-API.
list	Listet die Computeknoten im angegebenen Pool auf.
reboot	Startet den angegebenen Computeknoten neu. Sie können einen Computeknoten nur neu starten, wenn er sich im Leerlauf- oder Ausführungszustand befindet.
reimage	Installiert das Betriebssystem auf dem angegebenen Computeknoten neu. Sie können das Betriebssystem nur dann auf einem Computeknoten neu installieren, wenn es sich im Leerlauf- oder Ausführungszustand befindet. Diese API kann nur für Pools aufgerufen werden, die mit der Konfigurationseigenschaft des Clouddiensts erstellt wurden.
update_user	Updates das Kennwort und die Ablaufzeit eines Benutzerkontos auf dem angegebenen Computeknoten. Dieser Vorgang ersetzt alle aktualisierbaren Eigenschaften des Kontos. Wenn z. B. das element expiryTime nicht angegeben ist, wird der aktuelle Wert durch den Standardwert ersetzt und nicht unverändert gelassen. Sie können ein Benutzerkonto auf einem Computeknoten nur aktualisieren, wenn es sich im Leerlauf- oder Ausführungszustand befindet.
upload_batch_service_logs	Laden Sie Azure Batch-Dienstprotokolldateien vom angegebenen Computeknoten in Azure Blob Storage hoch. Dies dient zum automatisierten Sammeln Azure Batch Dienstprotokolldateien von Computeknoten, wenn ein Fehler auftritt und sie zu Azure-Support eskalieren möchten. Die Azure Batch-Dienstprotokolldateien sollten für Azure-Support freigegeben werden, um Beim Debuggen von Problemen mit dem Batch-Dienst zu helfen.

add_user

Fügt dem angegebenen Computeknoten ein Benutzerkonto hinzu.

Sie können einem Computeknoten ein Benutzerkonto nur hinzufügen, wenn es sich im Leerlauf- oder Ausführungszustand befindet.

add_user(pool_id, node_id, user, compute_node_add_user_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 Computers, auf dem Sie ein Benutzerkonto erstellen möchten.

user

ComputeNodeUser

Erforderlich

Das zu erstellende Benutzerkonto.

compute_node_add_user_options

ComputeNodeAddUserOptions

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 neben 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_user

Löscht ein Benutzerkonto aus dem angegebenen Computeknoten.

Sie können ein Benutzerkonto nur in einem Computeknoten löschen, wenn es sich im Leerlauf- oder Ausführungszustand befindet.

delete_user(pool_id, node_id, user_name, compute_node_delete_user_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 Computers, auf dem Sie ein Benutzerkonto löschen möchten.

user_name

str

Erforderlich

Der Name des zu löschenden Benutzerkontos.

compute_node_delete_user_options

ComputeNodeDeleteUserOptions

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 neben 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

disable_scheduling

Deaktiviert die Aufgabenplanung auf dem angegebenen Computeknoten.

Sie können die Aufgabenplanung auf einem Computeknoten nur deaktivieren, wenn der aktuelle Planungsstatus aktiviert ist.

disable_scheduling(pool_id, node_id, node_disable_scheduling_option=None, compute_node_disable_scheduling_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, auf dem Sie die Aufgabenplanung deaktivieren möchten.

node_disable_scheduling_option

str oder DisableComputeNodeSchedulingOption

Standardwert: None

Der Standardwert ist „requeue“. Mögliche Werte: "requeue", "terminate", "taskCompletion"

compute_node_disable_scheduling_options

ComputeNodeDisableSchedulingOptions

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 neben 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

enable_scheduling

Aktiviert die Aufgabenplanung auf dem angegebenen Computeknoten.

Sie können die Aufgabenplanung auf einem Computeknoten nur aktivieren, wenn der aktuelle Planungszustand deaktiviert ist.

enable_scheduling(pool_id, node_id, compute_node_enable_scheduling_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, auf dem Sie die Aufgabenplanung aktivieren möchten.

compute_node_enable_scheduling_options

ComputeNodeEnableSchedulingOptions

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 neben 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

Ruft Informationen zum angegebenen Computeknoten ab.

get(pool_id, node_id, compute_node_get_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, zu dem Sie Informationen abrufen möchten.

compute_node_get_options

ComputeNodeGetOptions

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 neben der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

ComputeNode oder ClientRawResponse, wenn raw=true

Rückgabetyp

ComputeNode,

ClientRawResponse

Ausnahmen

BatchErrorException

get_remote_desktop

Ruft die Remotedesktopprotokolldatei für den angegebenen Computeknoten ab.

Bevor Sie mithilfe der RDP-Datei auf einen Computeknoten zugreifen können, müssen Sie ein Benutzerkonto auf dem Computeknoten erstellen. Diese API kann nur für Pools aufgerufen werden, die mit einer Clouddienstkonfiguration erstellt wurden. Informationen zu Pools, die mit einer VM-Konfiguration erstellt wurden, finden Sie unter GetRemoteLoginSettings-API.

get_remote_desktop(pool_id, node_id, compute_node_get_remote_desktop_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, für den Sie die Remotedesktopprotokolldatei abrufen möchten.

compute_node_get_remote_desktop_options

ComputeNodeGetRemoteDesktopOptions

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 neben der deserialisierten Antwort zurück.

callback

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

Standardwert: None

Wenn angegeben, wird mit jedem Datenblock aufgerufen, der gestreamt wird. Für den Rückruf sollten zwei Argumente verwendet werden: 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_remote_login_settings

Ruft die Einstellungen ab, die für die Remoteanmeldung bei einem Computeknoten erforderlich sind.

Bevor Sie sich remote bei einem Computeknoten mithilfe der Remoteanmeldungseinstellungen anmelden können, müssen Sie ein Benutzerkonto auf dem Computeknoten erstellen. Diese API kann nur für Pools aufgerufen werden, die mit der Konfigurationseigenschaft des virtuellen Computers erstellt wurden. Informationen zu Pools, die mit einer Clouddienstkonfiguration erstellt wurden, finden Sie in der GetRemoteDesktop-API.

get_remote_login_settings(pool_id, node_id, compute_node_get_remote_login_settings_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, für den die Remoteanmeldungseinstellungen abgerufen werden sollen.

compute_node_get_remote_login_settings_options

ComputeNodeGetRemoteLoginSettingsOptions

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 neben der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

ComputeNodeGetRemoteLoginSettingsResult oder ClientRawResponse if raw=true

Rückgabetyp

ComputeNodeGetRemoteLoginSettingsResult,

ClientRawResponse

Ausnahmen

BatchErrorException

list

Listet die Computeknoten im angegebenen Pool auf.

list(pool_id, compute_node_list_options=None, custom_headers=None, raw=False, **operation_config)

Parameter

pool_id

str

Erforderlich

Die ID des Pools, aus dem Sie Computeknoten auflisten möchten.

compute_node_list_options

ComputeNodeListOptions

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 neben der deserialisierten Antwort zurück.

operation_config

Erforderlich

Außerkraftsetzungen der Vorgangskonfiguration.

Gibt zurück

Ein Iterator wie instance von ComputeNode

Rückgabetyp

ComputeNodePaged[ComputeNode]

Ausnahmen

BatchErrorException

reboot

Startet den angegebenen Computeknoten neu.

Sie können einen Computeknoten nur neu starten, wenn er sich im Leerlauf- oder Ausführungszustand befindet.

reboot(pool_id, node_id, node_reboot_option=None, compute_node_reboot_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, den Sie neu starten möchten.

node_reboot_option

str oder ComputeNodeRebootOption

Standardwert: None

Der Standardwert ist „requeue“. Mögliche Werte: "requeue", "terminate", "taskCompletion", "retainedData"

compute_node_reboot_options

ComputeNodeRebootOptions

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 neben 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

reimage

Installiert das Betriebssystem auf dem angegebenen Computeknoten neu.

Sie können das Betriebssystem nur dann auf einem Computeknoten neu installieren, wenn es sich im Leerlauf- oder Ausführungszustand befindet. Diese API kann nur für Pools aufgerufen werden, die mit der Konfigurationseigenschaft des Clouddiensts erstellt wurden.

reimage(pool_id, node_id, node_reimage_option=None, compute_node_reimage_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, den Sie neu starten möchten.

node_reimage_option

str oder ComputeNodeReimageOption

Standardwert: None

Der Standardwert ist „requeue“. Mögliche Werte: "requeue", "terminate", "taskCompletion", "retainedData"

compute_node_reimage_options

ComputeNodeReimageOptions

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

update_user

Updates das Kennwort und die Ablaufzeit eines Benutzerkontos auf dem angegebenen Computeknoten.

Dieser Vorgang ersetzt alle aktualisierbaren Eigenschaften des Kontos. Wenn z. B. das element expiryTime nicht angegeben ist, wird der aktuelle Wert durch den Standardwert ersetzt und nicht unverändert gelassen. Sie können ein Benutzerkonto auf einem Computeknoten nur aktualisieren, wenn es sich im Leerlauf- oder Ausführungszustand befindet.

update_user(pool_id, node_id, user_name, node_update_user_parameter, compute_node_update_user_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 Computers, auf dem Sie ein Benutzerkonto aktualisieren möchten.

user_name

str

Erforderlich

Der Name des zu aktualisierenden Benutzerkontos.

node_update_user_parameter

NodeUpdateUserParameter

Erforderlich

Die Parameter für die Anforderung.

compute_node_update_user_options

ComputeNodeUpdateUserOptions

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

upload_batch_service_logs

Laden Sie Azure Batch-Dienstprotokolldateien vom angegebenen Computeknoten in Azure Blob Storage hoch.

Dies dient zum automatisierten Sammeln Azure Batch Dienstprotokolldateien von Computeknoten, wenn ein Fehler auftritt und sie zu Azure-Support eskalieren möchten. Die Azure Batch-Dienstprotokolldateien sollten für Azure-Support freigegeben werden, um Beim Debuggen von Problemen mit dem Batch-Dienst zu helfen.

upload_batch_service_logs(pool_id, node_id, upload_batch_service_logs_configuration, compute_node_upload_batch_service_logs_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 Azure Batch-Dienstprotokolldateien hochladen möchten.

upload_batch_service_logs_configuration

UploadBatchServiceLogsConfiguration

Erforderlich

Die Azure Batch-Dienstprotokolldatei-Uploadkonfiguration.

compute_node_upload_batch_service_logs_options

ComputeNodeUploadBatchServiceLogsOptions

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

UploadBatchServiceLogsResult oder ClientRawResponse if raw=true

Rückgabetyp

UploadBatchServiceLogsResult,

ClientRawResponse

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