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

  • Artykuł

Definicja zasobu Bicep

Typ zasobu virtualMachineScaleSets/virtualMachines/runCommands można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, dodaj następujący zasób Bicep do szablonu.

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

Wartości właściwości

virtualMachineScaleSets/virtualMachines/runCommands

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.		 ciąg (wymagany)
location Lokalizacja zasobu ciąg (wymagany)
tags Tagi zasobów Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
Nadrzędny W pliku Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Symboliczna nazwa zasobu typu: virtualMachines
properties Opisuje właściwości polecenia uruchamiania maszyny wirtualnej. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Opcjonalny. Jeśli ustawiono wartość true, aprowizacja zostanie zakończona zaraz po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu. bool
errorBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień błędów skryptu. ciąg
outputBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. ciąg
parameters Parametry używane przez skrypt. RunCommandInputParameter[]
protectedParameters Parametry używane przez skrypt. RunCommandInputParameter[]
runAsPassword Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia run. ciąg
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia run. ciąg
source Źródło skryptu polecenia run. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchomienia. int

RunCommandInputParameter

Nazwa Opis Wartość
name Nazwa parametru polecenia run. ciąg (wymagany)
wartość Wartość parametru polecenia run. ciąg (wymagany)

VirtualMachineRunCommandScriptSource

Nazwa Opis Wartość
Commandid Określa identyfikator polecenia wstępnie zdefiniowanego wbudowanego skryptu. ciąg
skrypt Określa zawartość skryptu do wykonania na maszynie wirtualnej. ciąg
scriptUri Określa lokalizację pobierania skryptu. ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu virtualMachineScaleSets/virtualMachines/runCommands można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

virtualMachineScaleSets/virtualMachines/runCommands

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands"
apiVersion Wersja interfejsu API zasobów '2021-11-01'
name Nazwa zasobu

Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON.		 ciąg (wymagany)
location Lokalizacja zasobu ciąg (wymagany)
tags Tagi zasobów Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
properties Opisuje właściwości polecenia uruchamiania maszyny wirtualnej. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Opcjonalny. Jeśli ustawiono wartość true, aprowizacja zostanie zakończona zaraz po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu. bool
errorBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień błędów skryptu. ciąg
outputBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. ciąg
parameters Parametry używane przez skrypt. RunCommandInputParameter[]
protectedParameters Parametry używane przez skrypt. RunCommandInputParameter[]
runAsPassword Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia run. ciąg
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia run. ciąg
source Źródło skryptu polecenia run. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchomienia. int

RunCommandInputParameter

Nazwa Opis Wartość
name Nazwa parametru polecenia run. ciąg (wymagany)
wartość Wartość parametru polecenia run. ciąg (wymagany)

VirtualMachineRunCommandScriptSource

Nazwa Opis Wartość
Commandid Określa identyfikator polecenia wstępnie zdefiniowanego wbudowanego skryptu. ciąg
skrypt Określa zawartość skryptu do wykonania na maszynie wirtualnej. ciąg
scriptUri Określa lokalizację pobierania skryptu. ciąg

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu virtualMachineScaleSets/virtualMachines/runCommands można wdrożyć przy użyciu operacji docelowych:

  • Grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, dodaj następujące narzędzie Terraform do szablonu.

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

Wartości właściwości

virtualMachineScaleSets/virtualMachines/runCommands

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-11-01"
name Nazwa zasobu ciąg (wymagany)
location Lokalizacja zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: virtualMachines
tags Tagi zasobów Słownik nazw tagów i wartości.
properties Opisuje właściwości polecenia uruchamiania maszyny wirtualnej. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Opcjonalny. Jeśli ustawiono wartość true, aprowizacja zostanie zakończona zaraz po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu. bool
errorBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień błędów skryptu. ciąg
outputBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. ciąg
parameters Parametry używane przez skrypt. RunCommandInputParameter[]
protectedParameters Parametry używane przez skrypt. RunCommandInputParameter[]
runAsPassword Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia run. ciąg
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia run. ciąg
source Źródło skryptu polecenia run. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchomienia. int

RunCommandInputParameter

Nazwa Opis Wartość
name Nazwa parametru polecenia run. ciąg (wymagany)
wartość Wartość parametru polecenia run. ciąg (wymagany)

VirtualMachineRunCommandScriptSource

Nazwa Opis Wartość
Commandid Określa identyfikator polecenia wstępnie zdefiniowanego wbudowanego skryptu. ciąg
skrypt Określa zawartość skryptu do wykonania na maszynie wirtualnej. ciąg
scriptUri Określa lokalizację pobierania skryptu. ciąg