Microsoft.Compute/virtualMachines/runCommands 2023-03-01 - Bicep, ARM template & Terraform AzAPI reference

Bicep 資源定義

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

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

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

資源格式

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

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

屬性值

virtualMachines/runCommands

名字	描述	價值
名字	資源名稱請參閱如何在 Bicep 中設定子資源的名稱和類型。	字串（必要）
位置	資源位置	字串（必要）
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
父母	在 Bicep 中，您可以指定子資源的父資源。只有在父資源外部宣告子資源時，才需要新增這個屬性。如需詳細資訊，請參閱父資源外部的子資源。	類型資源的符號名稱：virtualMachines
性能	描述虛擬機執行命令的屬性。	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 上的用戶帳戶。	字串
源	執行命令腳本的來源。	VirtualMachineRunCommandScriptSource
timeoutInSeconds	執行命令的逾時以秒為單位。	int
treatFailureAsDeploymentFailure	自選。如果設定為 true，腳本中的任何失敗都會失敗，且 ProvisioningState 會標示為 Failed。如果設定為 false，ProvisioningState 只會反映延伸模組平臺是否執行 run 命令，它不會指出腳本在腳本失敗時是否失敗。在腳本失敗時查看 run 命令的實例檢視，以查看 executionMessage、輸出、錯誤：`https://aka.ms/runcommandmanaged#get-execution-status-and-results`	bool

RunCommandManagedIdentity

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

RunCommandInputParameter

名字	描述	價值
名字	執行命令參數名稱。	字串（必要）
價值	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

快速入門範本

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

範本	描述
SharePoint 訂閱 / 2019 / 2016 完整設定	建立 DC、SQL Server 2022，以及從 1 到 5 部伺服器（s）裝載 SharePoint 訂閱 /2019 / 2016 伺服器數位，其中包含廣泛的設定，包括受信任的驗證、具有個人網站的使用者配置檔、OAuth 信任（使用憑證）、裝載高信任載入巨集的專用 IIS 網站等等...已安裝最新版本的密鑰軟體（包括 Fiddler、vscode、np++、7zip、ULS Viewer）。 SharePoint 機器有額外的微調，使其立即可供使用（遠端管理工具、Edge 和 Chrome 的自定義原則、快捷方式等等...）。
GitLab Omnibus	此範本可簡化使用公用 DNS 在虛擬機上部署 GitLab Omnibus，並利用公用 IP 的 DNS。它會使用Standard_F8s_v2實例大小，其與參考架構一致，且最多可支援1000位使用者（20 RPS）。實例已預先設定為搭配使用 HTTPS 與 Let's Encrypt 憑證進行安全連線。

範本

描述

SharePoint 訂閱 / 2019 / 2016 完整設定

建立 DC、SQL Server 2022，以及從 1 到 5 部伺服器（s）裝載 SharePoint 訂閱 /2019 / 2016 伺服器數位，其中包含廣泛的設定，包括受信任的驗證、具有個人網站的使用者配置檔、OAuth 信任（使用憑證）、裝載高信任載入巨集的專用 IIS 網站等等...已安裝最新版本的密鑰軟體（包括 Fiddler、vscode、np++、7zip、ULS Viewer）。 SharePoint 機器有額外的微調，使其立即可供使用（遠端管理工具、Edge 和 Chrome 的自定義原則、快捷方式等等...）。

GitLab Omnibus

此範本可簡化使用公用 DNS 在虛擬機上部署 GitLab Omnibus，並利用公用 IP 的 DNS。它會使用Standard_F8s_v2實例大小，其與參考架構一致，且最多可支援1000位使用者（20 RPS）。實例已預先設定為搭配使用 HTTPS 與 Let's Encrypt 憑證進行安全連線。

ARM 樣本資源定義

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

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

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

資源格式

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

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

屬性值

virtualMachines/runCommands

名字	描述	價值
類型	資源類型	'Microsoft.Compute/virtualMachines/runCommands'
apiVersion	資源 API 版本	'2023-03-01'
名字	資源名稱請參閱如何在JSON ARM 範本中設定子資源的名稱和類型。	字串（必要）
位置	資源位置	字串（必要）
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
性能	描述虛擬機執行命令的屬性。	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 上的用戶帳戶。	字串
源	執行命令腳本的來源。	VirtualMachineRunCommandScriptSource
timeoutInSeconds	執行命令的逾時以秒為單位。	int
treatFailureAsDeploymentFailure	自選。如果設定為 true，腳本中的任何失敗都會失敗，且 ProvisioningState 會標示為 Failed。如果設定為 false，ProvisioningState 只會反映延伸模組平臺是否執行 run 命令，它不會指出腳本在腳本失敗時是否失敗。在腳本失敗時查看 run 命令的實例檢視，以查看 executionMessage、輸出、錯誤：`https://aka.ms/runcommandmanaged#get-execution-status-and-results`	bool

