VirtualMachineRunCommand interface

套件:

@azure/arm-compute

描述虛擬機執行命令。

Extends

Resource

屬性

asyncExecution	自選。 如果設定為 true，則一開始腳本就會完成布建，且不會等待腳本完成。
errorBlobManagedIdentity	使用者指派的受控識別可存取 errorBlobUri 記憶體 Blob。 在系統指派的身分識別的情況下，請使用空白物件。 請確定受控識別已獲得 Blob 容器的存取權，並具有「記憶體 Blob 數據參與者」角色指派。 如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。 如需受控識別和執行命令的詳細資訊，請參閱 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged
errorBlobUri	指定將上傳文稿錯誤數據流的 Azure 記憶體 Blob。 使用具有讀取、附加、建立、寫入存取權的SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。 請參閱 errorBlobManagedIdentity 參數。
instanceView	虛擬機執行命令實例檢視。 注意：這個屬性不會串行化。 它只能由伺服器填入。
outputBlobManagedIdentity	使用者指派的受控識別可存取 outputBlobUri 記憶體 Blob。 在系統指派的身分識別的情況下，請使用空白物件。 請確定受控識別已獲得 Blob 容器的存取權，並具有「記憶體 Blob 數據參與者」角色指派。 如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。 如需受控識別和執行命令的詳細資訊，請參閱 https://aka.ms/ManagedIdentity 和 https://aka.ms/RunCommandManaged
outputBlobUri	指定將上傳文本輸出數據流的 Azure 記憶體 Blob。 使用具有讀取、附加、建立、寫入存取權的SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。 請參閱 outputBlobManagedIdentity 參數。
parameters	腳本所使用的參數。
protectedParameters	腳本所使用的參數。
provisioningState	只出現在回應中的布建狀態。 如果 treatFailureAsDeploymentFailure 設為 true，腳本中的任何失敗都會失敗，且 ProvisioningState 會標示為 Failed。 如果 treatFailureAsDeploymentFailure 設為 false，ProvisioningState 只會反映執行命令是否由延伸模組平台執行，而不會指出腳本失敗時是否失敗。 查看執行命令的實例檢視，以防腳本失敗，查看executionMessage、輸出、錯誤：https://aka.ms/runcommandmanaged#get-execution-status-and-results 注意：此屬性將不會串行化。 它只能由伺服器填入。
runAsPassword	在執行執行命令時，指定 VM 上的使用者帳戶密碼。
runAsUser	在執行執行命令時，指定 VM 上的用戶帳戶。
source	執行命令腳本的來源。
timeoutInSeconds	執行命令的逾時以秒為單位。
treatFailureAsDeploymentFailure	自選。 如果設定為 true，腳本中的任何失敗都會失敗，且 ProvisioningState 會標示為 Failed。 如果設定為 false，ProvisioningState 只會反映延伸模組平臺是否執行 run 命令，它不會指出腳本在腳本失敗時是否失敗。 在腳本失敗時查看 run 命令的實例檢視，以查看 executionMessage、輸出、錯誤：https://aka.ms/runcommandmanaged#get-execution-status-and-results

繼承的屬性

id	資源標識碼注意：此屬性不會串行化。 它只能由伺服器填入。
location	資源位置
name	資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。
tags	資源標籤
type	資源類型注意：此屬性不會串行化。 它只能由伺服器填入。

屬性詳細資料

asyncExecution

自選。 如果設定為 true，則一開始腳本就會完成布建，且不會等待腳本完成。

asyncExecution?: boolean

屬性值

boolean

errorBlobManagedIdentity

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

errorBlobManagedIdentity?: RunCommandManagedIdentity

屬性值

RunCommandManagedIdentity

errorBlobUri

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

errorBlobUri?: string

屬性值

string

instanceView

虛擬機執行命令實例檢視。 注意：這個屬性不會串行化。 它只能由伺服器填入。

instanceView?: VirtualMachineRunCommandInstanceView

屬性值

VirtualMachineRunCommandInstanceView

outputBlobManagedIdentity

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

outputBlobManagedIdentity?: RunCommandManagedIdentity

屬性值

RunCommandManagedIdentity

outputBlobUri

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

outputBlobUri?: string

屬性值

string

parameters

腳本所使用的參數。

parameters?: RunCommandInputParameter[]

屬性值

RunCommandInputParameter[]

protectedParameters

腳本所使用的參數。

protectedParameters?: RunCommandInputParameter[]

屬性值

RunCommandInputParameter[]

provisioningState

只出現在回應中的布建狀態。 如果 treatFailureAsDeploymentFailure 設為 true，腳本中的任何失敗都會失敗，且 ProvisioningState 會標示為 Failed。 如果 treatFailureAsDeploymentFailure 設為 false，ProvisioningState 只會反映執行命令是否由延伸模組平台執行，而不會指出腳本失敗時是否失敗。 查看執行命令的實例檢視，以防腳本失敗，查看executionMessage、輸出、錯誤：https://aka.ms/runcommandmanaged#get-execution-status-and-results 注意：此屬性將不會串行化。 它只能由伺服器填入。

provisioningState?: string

屬性值

string

runAsPassword

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

runAsPassword?: string

屬性值

string

runAsUser

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

runAsUser?: string

屬性值

string

source

執行命令腳本的來源。

source?: VirtualMachineRunCommandScriptSource

屬性值

VirtualMachineRunCommandScriptSource

timeoutInSeconds

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

timeoutInSeconds?: number

屬性值

number

treatFailureAsDeploymentFailure

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

treatFailureAsDeploymentFailure?: boolean

屬性值

boolean

繼承的屬性詳細資料

id

資源標識碼注意：此屬性不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自Resource.id

location

資源位置

location: string

屬性值

string

繼承自Resource.location

name

資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自Resource.name

tags

資源標籤

tags?: {[propertyName: string]: string}

屬性值

{[propertyName: string]: string}

繼承自Resource.tags

type

資源類型注意：此屬性不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自Resource.type