ComputeNodeOperations 類別
ComputeNodeOperations 作業。
您不應該直接具現化這個類別,而是建立將為您建立的 Client 實例,並將它附加為屬性。
- 繼承
-
builtins.objectComputeNodeOperations
建構函式
ComputeNodeOperations(client, config, serializer, deserializer)
參數
- client
服務要求的用戶端。
- config
服務用戶端的設定。
- serializer
物件模型序列化程式。
- deserializer
物件模型還原序列化程式。
變數
- api_version
要用於要求的 API 版本。 常數值:「2023-05-01.17.0」。
方法
add_user |
將使用者帳戶新增至指定的計算節點。 只有在使用者帳戶處於閒置或執行中狀態時,才可以將使用者帳戶新增至計算節點。 |
delete_user |
從指定的計算節點刪除使用者帳戶。 只有在使用者帳戶處於閒置或執行中狀態時,才可以將使用者帳戶刪除至計算節點。 |
disable_scheduling |
停用指定計算節點上的工作排程。 只有在目前排程狀態已啟用時,才可以停用計算節點上的工作排程。 |
enable_scheduling |
在指定的計算節點上啟用工作排程。 只有在目前排程狀態已停用時,才可以在計算節點上啟用工作排程。 |
get |
取得指定之計算節點的相關資訊。 |
get_remote_desktop |
取得指定計算節點的遠端桌面通訊協定檔案。 您必須先在計算節點上建立使用者帳戶,才能使用 RDP 檔案存取計算節點。 此 API 只能在使用雲端服務組態建立的集區上叫用。 如需使用虛擬機器設定建立的集區,請參閱 GetRemoteLoginSettings API。 |
get_remote_login_settings |
取得遠端登入計算節點所需的設定。 您必須先在計算節點上建立使用者帳戶,才能使用遠端登入設定從遠端登入計算節點。 此 API 只能在使用虛擬機器組態屬性建立的集區上叫用。 如需使用雲端服務設定建立的集區,請參閱 GetRemoteDesktop API。 |
list |
列出指定集區中的計算節點。 |
reboot |
重新開機指定的計算節點。 只有在計算節點處於閒置或執行中狀態時,才可以重新開機。 |
reimage |
在指定的計算節點上重新安裝作業系統。 只有當作業系統處於閒置或執行中狀態時,才可以在計算節點上重新安裝作業系統。 此 API 只能在使用雲端服務組態屬性建立的集區上叫用。 |
update_user |
更新指定計算節點上使用者帳戶的密碼和到期時間。 這項作業會取代帳戶的所有可更新屬性。 例如,如果未指定 expiryTime 元素,則目前的值會取代為預設值,而不會保留未修改。 只有在計算節點處於閒置或執行中狀態時,才可以更新使用者帳戶。 |
upload_batch_service_logs |
將 Azure Batch 服務記錄檔從指定的計算節點上傳至 Azure Blob 儲存體。 如果您遇到錯誤,而且想要呈報至 Azure 支援,這會以自動化方式從計算節點收集 Azure Batch 服務記錄檔。 Azure Batch 服務記錄檔應該與 Azure 支援共用,以協助偵錯 Batch 服務的問題。 |
add_user
將使用者帳戶新增至指定的計算節點。
只有在使用者帳戶處於閒置或執行中狀態時,才可以將使用者帳戶新增至計算節點。
add_user(pool_id, node_id, user, compute_node_add_user_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
delete_user
從指定的計算節點刪除使用者帳戶。
只有在使用者帳戶處於閒置或執行中狀態時,才可以將使用者帳戶刪除至計算節點。
delete_user(pool_id, node_id, user_name, compute_node_delete_user_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
disable_scheduling
停用指定計算節點上的工作排程。
只有在目前排程狀態已啟用時,才可以停用計算節點上的工作排程。
disable_scheduling(pool_id, node_id, node_disable_scheduling_option=None, compute_node_disable_scheduling_options=None, custom_headers=None, raw=False, **operation_config)
參數
- node_disable_scheduling_option
- str 或 DisableComputeNodeSchedulingOption
預設值為 requeue。 可能的值包括:'requeue'、'terminate'、'taskCompletion'
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
enable_scheduling
在指定的計算節點上啟用工作排程。
只有在目前排程狀態已停用時,才可以在計算節點上啟用工作排程。
enable_scheduling(pool_id, node_id, compute_node_enable_scheduling_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
get
取得指定之計算節點的相關資訊。
get(pool_id, node_id, compute_node_get_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true,ComputeNode 或 ClientRawResponse
傳回類型
例外狀況
get_remote_desktop
取得指定計算節點的遠端桌面通訊協定檔案。
您必須先在計算節點上建立使用者帳戶,才能使用 RDP 檔案存取計算節點。 此 API 只能在使用雲端服務組態建立的集區上叫用。 如需使用虛擬機器設定建立的集區,請參閱 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)
參數
- callback
- Callable[<xref:Bytes>, <xref:response=None>]
指定時,將會使用串流處理的每個資料區塊來呼叫 。 回呼應該採用兩個引數:目前資料區塊的位元組和回應物件。 如果資料正在上傳,回應會是 None。
- operation_config
作業組態覆寫。
傳回
object 或 ClientRawResponse if raw=true
傳回類型
例外狀況
get_remote_login_settings
取得遠端登入計算節點所需的設定。
您必須先在計算節點上建立使用者帳戶,才能使用遠端登入設定從遠端登入計算節點。 此 API 只能在使用虛擬機器組態屬性建立的集區上叫用。 如需使用雲端服務設定建立的集區,請參閱 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)
參數
- compute_node_get_remote_login_settings_options
- ComputeNodeGetRemoteLoginSettingsOptions
作業的其他參數
- operation_config
作業組態覆寫。
傳回
ComputeNodeGetRemoteLoginSettingsResult 或 ClientRawResponse if raw=true
傳回類型
例外狀況
list
列出指定集區中的計算節點。
list(pool_id, compute_node_list_options=None, custom_headers=None, raw=False, **operation_config)
參數
- operation_config
作業組態覆寫。
傳回
反覆運算器,例如 ComputeNode 的實例
傳回類型
例外狀況
reboot
重新開機指定的計算節點。
只有在計算節點處於閒置或執行中狀態時,才可以重新開機。
reboot(pool_id, node_id, node_reboot_option=None, compute_node_reboot_options=None, custom_headers=None, raw=False, **operation_config)
參數
- node_reboot_option
- str 或 ComputeNodeRebootOption
預設值為 requeue。 可能的值包括:'requeue'、'terminate'、'taskCompletion'、'retainedData'
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
reimage
在指定的計算節點上重新安裝作業系統。
只有當作業系統處於閒置或執行中狀態時,才可以在計算節點上重新安裝作業系統。 此 API 只能在使用雲端服務組態屬性建立的集區上叫用。
reimage(pool_id, node_id, node_reimage_option=None, compute_node_reimage_options=None, custom_headers=None, raw=False, **operation_config)
參數
- node_reimage_option
- str 或 ComputeNodeReimageOption
預設值為 requeue。 可能的值包括:'requeue'、'terminate'、'taskCompletion'、'retainedData'
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
update_user
更新指定計算節點上使用者帳戶的密碼和到期時間。
這項作業會取代帳戶的所有可更新屬性。 例如,如果未指定 expiryTime 元素,則目前的值會取代為預設值,而不會保留未修改。 只有在計算節點處於閒置或執行中狀態時,才可以更新使用者帳戶。
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)
參數
- operation_config
作業組態覆寫。
傳回
如果 raw=true,則為 None 或 ClientRawResponse
傳回類型
例外狀況
upload_batch_service_logs
將 Azure Batch 服務記錄檔從指定的計算節點上傳至 Azure Blob 儲存體。
如果您遇到錯誤,而且想要呈報至 Azure 支援,這會以自動化方式從計算節點收集 Azure Batch 服務記錄檔。 Azure Batch 服務記錄檔應該與 Azure 支援共用,以協助偵錯 Batch 服務的問題。
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)
參數
- upload_batch_service_logs_configuration
- UploadBatchServiceLogsConfiguration
Azure Batch 服務記錄檔上傳組態。
- compute_node_upload_batch_service_logs_options
- ComputeNodeUploadBatchServiceLogsOptions
作業的其他參數
- operation_config
作業組態覆寫。
傳回
UploadBatchServiceLogsResult 或 ClientRawResponse if raw=true
傳回類型
例外狀況
屬性
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>