Share via

Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2023-03-01

  • Artikel

Bicep-resourcedefinitie

Het resourcetype virtualMachineScaleSets/virtualMachines/runCommands kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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

Eigenschapswaarden

virtualMachineScaleSets/virtualMachines/runCommands

Naam Description Waarde
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep.		 tekenreeks (vereist)
location Resourcelocatie tekenreeks (vereist)
tags Resourcetags Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
Bovenliggende In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie Onderliggende resource buiten bovenliggende resource voor meer informatie.		 Symbolische naam voor resource van het type: virtualMachines
properties Beschrijft de eigenschappen van een opdracht voor het uitvoeren van een virtuele machine. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Naam Description Waarde
asyncExecution Optioneel. Als dit is ingesteld op true, wordt het inrichten voltooid zodra het script wordt gestart en wordt er niet gewacht totdat het script is voltooid. booleaans
errorBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot errorBlobUri-opslagblob. Gebruik een leeg object in het geval van een door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de rol 'Bijdrager voor opslagblobgegevens'. In het geval van een door de gebruiker toegewezen identiteit, moet u deze toevoegen onder de identiteit van de VM. Raadpleeg https://aka.ms/ManagedIdentity en voor meer informatie over beheerde identiteit en opdracht uitvoeren https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Hiermee geeft u de Azure Storage-blob op waar de scriptfoutstroom wordt geüpload. Gebruik een SAS-URI met lees-, toevoeg-, maak-, schrijftoegang OF gebruik een beheerde identiteit om de VM toegang te bieden tot de blob. Raadpleeg parameter errorBlobManagedIdentity. tekenreeks
outputBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot de outputBlobUri-opslagblob. Gebruik een leeg object in het geval van een door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de rol 'Bijdrager voor opslagblobgegevens'. In het geval van een door de gebruiker toegewezen identiteit, moet u deze toevoegen onder de identiteit van de VM. Raadpleeg https://aka.ms/ManagedIdentity en voor meer informatie over beheerde identiteit en opdracht uitvoeren https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Hiermee geeft u de Azure Storage-blob op waar de scriptuitvoerstroom wordt geüpload. Gebruik een SAS-URI met lees-, toevoeg-, maak-, schrijftoegang OF gebruik een beheerde identiteit om de VM toegang te bieden tot de blob. Raadpleeg de parameter outputBlobManagedIdentity. tekenreeks
parameters De parameters die door het script worden gebruikt. RunCommandInputParameter[]
protectedParameters De parameters die door het script worden gebruikt. RunCommandInputParameter[]
runAsPassword Hiermee geeft u het wachtwoord van het gebruikersaccount op de VM op bij het uitvoeren van de opdracht uitvoeren. tekenreeks
runAsUser Hiermee geeft u het gebruikersaccount op de VM bij het uitvoeren van de opdracht uitvoeren. tekenreeks
source De bron van het uitvoeropdrachtscript. VirtualMachineRunCommandScriptSource
timeoutInSeconds De time-out in seconden voor het uitvoeren van de opdracht uitvoeren. int
treatFailureAsDeploymentFailure Optioneel. Als deze optie is ingesteld op true, mislukt elke fout in het script bij de implementatie en wordt ProvisioningState gemarkeerd als Mislukt. Als deze optie is ingesteld op false, geeft ProvisioningState alleen aan of de opdracht run al dan niet is uitgevoerd door het uitbreidingsplatform. Het zou niet aangeven of het script is mislukt in het geval van scriptfouten. Zie exemplaarweergave van uitvoeropdracht in het geval van scriptfouten om executionMessage, uitvoer, fout te zien: https://aka.ms/runcommandmanaged#get-execution-status-and-results booleaans

RunCommandManagedIdentity

Naam Description Waarde
clientId Client-id (GUID-waarde) van de door de gebruiker toegewezen beheerde identiteit. ObjectId mag niet worden gebruikt als dit is opgegeven. tekenreeks
objectId Object-id (GUID-waarde) van de door de gebruiker toegewezen beheerde identiteit. ClientId mag niet worden gebruikt als dit is opgegeven. tekenreeks