RunCommandManagedIdentity

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

RunCommandInputParameter

名字	描述	價值
名字	執行命令參數名稱。	字串（必要）
價值	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

快速入門範本

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

範本	描述
SharePoint 訂閱 / 2019 / 2016 完整設定	建立 DC、SQL Server 2022，以及從 1 到 5 部伺服器（s）裝載 SharePoint 訂閱 /2019 / 2016 伺服器數位，其中包含廣泛的設定，包括受信任的驗證、具有個人網站的使用者配置檔、OAuth 信任（使用憑證）、裝載高信任載入巨集的專用 IIS 網站等等...已安裝最新版本的密鑰軟體（包括 Fiddler、vscode、np++、7zip、ULS Viewer）。 SharePoint 機器有額外的微調，使其立即可供使用（遠端管理工具、Edge 和 Chrome 的自定義原則、快捷方式等等...）。
GitLab Omnibus	此範本可簡化使用公用 DNS 在虛擬機上部署 GitLab Omnibus，並利用公用 IP 的 DNS。它會使用Standard_F8s_v2實例大小，其與參考架構一致，且最多可支援1000位使用者（20 RPS）。實例已預先設定為搭配使用 HTTPS 與 Let's Encrypt 憑證進行安全連線。

範本

描述

SharePoint 訂閱 / 2019 / 2016 完整設定

建立 DC、SQL Server 2022，以及從 1 到 5 部伺服器（s）裝載 SharePoint 訂閱 /2019 / 2016 伺服器數位，其中包含廣泛的設定，包括受信任的驗證、具有個人網站的使用者配置檔、OAuth 信任（使用憑證）、裝載高信任載入巨集的專用 IIS 網站等等...已安裝最新版本的密鑰軟體（包括 Fiddler、vscode、np++、7zip、ULS Viewer）。 SharePoint 機器有額外的微調，使其立即可供使用（遠端管理工具、Edge 和 Chrome 的自定義原則、快捷方式等等...）。

GitLab Omnibus

此範本可簡化使用公用 DNS 在虛擬機上部署 GitLab Omnibus，並利用公用 IP 的 DNS。它會使用Standard_F8s_v2實例大小，其與參考架構一致，且最多可支援1000位使用者（20 RPS）。實例已預先設定為搭配使用 HTTPS 與 Let's Encrypt 憑證進行安全連線。

Terraform （AzAPI 提供者）資源定義

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

資源群組

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

資源格式

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

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

屬性值

virtualMachines/runCommands

名字	描述	價值
類型	資源類型	“Microsoft.Compute/virtualMachines/runCommands@2023-03-01”
名字	資源名稱	字串（必要）
位置	資源位置	字串（必要）
parent_id	此資源為父系之資源的標識碼。	類型資源的標識碼：virtualMachines
標籤	資源標籤	標記名稱和值的字典。
性能	描述虛擬機執行命令的屬性。	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 上的用戶帳戶。	字串
源	執行命令腳本的來源。	VirtualMachineRunCommandScriptSource
timeoutInSeconds	執行命令的逾時以秒為單位。	int
treatFailureAsDeploymentFailure	自選。如果設定為 true，腳本中的任何失敗都會失敗，且 ProvisioningState 會標示為 Failed。如果設定為 false，ProvisioningState 只會反映延伸模組平臺是否執行 run 命令，它不會指出腳本在腳本失敗時是否失敗。在腳本失敗時查看 run 命令的實例檢視，以查看 executionMessage、輸出、錯誤：`https://aka.ms/runcommandmanaged#get-execution-status-and-results`	bool

RunCommandManagedIdentity

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

RunCommandInputParameter

名字	描述	價值
名字	執行命令參數名稱。	字串（必要）
價值	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 virtualMachines/runCommands 2023-03-01

Bicep 資源定義

資源格式

屬性值

virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

快速入門範本

ARM 樣本資源定義

資源格式

屬性值

virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

快速入門範本

Terraform （AzAPI 提供者）資源定義

資源格式

屬性值

virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

意見反應

其他資源

共用方式為

Microsoft.Compute virtualMachines/runCommands 2023-03-01

Bicep 資源定義

資源格式

屬性值

virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

快速入門範本

ARM 樣本資源定義

資源格式

屬性值

virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

virtualMachines/runCommands

VirtualMachineRunCommandProperties

RunCommandManagedIdentity

RunCommandInputParameter

VirtualMachineRunCommandScriptSource

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義