Delen via

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

  • Artikel

Bicep-resourcedefinitie

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

Zie logboek wijzigenvoor 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-09-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'
      script: 'string'
      scriptUri: 'string'
      scriptUriManagedIdentity: {
        clientId: 'string'
        objectId: 'string'
      }
    }
    timeoutInSeconds: int
    treatFailureAsDeploymentFailure: bool
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Naam Beschrijving Waarde
plaats Resourcelocatie tekenreeks (vereist)
naam De resourcenaam tekenreeks (vereist)
ouder 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 de bovenliggende resourcevoor meer informatie.		 Symbolische naam voor resource van het type: virtualMachineScaleSets/virtualMachines
Eigenschappen Beschrijft de eigenschappen van een opdracht voor het uitvoeren van een virtuele machine. VirtualMachineRunCommandProperties-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

ResourceTags

Naam Beschrijving Waarde

RunCommandInputParameter

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

RunCommandManagedIdentity

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

VirtualMachineRunCommandProperties

Naam Beschrijving Waarde
asyncExecution Facultatief. Als dit is ingesteld op true, wordt het inrichten voltooid zodra het script wordt gestart en wacht niet totdat het script is voltooid. Bool
errorBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot errorBlobUri-opslagblobob. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevensbijdrager. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManaged voor meer informatie over beheerde identiteit en opdracht uitvoeren 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 beheerde identiteit om de VM-toegang tot de blob te bieden. Refer errorBlobManagedIdentity parameter. snaar
outputBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot de blob outputBlobUri-opslag. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevensbijdrager. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManaged voor meer informatie over beheerde identiteit en opdracht uitvoeren 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 beheerde identiteit om de VM-toegang tot de blob te bieden. Refer outputBlobManagedIdentity parameter. snaar
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 voor het gebruikersaccount op de virtuele machine op bij het uitvoeren van de opdracht uitvoeren. snaar
runAsUser Hiermee geeft u het gebruikersaccount op de virtuele machine bij het uitvoeren van de opdracht uitvoeren. snaar
bron De bron van het script voor de run-opdracht. VirtualMachineRunCommandScriptSource
time-outInSeconds De time-out in seconden om de run-opdracht uit te voeren. Int
treatFailureAsDeploymentFailure Facultatief. Als deze optie is ingesteld op waar, mislukt een fout in het script de implementatie en wordt ProvisioningState gemarkeerd als Mislukt. Als deze optie is ingesteld op false, geeft ProvisioningState alleen aan of de run-opdracht al dan niet door het uitbreidingsplatform is uitgevoerd, wordt niet aangegeven of het script is mislukt in het geval van scriptfouten. Zie de exemplaarweergave van de uitvoeringsopdracht in het geval van scriptfouten om executionMessage, uitvoer, fout te zien: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Naam Beschrijving Waarde
commandId Hiermee geeft u een commandId van vooraf gedefinieerd ingebouwd script. snaar
script Hiermee geeft u de scriptinhoud op die moet worden uitgevoerd op de virtuele machine. snaar
scriptUri Hiermee geeft u de locatie voor het downloaden van scripts op. Dit kan een SAS-URI zijn van een Azure Storage-blob met leestoegang of openbare URI. snaar
scriptUriManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot scriptUri in het geval van Een Azure Storage-blob. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de Azure Storage-blob bestaat en dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevenslezer. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManagedvoor meer informatie over beheerde identiteit en Opdracht uitvoeren. RunCommandManagedIdentity-

Resourcedefinitie van ARM-sjabloon

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

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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

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

Eigenschapswaarden

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Naam Beschrijving Waarde
apiVersion De API-versie '2023-09-01'
plaats Resourcelocatie tekenreeks (vereist)
naam De resourcenaam tekenreeks (vereist)
Eigenschappen Beschrijft de eigenschappen van een opdracht voor het uitvoeren van een virtuele machine. VirtualMachineRunCommandProperties-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type Het resourcetype 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands'

ResourceTags

Naam Beschrijving Waarde

RunCommandInputParameter

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

RunCommandManagedIdentity

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

VirtualMachineRunCommandProperties