RunCommandInputParameter

Naam Description Waarde
naam De parameternaam van de run-opdracht. tekenreeks (vereist)
waarde De parameterwaarde van de opdracht uitvoeren. tekenreeks (vereist)

VirtualMachineRunCommandScriptSource

Naam Description Waarde
commandId Hiermee geeft u een commandId van vooraf gedefinieerd ingebouwd script. tekenreeks
script Hiermee geeft u de scriptinhoud op die moet worden uitgevoerd op de VM. tekenreeks
scriptUri Hiermee geeft u de locatie voor het downloaden van het script op. Dit kan een SAS-URI zijn van een Azure Storage-blob met leestoegang of een openbare URI. tekenreeks
scriptUriManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot scriptUri in het geval van Azure Storage-blob. Gebruik een leeg object in het geval van een door het systeem toegewezen identiteit. Zorg ervoor dat de Azure Storage-blob bestaat en dat de beheerde identiteit toegang heeft gekregen tot de blob-container met roltoewijzing 'Lezer voor opslagblobgegevens'. In het geval van een door de gebruiker toegewezen identiteit, moet u deze toevoegen onder de identiteit van de VM. Raadpleeg https://aka.ms/ManagedIdentity en voor meer informatie over beheerde identiteit en opdracht uitvoeren https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Resourcedefinitie van ARM-sjabloon

Het resourcetype virtualMachineScaleSets/virtualMachines/runCommands kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

virtualMachineScaleSets/virtualMachines/runCommands

Naam Description Waarde
type Het resourcetype 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands'
apiVersion De resource-API-versie '2023-03-01'
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen.		 tekenreeks (vereist)
location Resourcelocatie tekenreeks (vereist)
tags Resourcetags Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
properties Beschrijft de eigenschappen van een opdracht voor het uitvoeren van een virtuele machine. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Naam Description Waarde
asyncExecution Optioneel. Als dit is ingesteld op true, wordt het inrichten voltooid zodra het script wordt gestart en wordt er niet gewacht totdat het script is voltooid. booleaans
errorBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot errorBlobUri-opslagblob. Gebruik een leeg object in het geval van een door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de rol 'Bijdrager voor opslagblobgegevens'. In het geval van een door de gebruiker toegewezen identiteit, moet u deze toevoegen onder de identiteit van de VM. Raadpleeg https://aka.ms/ManagedIdentity en voor meer informatie over beheerde identiteit en opdracht uitvoeren https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Hiermee geeft u de Azure Storage-blob op waar de scriptfoutstroom wordt geüpload. Gebruik een SAS-URI met lees-, toevoeg-, maak-, schrijftoegang OF gebruik een beheerde identiteit om de VM toegang te bieden tot de blob. Raadpleeg parameter errorBlobManagedIdentity. tekenreeks
outputBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot de outputBlobUri-opslagblob. Gebruik een leeg object in het geval van een door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de rol 'Bijdrager voor opslagblobgegevens'. In het geval van een door de gebruiker toegewezen identiteit, moet u deze toevoegen onder de identiteit van de VM. Raadpleeg https://aka.ms/ManagedIdentity en voor meer informatie over beheerde identiteit en opdracht uitvoeren https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Hiermee geeft u de Azure Storage-blob op waar de scriptuitvoerstroom wordt geüpload. Gebruik een SAS-URI met lees-, toevoeg-, maak-, schrijftoegang OF gebruik een beheerde identiteit om de VM toegang te bieden tot de blob. Raadpleeg de parameter outputBlobManagedIdentity. tekenreeks
parameters De parameters die door het script worden gebruikt. RunCommandInputParameter[]
protectedParameters De parameters die door het script worden gebruikt. RunCommandInputParameter[]
runAsPassword Hiermee geeft u het wachtwoord van het gebruikersaccount op de VM op bij het uitvoeren van de opdracht uitvoeren. tekenreeks
runAsUser Hiermee geeft u het gebruikersaccount op de VM bij het uitvoeren van de opdracht uitvoeren. tekenreeks
source De bron van het uitvoeropdrachtscript. VirtualMachineRunCommandScriptSource
timeoutInSeconds De time-out in seconden voor het uitvoeren van de opdracht uitvoeren. int
treatFailureAsDeploymentFailure Optioneel. Als deze optie is ingesteld op true, mislukt elke fout in het script bij de implementatie en wordt ProvisioningState gemarkeerd als Mislukt. Als deze optie is ingesteld op false, geeft ProvisioningState alleen aan of de opdracht run al dan niet is uitgevoerd door het uitbreidingsplatform. Het zou niet aangeven of het script is mislukt in het geval van scriptfouten. Zie exemplaarweergave van uitvoeropdracht in het geval van scriptfouten om executionMessage, uitvoer, fout te zien: https://aka.ms/runcommandmanaged#get-execution-status-and-results booleaans

