共用方式為

Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2021-03-01

  • 發行項

Bicep 資源定義

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

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

資源格式

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

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

屬性值

virtualMachineScaleSets/virtualMachines/runCommands

名字 描述 價值
名字 資源名稱

請參閱如何在 Bicep 中設定子資源的名稱和類型。		 字串 （必要）
位置 資源位置 字串 （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱：virtualMachines
性能 描述虛擬機執行命令的屬性。 VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

名字 描述 價值
asyncExecution 自選。 如果設定為 true，則一開始腳本就會完成布建，且不會等待腳本完成。 bool
errorBlobUri 指定將上傳文稿錯誤數據流的 Azure 記憶體 Blob。 字串
outputBlobUri 指定將上傳文本輸出數據流的 Azure 記憶體 Blob。 字串
參數 腳本所使用的參數。 RunCommandInputParameter[]
protectedParameters 腳本所使用的參數。 RunCommandInputParameter[]
runAsPassword 在執行執行命令時，指定 VM 上的使用者帳戶密碼。 字串
runAsUser 在執行執行命令時，指定 VM 上的用戶帳戶。 字串
源 執行命令腳本的來源。 VirtualMachineRunCommandScriptSource
timeoutInSeconds 執行命令的逾時以秒為單位。 int

RunCommandInputParameter

名字 描述 價值
名字 執行命令參數名稱。 字串 （必要）
價值 run 命令參數值。 字串 （必要）

VirtualMachineRunCommandScriptSource

名字 描述 價值
commandId 指定預先定義內建腳本的 commandId。 字串
腳本 指定要在 VM 上執行的文稿內容。 字串
scriptUri 指定文稿下載位置。 字串

ARM 樣本資源定義

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

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

資源格式

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

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

屬性值

virtualMachineScaleSets/virtualMachines/runCommands

名字 描述 價值
類型 資源類型 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands'
apiVersion 資源 API 版本 '2021-03-01'
名字 資源名稱

請參閱如何在JSON ARM 範本中設定子資源的名稱和類型。		 字串 （必要）
位置 資源位置 字串 （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
性能 描述虛擬機執行命令的屬性。 VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

名字 描述 價值
asyncExecution 自選。 如果設定為 true，則一開始腳本就會完成布建，且不會等待腳本完成。 bool
errorBlobUri 指定將上傳文稿錯誤數據流的 Azure 記憶體 Blob。 字串
outputBlobUri 指定將上傳文本輸出數據流的 Azure 記憶體 Blob。 字串
參數 腳本所使用的參數。 RunCommandInputParameter[]
protectedParameters 腳本所使用的參數。 RunCommandInputParameter[]
runAsPassword 在執行執行命令時，指定 VM 上的使用者帳戶密碼。 字串
runAsUser 在執行執行命令時，指定 VM 上的用戶帳戶。 字串
源 執行命令腳本的來源。 VirtualMachineRunCommandScriptSource
timeoutInSeconds 執行命令的逾時以秒為單位。 int

RunCommandInputParameter

名字 描述 價值
名字 執行命令參數名稱。 字串 （必要）
價值 run 命令參數值。 字串 （必要）

VirtualMachineRunCommandScriptSource

名字 描述 價值
commandId 指定預先定義內建腳本的 commandId。 字串
腳本 指定要在 VM 上執行的文稿內容。 字串
scriptUri 指定文稿下載位置。 字串

Terraform （AzAPI 提供者） 資源定義

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

  • 資源群組

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

資源格式

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

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

屬性值

virtualMachineScaleSets/virtualMachines/runCommands

名字 描述 價值
類型 資源類型 “Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-03-01”
名字 資源名稱 字串 （必要）
位置 資源位置 字串 （必要）
parent_id 此資源為父系之資源的標識碼。 類型資源的標識碼：virtualMachines
標籤 資源標籤 標記名稱和值的字典。
性能 描述虛擬機執行命令的屬性。 VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

名字 描述 價值
asyncExecution 自選。 如果設定為 true，則一開始腳本就會完成布建，且不會等待腳本完成。 bool
errorBlobUri 指定將上傳文稿錯誤數據流的 Azure 記憶體 Blob。 字串
outputBlobUri 指定將上傳文本輸出數據流的 Azure 記憶體 Blob。 字串
參數 腳本所使用的參數。 RunCommandInputParameter[]
protectedParameters 腳本所使用的參數。 RunCommandInputParameter[]
runAsPassword 在執行執行命令時，指定 VM 上的使用者帳戶密碼。 字串
runAsUser 在執行執行命令時，指定 VM 上的用戶帳戶。 字串
源 執行命令腳本的來源。 VirtualMachineRunCommandScriptSource
timeoutInSeconds 執行命令的逾時以秒為單位。 int

RunCommandInputParameter

名字 描述 價值
名字 執行命令參數名稱。 字串 （必要）
價值 run 命令參數值。 字串 （必要）

VirtualMachineRunCommandScriptSource

名字 描述 價值
commandId 指定預先定義內建腳本的 commandId。 字串
腳本 指定要在 VM 上執行的文稿內容。 字串
scriptUri 指定文稿下載位置。 字串