Naam Beschrijving Waarde
asyncExecution Facultatief. Als dit is ingesteld op true, wordt het inrichten voltooid zodra het script wordt gestart en wacht niet totdat het script is voltooid. Bool
errorBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot errorBlobUri-opslagblobob. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevensbijdrager. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManaged voor meer informatie over beheerde identiteit en opdracht uitvoeren 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 beheerde identiteit om de VM-toegang tot de blob te bieden. Refer errorBlobManagedIdentity parameter. snaar
outputBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot de blob outputBlobUri-opslag. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevensbijdrager. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManaged voor meer informatie over beheerde identiteit en opdracht uitvoeren 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 beheerde identiteit om de VM-toegang tot de blob te bieden. Refer outputBlobManagedIdentity parameter. snaar
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 voor het gebruikersaccount op de virtuele machine op bij het uitvoeren van de opdracht uitvoeren. snaar
runAsUser Hiermee geeft u het gebruikersaccount op de virtuele machine bij het uitvoeren van de opdracht uitvoeren. snaar
bron De bron van het script voor de run-opdracht. VirtualMachineRunCommandScriptSource
time-outInSeconds De time-out in seconden om de run-opdracht uit te voeren. Int
treatFailureAsDeploymentFailure Facultatief. Als deze optie is ingesteld op waar, mislukt een fout in het script de implementatie en wordt ProvisioningState gemarkeerd als Mislukt. Als deze optie is ingesteld op false, geeft ProvisioningState alleen aan of de run-opdracht al dan niet door het uitbreidingsplatform is uitgevoerd, wordt niet aangegeven of het script is mislukt in het geval van scriptfouten. Zie de exemplaarweergave van de uitvoeringsopdracht in het geval van scriptfouten om executionMessage, uitvoer, fout te zien: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Naam Beschrijving Waarde
commandId Hiermee geeft u een commandId van vooraf gedefinieerd ingebouwd script. snaar
script Hiermee geeft u de scriptinhoud op die moet worden uitgevoerd op de virtuele machine. snaar
scriptUri Hiermee geeft u de locatie voor het downloaden van scripts op. Dit kan een SAS-URI zijn van een Azure Storage-blob met leestoegang of openbare URI. snaar
scriptUriManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot scriptUri in het geval van Een Azure Storage-blob. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de Azure Storage-blob bestaat en dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevenslezer. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManagedvoor meer informatie over beheerde identiteit en Opdracht uitvoeren. RunCommandManagedIdentity-

Resourcedefinitie van Terraform (AzAPI-provider)

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

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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

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

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

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

ResourceTags

Naam Beschrijving Waarde

RunCommandInputParameter

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

RunCommandManagedIdentity

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

VirtualMachineRunCommandProperties

Naam Beschrijving Waarde
asyncExecution Facultatief. Als dit is ingesteld op true, wordt het inrichten voltooid zodra het script wordt gestart en wacht niet totdat het script is voltooid. Bool
errorBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot errorBlobUri-opslagblobob. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevensbijdrager. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManaged voor meer informatie over beheerde identiteit en opdracht uitvoeren 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 beheerde identiteit om de VM-toegang tot de blob te bieden. Refer errorBlobManagedIdentity parameter. snaar
outputBlobManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot de blob outputBlobUri-opslag. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevensbijdrager. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManaged voor meer informatie over beheerde identiteit en opdracht uitvoeren 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 beheerde identiteit om de VM-toegang tot de blob te bieden. Refer outputBlobManagedIdentity parameter. snaar
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 voor het gebruikersaccount op de virtuele machine op bij het uitvoeren van de opdracht uitvoeren. snaar
runAsUser Hiermee geeft u het gebruikersaccount op de virtuele machine bij het uitvoeren van de opdracht uitvoeren. snaar
bron De bron van het script voor de run-opdracht. VirtualMachineRunCommandScriptSource
time-outInSeconds De time-out in seconden om de run-opdracht uit te voeren. Int
treatFailureAsDeploymentFailure Facultatief. Als deze optie is ingesteld op waar, mislukt een fout in het script de implementatie en wordt ProvisioningState gemarkeerd als Mislukt. Als deze optie is ingesteld op false, geeft ProvisioningState alleen aan of de run-opdracht al dan niet door het uitbreidingsplatform is uitgevoerd, wordt niet aangegeven of het script is mislukt in het geval van scriptfouten. Zie de exemplaarweergave van de uitvoeringsopdracht in het geval van scriptfouten om executionMessage, uitvoer, fout te zien: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Naam Beschrijving Waarde
commandId Hiermee geeft u een commandId van vooraf gedefinieerd ingebouwd script. snaar
script Hiermee geeft u de scriptinhoud op die moet worden uitgevoerd op de virtuele machine. snaar
scriptUri Hiermee geeft u de locatie voor het downloaden van scripts op. Dit kan een SAS-URI zijn van een Azure Storage-blob met leestoegang of openbare URI. snaar
scriptUriManagedIdentity Door de gebruiker toegewezen beheerde identiteit die toegang heeft tot scriptUri in het geval van Een Azure Storage-blob. Gebruik een leeg object in het geval van door het systeem toegewezen identiteit. Zorg ervoor dat de Azure Storage-blob bestaat en dat de beheerde identiteit toegang heeft gekregen tot de container van de blob met de roltoewijzing Opslagblobgegevenslezer. Zorg er in het geval van door de gebruiker toegewezen identiteit voor dat u deze toevoegt onder de identiteit van de VIRTUELE machine. Raadpleeg https://aka.ms/ManagedIdentity en https://aka.ms/RunCommandManagedvoor meer informatie over beheerde identiteit en Opdracht uitvoeren. RunCommandManagedIdentity-