Microsoft.Compute virtualMachines/runCommands 2025-04-01

Определение ресурсов Bicep

Тип ресурса virtualMachines/runCommands можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Compute/virtualMachines/runCommands, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.Compute/virtualMachines/runCommands@2025-04-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'
      galleryScriptReferenceId: 'string'
      script: 'string'
      scriptShell: 'string'
      scriptUri: 'string'
      scriptUriManagedIdentity: {
        clientId: 'string'
        objectId: 'string'
      }
    }
    timeoutInSeconds: int
    treatFailureAsDeploymentFailure: bool
  }
  tags: {
    {customized property}: 'string'
  }
}

Значения свойств

Microsoft.Compute/virtualMachines/runCommands

Параметр ввода RunCommandInput

RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)

Отслеживаемые Ресурсные Теги

VirtualMachineRunCommandProperties

VirtualMachineRunCommandScriptSource

Примеры использования

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Определение ресурса шаблона ARM

Тип ресурса virtualMachines/runCommands можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Compute/virtualMachines/runCommands, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Compute/virtualMachines/runCommands",
  "apiVersion": "2025-04-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",
      "galleryScriptReferenceId": "string",
      "script": "string",
      "scriptShell": "string",
      "scriptUri": "string",
      "scriptUriManagedIdentity": {
        "clientId": "string",
        "objectId": "string"
      }
    },
    "timeoutInSeconds": "int",
    "treatFailureAsDeploymentFailure": "bool"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Значения свойств

Microsoft.Compute/virtualMachines/runCommands

Параметр ввода RunCommandInput

RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)

Отслеживаемые Ресурсные Теги

VirtualMachineRunCommandProperties

VirtualMachineRunCommandScriptSource

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Template	Description
Омнибус GitLab	Этот шаблон упрощает развертывание GitLab Omnibus на виртуальной машине с общедоступным DNS, используя DNS общедоступного IP-адреса. Он использует размер 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@2025-04-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
        galleryScriptReferenceId = "string"
        script = "string"
        scriptShell = "string"
        scriptUri = "string"
        scriptUriManagedIdentity = {
          clientId = "string"
          objectId = "string"
        }
      }
      timeoutInSeconds = int
      treatFailureAsDeploymentFailure = bool
    }
  }
}

Значения свойств

Microsoft.Compute/virtualMachines/runCommands

Параметр ввода RunCommandInput

RunCommandManagedIdentity (ВыполнитьCommandManagedIdentity)

Отслеживаемые Ресурсные Теги

VirtualMachineRunCommandProperties

VirtualMachineRunCommandScriptSource

Примеры использования

Примеры Terraform

Простой пример развертывания команды Run Virtual Machine Run.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "eastus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "userAssignedIdentity" {
  type      = "Microsoft.ManagedIdentity/userAssignedIdentities@2023-01-31"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-uai"
  location  = var.location
}

resource "azapi_resource" "virtualNetwork" {
  type      = "Microsoft.Network/virtualNetworks@2024-05-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-vnet"
  location  = var.location
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = ["10.0.0.0/16"]
      }
      dhcpOptions = {
        dnsServers = []
      }
      privateEndpointVNetPolicies = "Disabled"
      subnets                     = []
    }
  }
}

resource "azapi_resource" "subnet" {
  type      = "Microsoft.Network/virtualNetworks/subnets@2024-05-01"
  parent_id = azapi_resource.virtualNetwork.id
  name      = "internal"
  body = {
    properties = {
      addressPrefix                     = "10.0.2.0/24"
      defaultOutboundAccess             = true
      delegations                       = []
      privateEndpointNetworkPolicies    = "Disabled"
      privateLinkServiceNetworkPolicies = "Enabled"
      serviceEndpointPolicies           = []
      serviceEndpoints                  = []
    }
  }
}

resource "azapi_resource" "networkInterface" {
  type      = "Microsoft.Network/networkInterfaces@2024-05-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-nic"
  location  = var.location
  body = {
    properties = {
      enableAcceleratedNetworking = false
      enableIPForwarding          = false
      ipConfigurations = [{
        name = "internal"
        properties = {
          primary                   = false
          privateIPAddressVersion   = "IPv4"
          privateIPAllocationMethod = "Dynamic"
          subnet = {
            id = azapi_resource.subnet.id
          }
        }
      }]
    }
  }
}

resource "azapi_resource" "virtualMachine" {
  type      = "Microsoft.Compute/virtualMachines@2024-03-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-vm"
  location  = var.location
  identity {
    type         = "SystemAssigned, UserAssigned"
    identity_ids = [azapi_resource.userAssignedIdentity.id]
  }
  body = {
    properties = {
      additionalCapabilities = {}
      applicationProfile = {
        galleryApplications = []
      }
      diagnosticsProfile = {
        bootDiagnostics = {
          enabled    = false
          storageUri = ""
        }
      }
      extensionsTimeBudget = "PT1H30M"
      hardwareProfile = {
        vmSize = "Standard_B2s"
      }
      networkProfile = {
        networkInterfaces = [{
          id = azapi_resource.networkInterface.id
          properties = {
            primary = true
          }
        }]
      }
      osProfile = {
        adminPassword            = "Pa-tn93e"
        adminUsername            = "adminuser"
        allowExtensionOperations = true
        computerName             = "${var.resource_name}-vm"
        linuxConfiguration = {
          disablePasswordAuthentication = false
          patchSettings = {
            assessmentMode = "ImageDefault"
            patchMode      = "ImageDefault"
          }
          provisionVMAgent = true
          ssh = {
            publicKeys = []
          }
        }
        secrets = []
      }
      priority = "Regular"
      storageProfile = {
        dataDisks = []
        imageReference = {
          offer     = "0001-com-ubuntu-server-jammy"
          publisher = "Canonical"
          sku       = "22_04-lts"
          version   = "latest"
        }
        osDisk = {
          caching      = "ReadWrite"
          createOption = "FromImage"
          managedDisk = {
            storageAccountType = "Premium_LRS"
          }
          osType                  = "Linux"
          writeAcceleratorEnabled = false
        }
      }
    }
  }
}

resource "azapi_resource" "runCommand" {
  type      = "Microsoft.Compute/virtualMachines/runCommands@2023-03-01"
  parent_id = azapi_resource.virtualMachine.id
  name      = "${var.resource_name}-runcommand"
  location  = var.location
  body = {
    properties = {
      asyncExecution      = false
      errorBlobUri        = ""
      outputBlobUri       = ""
      parameters          = []
      protectedParameters = []
      runAsPassword       = ""
      runAsUser           = ""
      source = {
        script = "echo 'hello world'"
      }
      timeoutInSeconds                = 1200
      treatFailureAsDeploymentFailure = true
    }
  }
}