RunCommandManagedIdentity

Naam Description Waarde
clientId Client-id (GUID-waarde) van de door de gebruiker toegewezen beheerde identiteit. ObjectId mag niet worden gebruikt als dit is opgegeven. tekenreeks
objectId Object-id (GUID-waarde) van de door de gebruiker toegewezen beheerde identiteit. ClientId mag niet worden gebruikt als dit is opgegeven. tekenreeks

RunCommandInputParameter

Naam Description Waarde
naam De parameternaam van de run-opdracht. tekenreeks (vereist)
waarde De parameterwaarde van de opdracht uitvoeren. tekenreeks (vereist)

VirtualMachineRunCommandScriptSource

Naam Description Waarde
commandId Hiermee geeft u een commandId van vooraf gedefinieerd ingebouwd script. tekenreeks
script Hiermee geeft u de scriptinhoud op die moet worden uitgevoerd op de VM. tekenreeks
scriptUri Hiermee geeft u de locatie voor het downloaden van het script op. Dit kan een SAS-URI zijn van een Azure Storage-blob met leestoegang of een openbare URI. tekenreeks
scriptUriManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot scriptUri in het geval van Azure Storage-blob. Gebruik een leeg object in het geval van een door het systeem toegewezen identiteit. Zorg ervoor dat de Azure Storage-blob bestaat en dat de beheerde identiteit toegang heeft gekregen tot de blob-container met roltoewijzing 'Lezer voor opslagblobgegevens'. In het geval van een door de gebruiker toegewezen identiteit, moet u deze toevoegen onder de identiteit van de VM. Raadpleeg https://aka.ms/ManagedIdentity en voor meer informatie over beheerde identiteit en opdracht uitvoeren https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Terraform-resourcedefinitie (AzAPI-provider)

Het resourcetype virtualMachineScaleSets/virtualMachines/runCommands kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

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

Eigenschapswaarden

virtualMachineScaleSets/virtualMachines/runCommands

