Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2023-07-01

發行項
03/13/2024

Bicep 資源定義

virtualMachineScaleSets/virtualMachines/runCommands 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄。

資源格式

若要建立 Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-07-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    asyncExecution: bool
    errorBlobManagedIdentity: {
      clientId: 'string'
      objectId: 'string'
    }
    errorBlobUri: 'string'
    outputBlobManagedIdentity: {
      clientId: 'string'
      objectId: 'string'
    }
    outputBlobUri: 'string'
    parameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    protectedParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    runAsPassword: 'string'
    runAsUser: 'string'
    source: {
      commandId: 'string'
      script: 'string'
      scriptUri: 'string'
      scriptUriManagedIdentity: {
        clientId: 'string'
        objectId: 'string'
      }
    }
    timeoutInSeconds: int
    treatFailureAsDeploymentFailure: bool
  }
}

屬性值

virtualMachineScaleSets/virtualMachines/runCommands

名稱	描述	值
NAME	資源名稱瞭解如何在 Bicep 中設定子資源的名稱和類型。	字串 (必要)
location	資源位置	字串 (必要)
tags	資源標籤	標記名稱和值的字典。請參閱範本中的標記
父系 (parent)	在 Bicep 中，您可以指定子資源的父資源。只有在父資源之外宣告子資源時，才需要新增這個屬性。如需詳細資訊，請參閱父資源外部的子資源。	類型資源的符號名稱： virtualMachines
properties	描述虛擬機執行命令的屬性。	VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

名稱	描述	值
asyncExecution	選擇性。如果設定為 true，布建會在腳本啟動時立即完成，且不會等待腳本完成。	bool
errorBlobManagedIdentity	具有 errorBlobUri 記憶體 Blob 存取權的使用者指派受控識別。如果是系統指派的身分識別，請使用空白物件。請確定受控識別已獲授與具有「記憶體 Blob 數據參與者」角色指派之 Blob 容器的存取權。如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。如需受控識別和執行命令的詳細資訊，請參閱 `https://aka.ms/ManagedIdentity` 和 `https://aka.ms/RunCommandManaged`	RunCommandManagedIdentity
errorBlobUri	指定將上傳文稿錯誤數據流的 Azure 記憶體 Blob。使用具有讀取、附加、建立、寫入存取權的SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。請參閱 errorBlobManagedIdentity 參數。	字串
outputBlobManagedIdentity	可存取 outputBlobUri 記憶體 Blob 的使用者指派受控識別。如果是系統指派的身分識別，請使用空白物件。請確定受控識別已獲授與具有「記憶體 Blob 數據參與者」角色指派之 Blob 容器的存取權。如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。如需受控識別和執行命令的詳細資訊，請參閱 `https://aka.ms/ManagedIdentity` 和 `https://aka.ms/RunCommandManaged`	RunCommandManagedIdentity
outputBlobUri	指定將上傳文本輸出數據流的 Azure 記憶體 Blob。使用具有讀取、附加、建立、寫入存取權的SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。請參閱 outputBlobManagedIdentity 參數。	字串
參數	腳本所使用的參數。	RunCommandInputParameter[]
protectedParameters	腳本所使用的參數。	RunCommandInputParameter[]
runAsPassword	在執行執行命令時，指定 VM 上的使用者帳戶密碼。	字串
runAsUser	在執行執行命令時，指定 VM 上的用戶帳戶。	字串
source	執行命令腳本的來源。	VirtualMachineRunCommandScriptSource
timeoutInSeconds	執行執行命令的逾時以秒為單位。	int
treatFailureAsDeploymentFailure	選擇性。如果設定為 true，腳本中的任何失敗都會失敗部署，且 ProvisioningState 會標示為 [失敗]。如果設定為 false，ProvisioningState 只會反映延伸模組平臺是否執行命令，它不會指出腳本在腳本失敗時是否失敗。如果腳本失敗，請參閱 run 命令的實例檢視，以查看 executionMessage、輸出、錯誤： `https://aka.ms/runcommandmanaged#get-execution-status-and-results`	bool

RunCommandManagedIdentity

