VirtualMachineRunCommand 類別
描述虛擬機器執行命令。
變數只會由伺服器填入，而且會在傳送要求時予以忽略。
必須填入所有必要的參數，才能傳送至 Azure。
- 繼承
-
azure.mgmt.compute.v2023_09_01.models._models_py3.ResourceVirtualMachineRunCommand
建構函式
VirtualMachineRunCommand(*, location: str, tags: Dict[str, str] | None = None, source: _models.VirtualMachineRunCommandScriptSource | None = None, parameters: List[_models.RunCommandInputParameter] | None = None, protected_parameters: List[_models.RunCommandInputParameter] | None = None, async_execution: bool = False, run_as_user: str | None = None, run_as_password: str | None = None, timeout_in_seconds: int | None = None, output_blob_uri: str | None = None, error_blob_uri: str | None = None, output_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, error_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, treat_failure_as_deployment_failure: bool = False, **kwargs: Any)Keyword-Only Parameters
- location
- str
資源位置。 必要。
執行命令腳本的來源。
- 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 只會反映執行命令是否由延伸模組平臺執行，它不會指出腳本在腳本失敗時是否失敗。 查看執行命令的實例檢視，以防腳本失敗，以查看 executionMessage、output、error： https://aka.ms/runcommandmanaged#get-execution-status-and-results 。
變數
- id
- str
資源識別碼。
- name
- str
資源名稱。
- type
- str
資源類型。
- location
- str
資源位置。 必要。
執行命令腳本的來源。
- 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 會標示為失敗。 如果 treatFailureAsDeploymentFailure 設定為 false，ProvisioningState 只會反映執行命令是否由延伸模組平臺執行，它不會指出腳本在腳本失敗時是否失敗。 查看執行命令的實例檢視，以防腳本失敗，以查看 executionMessage、output、error： https://aka.ms/runcommandmanaged#get-execution-status-and-results 。
- instance_view
- VirtualMachineRunCommandInstanceView
虛擬機器執行命令實例檢視。
- treat_failure_as_deployment_failure
- bool
選擇性。 如果設定為 true，腳本中的任何失敗都會失敗部署，且 ProvisioningState 會標示為失敗。 如果設定為 false，ProvisioningState 只會反映執行命令是否由延伸模組平臺執行，它不會指出腳本在腳本失敗時是否失敗。 查看執行命令的實例檢視，以防腳本失敗，以查看 executionMessage、output、error： https://aka.ms/runcommandmanaged#get-execution-status-and-results 。
