VirtualMachineRunCommand 類別

tags

dict[str, str]

資源標籤。

source

VirtualMachineRunCommandScriptSource

執行命令腳本的來源。

parameters

list[RunCommandInputParameter]

腳本所使用的參數。

protected_parameters

list[RunCommandInputParameter]

腳本所使用的參數。

async_execution

bool

選擇性。 如果設定為 true，布建會在腳本啟動時立即完成，且不會等待腳本完成。

run_as_user

str

在執行執行命令時，指定 VM 上的使用者帳戶。

run_as_password

str

在執行執行命令時，指定 VM 上的使用者帳戶密碼。

timeout_in_seconds

int

執行執行命令的逾時以秒為單位。

output_blob_uri

str

指定將上傳腳本輸出資料流程的 Azure 儲存體 Blob。 使用具有讀取、附加、建立、寫入存取權的 SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。 請參閱 outputBlobManagedIdentity 參數。

error_blob_uri

str

指定將上傳腳本錯誤資料流程的 Azure 儲存體 Blob。 使用具有讀取、附加、建立、寫入存取權的 SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。 請參閱 errorBlobManagedIdentity 參數。

output_blob_managed_identity

RunCommandManagedIdentity

可存取 outputBlobUri 儲存體 Blob 的使用者指派受控識別。 如果是系統指派的身分識別，請使用空白物件。 請確定受控識別已獲授與具有「儲存體 Blob 資料參與者」角色指派之 Blob 容器的存取權。 如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。 如需受控識別和執行命令的詳細資訊，請參閱 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged 。

error_blob_managed_identity

RunCommandManagedIdentity

具有 errorBlobUri 儲存體 Blob 存取權的使用者指派受控識別。 如果是系統指派的身分識別，請使用空白物件。 請確定受控識別已獲授與具有「儲存體 Blob 資料參與者」角色指派之 Blob 容器的存取權。 如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。 如需受控識別和執行命令的詳細資訊，請參閱 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged 。

treat_failure_as_deployment_failure

bool

選擇性。 如果設定為 true，腳本中的任何失敗都會失敗部署，且 ProvisioningState 會標示為 [失敗]。 如果設定為 false，ProvisioningState 只會反映延伸模組平臺是否執行命令，它不會指出腳本在腳本失敗時是否失敗。 如果腳本失敗，請參閱 run 命令的實例檢視，以查看 executionMessage、輸出、錯誤： https://aka.ms/runcommandmanaged#get-execution-status-and-results 。

name

str

資源名稱。

type

str

資源類型。

location

str

資源位置。 必要。

tags

dict[str, str]

資源標籤。

source

VirtualMachineRunCommandScriptSource

執行命令腳本的來源。

parameters

list[RunCommandInputParameter]

腳本所使用的參數。

protected_parameters

list[RunCommandInputParameter]

腳本所使用的參數。

async_execution

bool

選擇性。 如果設定為 true，布建會在腳本啟動時立即完成，且不會等待腳本完成。

run_as_user

str

在執行執行命令時，指定 VM 上的使用者帳戶。

run_as_password

str

在執行執行命令時，指定 VM 上的使用者帳戶密碼。

timeout_in_seconds

int

執行執行命令的逾時以秒為單位。

output_blob_uri

str

指定將上傳腳本輸出資料流程的 Azure 儲存體 Blob。 使用具有讀取、附加、建立、寫入存取權的 SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。 請參閱 outputBlobManagedIdentity 參數。

error_blob_uri

str

指定將上傳腳本錯誤資料流程的 Azure 儲存體 Blob。 使用具有讀取、附加、建立、寫入存取權的 SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。 請參閱 errorBlobManagedIdentity 參數。

output_blob_managed_identity

RunCommandManagedIdentity

可存取 outputBlobUri 儲存體 Blob 的使用者指派受控識別。 如果是系統指派的身分識別，請使用空白物件。 請確定受控識別已獲授與具有「儲存體 Blob 資料參與者」角色指派之 Blob 容器的存取權。 如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。 如需受控識別和執行命令的詳細資訊，請參閱 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged 。

error_blob_managed_identity

RunCommandManagedIdentity

具有 errorBlobUri 儲存體 Blob 存取權的使用者指派受控識別。 如果是系統指派的身分識別，請使用空白物件。 請確定受控識別已獲授與具有「儲存體 Blob 資料參與者」角色指派之 Blob 容器的存取權。 如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。 如需受控識別和執行命令的詳細資訊，請參閱 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged 。

provisioning_state

str

布建狀態，只會出現在回應中。 如果 treatFailureAsDeploymentFailure 設定為 true，腳本中的任何失敗都會失敗，且 ProvisioningState 會標示為 Failed。 如果 treatFailureAsDeploymentFailure 設定為 false，ProvisioningState 只會反映執行命令是否由擴充功能平臺執行，它不會指出腳本在腳本失敗時是否失敗。 如果腳本失敗，請參閱 run 命令的實例檢視，以查看 executionMessage、輸出、錯誤： https://aka.ms/runcommandmanaged#get-execution-status-and-results 。

instance_view

VirtualMachineRunCommandInstanceView

虛擬機器執行命令實例檢視。

treat_failure_as_deployment_failure

bool

選擇性。 如果設定為 true，腳本中的任何失敗都會失敗部署，且 ProvisioningState 會標示為 [失敗]。 如果設定為 false，ProvisioningState 只會反映延伸模組平臺是否執行命令，它不會指出腳本在腳本失敗時是否失敗。 如果腳本失敗，請參閱 run 命令的實例檢視，以查看 executionMessage、輸出、錯誤： https://aka.ms/runcommandmanaged#get-execution-status-and-results 。