名稱	描述	值
clientId	用戶端識別碼 (用戶指派受控識別的 GUID 值) 。如果提供此專案，則不應該使用 ObjectId。	字串
objectId	物件標識碼 (使用者指派受控識別的 GUID 值) 。如果提供此專案，則不應該使用 ClientId。	字串

RunCommandInputParameter

名稱	描述	值
NAME	執行命令參數名稱。	字串 (必要)
值	run 命令參數值。	字串 (必要)

VirtualMachineRunCommandScriptSource

名稱	描述	值
commandId	指定預先定義內建腳本的 commandId。	字串
指令碼	指定要在 VM 上執行的文稿內容。	字串
scriptUri	指定文稿下載位置。它可以是具有讀取許可權或公用 URI 的 Azure 記憶體 Blob SAS URI。	字串
scriptUriManagedIdentity	在 Azure 記憶體 Blob 的情況下，具有 scriptUri 存取權的使用者指派受控識別。如果是系統指派的身分識別，請使用空白物件。請確定 Azure 記憶體 Blob 存在，且受控識別已獲授與具有「記憶體 Blob 數據讀取者」角色指派之 Blob 容器的存取權。如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。如需受控識別和執行命令的詳細資訊，請參閱 `https://aka.ms/ManagedIdentity` 和 `https://aka.ms/RunCommandManaged.`	RunCommandManagedIdentity

ARM 範本資源定義

virtualMachineScaleSets/virtualMachines/runCommands 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄。

資源格式

若要建立 Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "apiVersion": "2023-07-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "asyncExecution": "bool",
    "errorBlobManagedIdentity": {
      "clientId": "string",
      "objectId": "string"
    },
    "errorBlobUri": "string",
    "outputBlobManagedIdentity": {
      "clientId": "string",
      "objectId": "string"
    },
    "outputBlobUri": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "protectedParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "runAsPassword": "string",
    "runAsUser": "string",
    "source": {
      "commandId": "string",
      "script": "string",
      "scriptUri": "string",
      "scriptUriManagedIdentity": {
        "clientId": "string",
        "objectId": "string"
      }
    },
    "timeoutInSeconds": "int",
    "treatFailureAsDeploymentFailure": "bool"
  }
}

屬性值

virtualMachineScaleSets/virtualMachines/runCommands

名稱	描述	值
類型	資源類型	'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands'
apiVersion	資源 API 版本	'2023-07-01'
NAME	資源名稱請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。	字串 (必要)
location	資源位置	字串 (必要)
tags	資源標籤	標記名稱和值的字典。請參閱範本中的標記
properties	描述虛擬機執行命令的屬性。	VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

名稱	描述	值
asyncExecution	選擇性。如果設定為 true，布建會在腳本啟動時立即完成，且不會等待腳本完成。	bool
errorBlobManagedIdentity	具有 errorBlobUri 記憶體 Blob 存取權的使用者指派受控識別。如果是系統指派的身分識別，請使用空白物件。請確定受控識別已獲授與具有「記憶體 Blob 數據參與者」角色指派之 Blob 容器的存取權。如果是使用者指派的身分識別，請務必將其新增到 VM 的身分識別之下。如需受控識別和執行命令的詳細資訊，請參閱 `https://aka.ms/ManagedIdentity` 和 `https://aka.ms/RunCommandManaged`	RunCommandManagedIdentity
errorBlobUri	指定將上傳文稿錯誤數據流的 Azure 記憶體 Blob。使用具有讀取、附加、建立、寫入存取權的SAS URI，或使用受控識別來提供 Blob 的 VM 存取權。請參閱 errorBlobManagedIdentity 參數。	字串
outputBlobManagedIdentity	可存取 outputBlobUri 記憶體 Blob 的使用者指派受控識別。如果是系統指派的身分識別，請使用空白物件。請確定受控識別已獲授與具有「記憶體 Blob 數據參與者」角色指派之 Blob 容器的存取權。如果是使用者指派的身分識別，請務必在 VM 的身分識別下新增。如需受控識別和執行命令的詳細資訊，請參閱 `https://aka.ms/ManagedIdentity` 和 `https://aka.ms/RunCommandManaged`	RunCommandManagedIdentity
outputBlobUri	指定將上傳文本輸出數據流的 Azure 記憶體 Blob。使用SAS URI搭配讀取、附加、建立、寫入存取或使用受控識別來提供 Blob 的 VM 存取權。請參閱 outputBlobManagedIdentity 參數。	字串
參數	腳本所使用的參數。	RunCommandInputParameter[]
protectedParameters	腳本所使用的參數。	RunCommandInputParameter[]
runAsPassword	在執行執行命令時，指定 VM 上的使用者帳戶密碼。	字串
runAsUser	在執行執行命令時，指定 VM 上的用戶帳戶。	字串
source	執行命令腳本的來源。	VirtualMachineRunCommandScriptSource
timeoutInSeconds	執行執行命令的逾時以秒為單位。	int
treatFailureAsDeploymentFailure	選擇性。如果設定為 true，腳本中的任何失敗都會失敗部署，且 ProvisioningState 會標示為失敗。如果設定為 false，ProvisioningState 只會反映執行命令是否由延伸模組平台執行，它不會指出腳本在腳本失敗時是否失敗。請參閱 run 命令的實例檢視，以防腳本失敗，以查看 executionMessage、output、error： `https://aka.ms/runcommandmanaged#get-execution-status-and-results`	bool

