Microsoft.Compute virtualMachines/runCommands 2021-04-01

• 最新
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01

Bicep 資源定義

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

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

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

資源格式

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

resource symbolicname 'Microsoft.Compute/virtualMachines/runCommands@2021-04-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
  }
}

屬性值

virtualMachines/runCommands

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

VirtualMachineRunCommandProperties

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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

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

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
SharePoint 訂閱 / 2019 / 2016 / 2013 已設定	此範本會建立 SharePoint 訂閱 / 2019 / 2016 / 2013 伺服器陣列，其中包含需要大量設定才能手動執行，包括使用 ADFS 的同盟驗證、OAuth 信任、User Profiles 服務和包含 2 個區域且包含多個路徑型和主機命名網站集合的 Web 應用程式。 在 SharePoint 虛擬機上，Chocolatey 是用來安裝最新版本的記事本++、Visual Studio Code、Azure Data Studio、Fiddler、ULS Viewer 和 7-Zip。

ARM 範本資源定義

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

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

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

資源格式

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

{
  "type": "Microsoft.Compute/virtualMachines/runCommands",
  "apiVersion": "2021-04-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"
  }
}

屬性值

virtualMachines/runCommands

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

VirtualMachineRunCommandProperties

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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

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

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
SharePoint 訂閱 / 2019 / 2016 / 2013 已設定	此範本會建立 SharePoint 訂閱 / 2019 / 2016 / 2013 伺服器陣列，其中包含需要大量設定才能手動執行，包括使用 ADFS 的同盟驗證、OAuth 信任、User Profiles 服務和包含 2 個區域且包含多個路徑型和主機命名網站集合的 Web 應用程式。 在 SharePoint 虛擬機上，Chocolatey 是用來安裝最新版本的記事本++、Visual Studio Code、Azure Data Studio、Fiddler、ULS Viewer 和 7-Zip。

Terraform (AzAPI 提供者) 資源定義

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

• 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/runCommands@2021-04-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
    }
  })
}

屬性值

virtualMachines/runCommands

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

VirtualMachineRunCommandProperties

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

RunCommandInputParameter

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

VirtualMachineRunCommandScriptSource

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