Udostępnij za pośrednictwem

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 dziennika 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' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  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
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Nazwa Opis Wartość
lokalizacja Lokalizacja zasobu ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
rodzic W 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.		 Nazwa symboliczna zasobu typu: virtualMachineScaleSets/virtualMachines
Właściwości Opisuje właściwości polecenia uruchamiania maszyny wirtualnej. VirtualMachineRunCommandProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Tagi zasobów

Nazwa Opis Wartość

RunCommandInputParameter

Nazwa Opis Wartość
nazwa Nazwa parametru polecenia uruchamiania. ciąg (wymagany)
wartość Wartość parametru polecenia uruchomienia. ciąg (wymagany)

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Fakultatywny. Jeśli ustawiono wartość true, aprowizacja zostanie ukończona natychmiast 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. struna
outputBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. struna
Parametry 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 uruchamiania. struna
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. struna
źródło Źródło skryptu polecenia uruchamiania. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchomienia. Int

VirtualMachineRunCommandScriptSource

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

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 dziennika 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",
  "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2021-11-01'
lokalizacja Lokalizacja zasobu ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Opisuje właściwości polecenia uruchamiania maszyny wirtualnej. VirtualMachineRunCommandProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands"

Tagi zasobów

Nazwa Opis Wartość

RunCommandInputParameter

Nazwa Opis Wartość
nazwa Nazwa parametru polecenia uruchamiania. ciąg (wymagany)
wartość Wartość parametru polecenia uruchomienia. ciąg (wymagany)

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Fakultatywny. Jeśli ustawiono wartość true, aprowizacja zostanie ukończona natychmiast 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. struna
outputBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. struna
Parametry 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 uruchamiania. struna
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. struna
źródło Źródło skryptu polecenia uruchamiania. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchomienia. Int

VirtualMachineRunCommandScriptSource

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

Przykłady użycia

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 dziennika zmian.

Format zasobu

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-11-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

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

Tagi zasobów

Nazwa Opis Wartość

RunCommandInputParameter

Nazwa Opis Wartość
nazwa Nazwa parametru polecenia uruchamiania. ciąg (wymagany)
wartość Wartość parametru polecenia uruchomienia. ciąg (wymagany)

VirtualMachineRunCommandProperties

Nazwa Opis Wartość
asyncExecution Fakultatywny. Jeśli ustawiono wartość true, aprowizacja zostanie ukończona natychmiast 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. struna
outputBlobUri Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. struna
Parametry 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 uruchamiania. struna
runAsUser Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. struna
źródło Źródło skryptu polecenia uruchamiania. VirtualMachineRunCommandScriptSource
timeoutInSeconds Limit czasu w sekundach do wykonania polecenia uruchomienia. Int

VirtualMachineRunCommandScriptSource

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