RunCommandManagedIdentity

名稱	描述	值
clientId	用戶端識別碼 (用戶指派受控識別的 GUID 值) 。如果提供這個，就不應該使用 ObjectId。	字串
objectId	物件標識碼 (使用者指派受控識別) GUID 值。如果提供這個，則不應該使用 ClientId。	字串

RunCommandInputParameter

名稱	描述	值
NAME	執行命令參數名稱。	需要字串 ()
值	run 命令參數值。	需要字串 ()

VirtualMachineRunCommandScriptSource

名稱	描述	值
commandId	指定預先定義內建腳本的 commandId。	字串
指令碼	指定要在 VM 上執行的文稿內容。	字串
scriptUri	指定文稿下載位置。它可以是具有讀取許可權或公用 URI 的 Azure 記憶體 Blob SAS URI。	字串
scriptUriManagedIdentity	使用者指派的受控識別，在 Azure 記憶體 Blob 的情況下可存取 scriptUri。如果是系統指派的身分識別，請使用空白物件。請確定 Azure 記憶體 Blob 存在，且受控識別已獲授與具有「記憶體 Blob 數據讀取者」角色指派之 Blob 容器的存取權。如果是使用者指派的身分識別，請務必在 VM 的身分識別下新增。如需受控識別和執行命令的詳細資訊，請參閱 `https://aka.ms/ManagedIdentity` 和 `https://aka.ms/RunCommandManaged.`	RunCommandManagedIdentity

Terraform (AzAPI 提供者) 資源定義

virtualMachineScaleSets/virtualMachines/runCommands 資源類型可以使用目標作業來部署：

資源群組

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-07-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      asyncExecution = bool
      errorBlobManagedIdentity = {
        clientId = "string"
        objectId = "string"
      }
      errorBlobUri = "string"
      outputBlobManagedIdentity = {
        clientId = "string"
        objectId = "string"
      }
      outputBlobUri = "string"
      parameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      protectedParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      runAsPassword = "string"
      runAsUser = "string"
      source = {
        commandId = "string"
        script = "string"
        scriptUri = "string"
        scriptUriManagedIdentity = {
          clientId = "string"
          objectId = "string"
        }
      }
      timeoutInSeconds = int
      treatFailureAsDeploymentFailure = bool
    }
  })
}

屬性值

virtualMachineScaleSets/virtualMachines/runCommands

名稱	描述	值
類型	資源類型	“Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-07-01”
NAME	資源名稱	需要字串 ()
location	資源位置	需要字串 ()
parent_id	此資源父系之資源的標識碼。	類型資源的標識碼： virtualMachines
tags	資源標籤	標記名稱和值的字典。
properties	描述虛擬機執行命令的屬性。	VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

