Dela via

Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands

  • Artikel

Bicep-resursdefinition

Resurstypen virtualMachineScaleSets/virtualMachines/runCommands kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands-resurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

virtualMachineScaleSets/virtualMachines/runCommands

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.		 sträng (krävs)
location Resursplats sträng (krävs)
tags Resurstaggar Ordlista med taggnamn och värden. Se Taggar i mallar
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.		 Symboliskt namn för resurs av typen: virtualMachines
properties Beskriver egenskaperna för ett körningskommando för virtuell dator. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Name Beskrivning Värde
asyncExecution Valfritt. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras. boolesk
errorBlobManagedIdentity Användartilldelad hanterad identitet som har åtkomst till errorBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen Storage Blob Data Contributor. Om det gäller användartilldelad identitet måste du lägga till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Anger den Azure Storage-blob där skriptfelströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern errorBlobManagedIdentity. sträng
outputBlobManagedIdentity Användartilldelad hanterad identitet som har åtkomst till lagringsbloben outputBlobUri. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen Storage Blob Data Contributor. Om det gäller användartilldelad identitet måste du lägga till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Anger den Azure Storage-blob där skriptets utdataström ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern outputBlobManagedIdentity. sträng
parametrar De parametrar som används av skriptet. RunCommandInputParameter[]
protectedParameters De parametrar som används av skriptet. RunCommandInputParameter[]
runAsPassword Anger lösenordet för användarkontot på den virtuella datorn när körningskommandot körs. sträng
runAsUser Anger användarkontot på den virtuella datorn när körningskommandot körs. sträng
källa Källan för körningskommandoskriptet. VirtualMachineRunCommandScriptSource
timeoutInSeconds Tidsgränsen i sekunder för att köra körningskommandot. int
treatFailureAsDeploymentFailure Valfritt. Om värdet är true misslyckas distributionen av eventuella fel i skriptet och ProvisioningState markeras som Misslyckad. Om värdet är falskt skulle ProvisioningState endast återspegla om körningskommandot kördes eller inte av tilläggsplattformen. Det anger inte om skriptet misslyckades vid skriptfel. Se instansvyn för körningskommandot vid skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results boolesk

RunCommandManagedIdentity

Name Beskrivning Värde
ClientID Klient-ID (GUID-värde) för den användartilldelade hanterade identiteten. ObjectId bör inte användas om detta anges. sträng
objectId Objekt-ID (GUID-värde) för den användartilldelade hanterade identiteten. ClientId bör inte användas om detta anges. sträng

RunCommandInputParameter

Name Beskrivning Värde
name Kör kommandoparameterns namn. sträng (krävs)
värde Kör kommandoparametervärdet. sträng (krävs)

VirtualMachineRunCommandScriptSource

Name Beskrivning Värde
commandId Anger ett commandId för fördefinierade inbyggda skript. sträng
skript Anger skriptinnehållet som ska köras på den virtuella datorn. sträng
scriptUri Anger platsen för skriptnedladdning. Det kan vara antingen SAS-URI för en Azure Storage-blob med läsåtkomst eller offentlig URI. sträng
scriptUriManagedIdentity Användartilldelad hanterad identitet som har åtkomst till scriptUri vid Azure Storage-blob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att Azure Storage-bloben finns och att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Reader". När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Resursdefinition för ARM-mall

Resurstypen virtualMachineScaleSets/virtualMachines/runCommands kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands-resurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

virtualMachineScaleSets/virtualMachines/runCommands

Name Beskrivning Värde
typ Resurstypen "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands"
apiVersion Resurs-API-versionen '2023-09-01'
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 sträng (krävs)
location Resursplats sträng (krävs)
tags Resurstaggar Ordlista med taggnamn och värden. Se Taggar i mallar
properties Beskriver egenskaperna för ett körningskommando för virtuell dator. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Name Beskrivning Värde
asyncExecution Valfritt. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras. boolesk
errorBlobManagedIdentity Användartilldelad hanterad identitet som har åtkomst till errorBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Contributor". När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Anger den Azure Storage-blob där skriptfelströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern errorBlobManagedIdentity. sträng
outputBlobManagedIdentity Användartilldelad hanterad identitet som har åtkomst till outputBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Contributor". När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Anger den Azure Storage-blob där skriptutdataströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern outputBlobManagedIdentity. sträng
parametrar De parametrar som används av skriptet. RunCommandInputParameter[]
protectedParameters De parametrar som används av skriptet. RunCommandInputParameter[]
runAsPassword Anger lösenordet för användarkontot på den virtuella datorn när körningskommandot körs. sträng
runAsUser Anger användarkontot på den virtuella datorn när körningskommandot körs. sträng
källa Källan till körningskommandoskriptet. VirtualMachineRunCommandScriptSource
timeoutInSeconds Tidsgränsen i sekunder för att köra körningskommandot. int
treatFailureAsDeploymentFailure Valfritt. Om värdet är sant misslyckas eventuella fel i skriptet och ProvisioningState markeras som Misslyckad. Om värdet är falskt skulle ProvisioningState bara återspegla om körningskommandot kördes eller inte av tilläggsplattformen. Det skulle inte ange om skriptet misslyckades vid skriptfel. Se instansvyn för körningskommandot vid skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results boolesk