Naam Description Waarde
type Het resourcetype "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-03-01"
naam De resourcenaam tekenreeks (vereist)
location Resourcelocatie tekenreeks (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: virtualMachines
tags Resourcetags Woordenlijst met tagnamen en -waarden.
properties Beschrijft de eigenschappen van een opdracht voor het uitvoeren van een virtuele machine. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Naam Description Waarde
asyncExecution Optioneel. Als dit is ingesteld op true, wordt het inrichten voltooid zodra het script wordt gestart en wordt er niet gewacht totdat het script is voltooid. booleaans
errorBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot errorBlobUri-opslagblob. Gebruik een leeg object in het geval van een door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de rol 'Bijdrager voor opslagblobgegevens'. In het geval van een door de gebruiker toegewezen identiteit, moet u deze toevoegen onder de identiteit van de VM. Raadpleeg https://aka.ms/ManagedIdentity en voor meer informatie over beheerde identiteit en opdracht uitvoeren https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Hiermee geeft u de Azure Storage-blob op waar de scriptfoutstroom wordt geüpload. Gebruik een SAS-URI met lees-, toevoeg-, maak-, schrijftoegang OF gebruik een beheerde identiteit om de VM toegang te bieden tot de blob. Raadpleeg parameter errorBlobManagedIdentity. tekenreeks
outputBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot de outputBlobUri-opslagblob. Gebruik een leeg object in het geval van een door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de rol 'Bijdrager voor opslagblobgegevens'. In het geval van een door de gebruiker toegewezen identiteit, moet u deze toevoegen onder de identiteit van de VM. Raadpleeg https://aka.ms/ManagedIdentity en voor meer informatie over beheerde identiteit en opdracht uitvoeren https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Hiermee geeft u de Azure Storage-blob op waar de scriptuitvoerstroom wordt geüpload. Gebruik een SAS-URI met lees-, toevoeg-, maak-, schrijftoegang OF gebruik een beheerde identiteit om de VM toegang te bieden tot de blob. Raadpleeg de parameter outputBlobManagedIdentity. tekenreeks
parameters De parameters die door het script worden gebruikt. RunCommandInputParameter[]
protectedParameters De parameters die door het script worden gebruikt. RunCommandInputParameter[]
runAsPassword Hiermee geeft u het wachtwoord van het gebruikersaccount op de VM op bij het uitvoeren van de opdracht uitvoeren. tekenreeks
runAsUser Hiermee geeft u het gebruikersaccount op de VM bij het uitvoeren van de opdracht uitvoeren. tekenreeks
source De bron van het uitvoeropdrachtscript. VirtualMachineRunCommandScriptSource
timeoutInSeconds De time-out in seconden voor het uitvoeren van de opdracht uitvoeren. int
treatFailureAsDeploymentFailure Optioneel. Als deze optie is ingesteld op true, mislukt elke fout in het script bij de implementatie en wordt ProvisioningState gemarkeerd als Mislukt. Als deze optie is ingesteld op false, geeft ProvisioningState alleen aan of de opdracht run al dan niet is uitgevoerd door het uitbreidingsplatform. Het zou niet aangeven of het script is mislukt in het geval van scriptfouten. Zie exemplaarweergave van uitvoeropdracht in het geval van scriptfouten om executionMessage, uitvoer, fout te zien: https://aka.ms/runcommandmanaged#get-execution-status-and-results booleaans

RunCommandManagedIdentity

Naam Description Waarde
clientId Client-id (GUID-waarde) van de door de gebruiker toegewezen beheerde identiteit. ObjectId mag niet worden gebruikt als dit is opgegeven. tekenreeks
objectId Object-id (GUID-waarde) van de door de gebruiker toegewezen beheerde identiteit. ClientId mag niet worden gebruikt als dit is opgegeven. tekenreeks

RunCommandInputParameter

Naam Description Waarde
naam De parameternaam van de run-opdracht. tekenreeks (vereist)
waarde De parameterwaarde van de opdracht uitvoeren. tekenreeks (vereist)

VirtualMachineRunCommandScriptSource

Naam Description Waarde
commandId Hiermee geeft u een commandId van vooraf gedefinieerd ingebouwd script. tekenreeks
script Hiermee geeft u de scriptinhoud op die moet worden uitgevoerd op de VM. tekenreeks
scriptUri Hiermee geeft u de locatie voor het downloaden van het script op. Dit kan een SAS-URI zijn van een Azure Storage-blob met leestoegang of een openbare URI. tekenreeks
scriptUriManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot scriptUri in het geval van Azure Storage-blob. Gebruik een leeg object in het geval van een door het systeem toegewezen identiteit. Zorg ervoor dat de Azure Storage-blob bestaat en dat de beheerde identiteit toegang heeft gekregen tot de blob-container met roltoewijzing 'Lezer voor opslagblobgegevens'. In het geval van een door de gebruiker toegewezen identiteit, moet u deze toevoegen onder de identiteit van de VM. Raadpleeg https://aka.ms/ManagedIdentity en voor meer informatie over beheerde identiteit en opdracht uitvoeren https://aka.ms/RunCommandManaged. RunCommandManagedIdentity