名稱	描述	值
asyncExecution	選擇性。如果設定為 true，布建會在腳本啟動時立即完成，且不會等待腳本完成。	bool
errorBlobManagedIdentity	使用者指派的受控識別，可存取 errorBlobUri 記憶體 Blob。如果是系統指派的身分識別，請使用空白物件。請確定受控識別已獲得 Blob 容器的存取權，並具有「記憶體 Blob 數據參與者」角色指派。如果是使用者指派的身分識別，請務必在 VM 的身分識別下新增。如需受控識別和執行命令的詳細資訊，請參閱 `https://aka.ms/ManagedIdentity` 和 `https://aka.ms/RunCommandManaged`	RunCommandManagedIdentity
errorBlobUri	指定將上傳文稿錯誤數據流的 Azure 記憶體 Blob。使用SAS URI搭配讀取、附加、建立、寫入存取或使用受控識別來提供 Blob 的 VM 存取權。請參閱 errorBlobManagedIdentity 參數。	字串
outputBlobManagedIdentity	使用者指派的受控識別，可存取 outputBlobUri 記憶體 Blob。如果是系統指派的身分識別，請使用空白物件。請確定受控識別已獲得 Blob 容器的存取權，並具有「記憶體 Blob 數據參與者」角色指派。如果是使用者指派的身分識別，請務必在 VM 的身分識別下新增。如需受控識別和執行命令的詳細資訊，請參閱 `https://aka.ms/ManagedIdentity` 和 `https://aka.ms/RunCommandManaged`	RunCommandManagedIdentity
outputBlobUri	指定將上傳文本輸出數據流的 Azure 記憶體 Blob。使用SAS URI搭配讀取、附加、建立、寫入存取或使用受控識別來提供 Blob 的 VM 存取權。請參閱 outputBlobManagedIdentity 參數。	字串
參數	腳本所使用的參數。	RunCommandInputParameter[]
protectedParameters	腳本所使用的參數。	RunCommandInputParameter[]
runAsPassword	在執行執行命令時，指定 VM 上的使用者帳戶密碼。	字串
runAsUser	在執行執行命令時，指定 VM 上的用戶帳戶。	字串
source	執行命令腳本的來源。	VirtualMachineRunCommandScriptSource
timeoutInSeconds	執行執行命令的逾時以秒為單位。	int
treatFailureAsDeploymentFailure	選擇性。如果設定為 true，腳本中的任何失敗都會失敗部署，且 ProvisioningState 會標示為失敗。如果設定為 false，ProvisioningState 只會反映執行命令是否由延伸模組平台執行，它不會指出腳本在腳本失敗時是否失敗。請參閱 run 命令的實例檢視，以防腳本失敗，以查看 executionMessage、output、error： `https://aka.ms/runcommandmanaged#get-execution-status-and-results`	bool

RunCommandManagedIdentity

名稱	描述	值
clientId	用戶端識別碼 (用戶指派受控識別的 GUID 值) 。如果提供這個，就不應該使用 ObjectId。	字串
objectId	物件標識碼 (使用者指派受控識別) GUID 值。如果提供這個，則不應該使用 ClientId。	字串

RunCommandInputParameter

名稱	描述	值
NAME	執行命令參數名稱。	需要字串 ()
值	run 命令參數值。	需要字串 ()

VirtualMachineRunCommandScriptSource

名稱	描述	值
commandId	指定預先定義內建腳本的 commandId。	字串
指令碼	指定要在 VM 上執行的文稿內容。	字串
scriptUri	指定文稿下載位置。它可以是具有讀取許可權或公用 URI 的 Azure 記憶體 Blob SAS URI。	字串
scriptUriManagedIdentity	使用者指派的受控識別，在 Azure 記憶體 Blob 的情況下可存取 scriptUri。如果是系統指派的身分識別，請使用空白物件。請確定 Azure 記憶體 Blob 存在，且受控識別已獲授與具有「記憶體 Blob 數據讀取者」角色指派之 Blob 容器的存取權。如果是使用者指派的身分識別，請務必在 VM 的身分識別下新增。如需受控識別和執行命令的詳細資訊，請參閱 `https://aka.ms/ManagedIdentity` 和 `https://aka.ms/RunCommandManaged.`	RunCommandManagedIdentity

共用方式為

Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2023-07-01

Bicep 資源定義

資源格式

屬性值

virtualMachineScaleSets/virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

ARM 範本資源定義

資源格式

屬性值

virtualMachineScaleSets/virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

Terraform (AzAPI 提供者) 資源定義

資源格式

屬性值

virtualMachineScaleSets/virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

意見反應

意見反應

其他資源