你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2023-07-01
Bicep 资源定义
可以使用目标操作部署 virtualMachineScaleSets/virtualMachines/runCommands 资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-07-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
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
}
tags: {
{customized property}: 'string'
}
}
属性值
Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands
| 名字 |
描述 |
价值 |
| 名字 |
run 命令参数名称。 |
string （必需） |
| 价值 |
run 命令参数值。 |
string （必需） |
RunCommandManagedIdentity
| 名字 |
描述 |
价值 |
| clientId |
用户分配的托管标识的客户端 ID （GUID 值）。 如果未提供，则不应使用 ObjectId。 |
字符串 |
| objectId |
用户分配的托管标识的对象 ID （GUID 值）。 如果未提供，则不应使用 ClientId。 |
字符串 |
VirtualMachineRunCommandProperties
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",
"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"
},
"tags": {
"{customized property}": "string"
}
}
属性值
Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands
| 名字 |
描述 |
价值 |
| apiVersion |
API 版本 |
'2023-07-01' |
| 位置 |
资源位置 |
string （必需） |
| 名字 |
资源名称 |
string （必需） |
| 性能 |
描述虚拟机运行命令的属性。 |
VirtualMachineRunCommandProperties |
| 标签 |
资源标记 |
标记名称和值的字典。 请参阅模板 中的 标记 |
| 类型 |
资源类型 |
“Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands” |
| 名字 |
描述 |
价值 |
| 名字 |
run 命令参数名称。 |
string （必需） |
| 价值 |
run 命令参数值。 |
string （必需） |
RunCommandManagedIdentity
| 名字 |
描述 |
价值 |
| clientId |
用户分配的托管标识的客户端 ID （GUID 值）。 如果未提供，则不应使用 ObjectId。 |
字符串 |
| objectId |
用户分配的托管标识的对象 ID （GUID 值）。 如果未提供，则不应使用 ClientId。 |
字符串 |
VirtualMachineRunCommandProperties
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 |
可以使用目标操作部署 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"
tags = {
{customized property} = "string"
}
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
}
})
}
属性值
Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands
| 名字 |
描述 |
价值 |
| 名字 |
run 命令参数名称。 |
string （必需） |
| 价值 |
run 命令参数值。 |
string （必需） |
RunCommandManagedIdentity
| 名字 |
描述 |
价值 |
| clientId |
用户分配的托管标识的客户端 ID （GUID 值）。 如果未提供，则不应使用 ObjectId。 |
字符串 |
| objectId |
用户分配的托管标识的对象 ID （GUID 值）。 如果未提供，则不应使用 ClientId。 |
字符串 |
VirtualMachineRunCommandProperties
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 |