RunCommandManagedIdentity

Name Beskrivning Värde
ClientID Klient-ID (GUID-värde) för den användartilldelade hanterade identiteten. ObjectId bör inte användas om detta anges. sträng
objectId Objekt-ID (GUID-värde) för den användartilldelade hanterade identiteten. ClientId bör inte användas om detta anges. sträng

RunCommandInputParameter

Name Beskrivning Värde
name Kör kommandoparameterns namn. sträng (krävs)
värde Kör kommandoparametervärdet. sträng (krävs)

VirtualMachineRunCommandScriptSource

Name Beskrivning Värde
commandId Anger ett commandId för fördefinierade inbyggda skript. sträng
skript Anger skriptinnehållet som ska köras på den virtuella datorn. sträng
scriptUri Anger platsen för skriptnedladdning. Det kan vara antingen SAS-URI för en Azure Storage-blob med läsåtkomst eller offentlig URI. sträng
scriptUriManagedIdentity Användartilldelad hanterad identitet som har åtkomst till scriptUri vid Azure Storage-blob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att Azure Storage-bloben finns och att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Reader". När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen virtualMachineScaleSets/virtualMachines/runCommands kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

virtualMachineScaleSets/virtualMachines/runCommands

Name Beskrivning Värde
typ Resurstypen "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-09-01"
name Resursnamnet sträng (krävs)
location Resursplats sträng (krävs)
parent_id ID:t för resursen som är överordnad för den här resursen. ID för resurs av typen: virtualMachines
tags Resurstaggar Ordlista med taggnamn och värden.
properties Beskriver egenskaperna för ett körningskommando för virtuell dator. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Name Beskrivning Värde
asyncExecution Valfritt. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras. boolesk
errorBlobManagedIdentity Användartilldelad hanterad identitet som har åtkomst till errorBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen Storage Blob Data Contributor. Om det gäller användartilldelad identitet måste du lägga till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Anger den Azure Storage-blob där skriptfelströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern errorBlobManagedIdentity. sträng
outputBlobManagedIdentity Användartilldelad hanterad identitet som har åtkomst till lagringsbloben outputBlobUri. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen Storage Blob Data Contributor. Om det gäller användartilldelad identitet måste du lägga till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Anger den Azure Storage-blob där skriptets utdataström ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern outputBlobManagedIdentity. sträng
parametrar De parametrar som används av skriptet. RunCommandInputParameter[]
protectedParameters De parametrar som används av skriptet. RunCommandInputParameter[]
runAsPassword Anger lösenordet för användarkontot på den virtuella datorn när körningskommandot körs. sträng
runAsUser Anger användarkontot på den virtuella datorn när körningskommandot körs. sträng
källa Källan för körningskommandoskriptet. VirtualMachineRunCommandScriptSource
timeoutInSeconds Tidsgränsen i sekunder för att köra körningskommandot. int
treatFailureAsDeploymentFailure Valfritt. Om värdet är true misslyckas distributionen av eventuella fel i skriptet och ProvisioningState markeras som Misslyckad. Om värdet är falskt skulle ProvisioningState endast återspegla om körningskommandot kördes eller inte av tilläggsplattformen. Det anger inte om skriptet misslyckades vid skriptfel. Se instansvyn för körningskommandot vid skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results boolesk

RunCommandManagedIdentity

Name Beskrivning Värde
ClientID Klient-ID (GUID-värde) för den användartilldelade hanterade identiteten. ObjectId bör inte användas om detta anges. sträng
objectId Objekt-ID (GUID-värde) för den användartilldelade hanterade identiteten. ClientId bör inte användas om detta anges. sträng

RunCommandInputParameter

Name Beskrivning Värde
name Parameternamnet för körningskommandot. sträng (krävs)
värde Parametervärdet för körningskommandot. sträng (krävs)

VirtualMachineRunCommandScriptSource

Name Beskrivning Värde
commandId Anger ett commandId för fördefinierade inbyggda skript. sträng
skript Anger skriptinnehållet som ska köras på den virtuella datorn. sträng
scriptUri Anger platsen för nedladdning av skript. Det kan vara antingen SAS-URI för en Azure-lagringsblob med läsåtkomst eller offentlig URI. sträng
scriptUriManagedIdentity Användartilldelad hanterad identitet som har åtkomst till scriptUri vid Azure Storage-blob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att Azure Storage-bloben finns och att hanterad identitet har fått åtkomst till blobcontainern med rolltilldelningen Storage Blob Data Reader. Om det gäller användartilldelad identitet måste du lägga till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged. RunCommandManagedIdentity