Partager via

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

  • Article

Définition de ressource Bicep

Le type de ressource virtualMachineScaleSets/virtualMachines/runCommands peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, ajoutez le Bicep suivant à votre modèle.

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

Valeurs de propriétés

virtualMachineScaleSets/virtualMachines/runCommands

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 chaîne (obligatoire)
location Emplacement de la ressource chaîne (obligatoire)
tags Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : virtualMachines
properties Décrit les propriétés d’une commande d’exécution de machine virtuelle. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nom Description Valeur
asyncExecution facultatif. Si la valeur est true, l’approvisionnement se termine dès que le script démarre et n’attend pas que le script se termine. bool
errorBlobUri Spécifie l’objet blob de stockage Azure où le flux d’erreurs de script sera chargé. string
outputBlobUri Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé. string
parameters Paramètres utilisés par le script. RunCommandInputParameter[]
protectedParameters Paramètres utilisés par le script. RunCommandInputParameter[]
runAsPassword Spécifie le mot de passe du compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande run. string
runAsUser Spécifie le compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande run. string
source Source du script de commande d’exécution. VirtualMachineRunCommandScriptSource
timeoutInSeconds Délai d’attente en secondes pour exécuter la commande d’exécution. int

RunCommandInputParameter

Nom Description Valeur
name Nom du paramètre de commande d’exécution. chaîne (obligatoire)
value Valeur du paramètre de commande run. chaîne (obligatoire)

VirtualMachineRunCommandScriptSource

Nom Description Valeur
commandId Spécifie un commandId de script prédéfini. string
script Spécifie le contenu du script à exécuter sur la machine virtuelle. string
scriptUri Spécifie l’emplacement de téléchargement du script. string

Définition de ressources de modèle ARM

Le type de ressource virtualMachineScaleSets/virtualMachines/runCommands peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriétés

virtualMachineScaleSets/virtualMachines/runCommands

Nom Description Valeur
type Type de ressource 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands'
apiVersion Version de l’API de ressource '2022-11-01'
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.		 string (obligatoire)
location Emplacement de la ressource string (obligatoire)
tags Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Décrit les propriétés d’une commande d’exécution de machine virtuelle. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nom Description Valeur
asyncExecution facultatif. Si la valeur est true, l’approvisionnement se termine dès le démarrage du script et n’attend pas la fin du script. bool
errorBlobUri Spécifie l’objet blob de stockage Azure où le flux d’erreurs de script sera chargé. string
outputBlobUri Spécifie l’objet blob de stockage Azure où le flux de sortie de script sera chargé. string
parameters Paramètres utilisés par le script. RunCommandInputParameter[]
protectedParameters Paramètres utilisés par le script. RunCommandInputParameter[]
runAsPassword Spécifie le mot de passe du compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande d’exécution. string
runAsUser Spécifie le compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande d’exécution. string
source Source du script de commande d’exécution. VirtualMachineRunCommandScriptSource
timeoutInSeconds Délai d’expiration en secondes pour exécuter la commande d’exécution. int

RunCommandInputParameter

Nom Description Valeur
name Nom du paramètre de commande d’exécution. string (obligatoire)
value Valeur du paramètre de commande run. string (obligatoire)

VirtualMachineRunCommandScriptSource

Nom Description Valeur
commandId Spécifie un commandId du script prédéfini. string
script Spécifie le contenu du script à exécuter sur la machine virtuelle. string
scriptUri Spécifie l’emplacement de téléchargement du script. string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource virtualMachineScaleSets/virtualMachines/runCommands peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, ajoutez le Terraform suivant à votre modèle.

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

Valeurs de propriétés

virtualMachineScaleSets/virtualMachines/runCommands

Nom Description Valeur
type Type de ressource « Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2022-11-01 »
name Nom de la ressource chaîne (obligatoire)
location Emplacement de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : virtualMachines
tags Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
properties Décrit les propriétés d’une commande d’exécution de machine virtuelle. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nom Description Valeur
asyncExecution facultatif. Si la valeur est true, l’approvisionnement se termine dès que le script démarre et n’attend pas que le script se termine. bool
errorBlobUri Spécifie l’objet blob de stockage Azure où le flux d’erreurs de script sera chargé. string
outputBlobUri Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé. string
parameters Paramètres utilisés par le script. RunCommandInputParameter[]
protectedParameters Paramètres utilisés par le script. RunCommandInputParameter[]
runAsPassword Spécifie le mot de passe du compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande run. string
runAsUser Spécifie le compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande run. string
source Source du script de commande d’exécution. VirtualMachineRunCommandScriptSource
timeoutInSeconds Délai d’attente en secondes pour exécuter la commande d’exécution. int

RunCommandInputParameter

Nom Description Valeur
name Nom du paramètre de commande d’exécution. chaîne (obligatoire)
value Valeur du paramètre de commande run. chaîne (obligatoire)

VirtualMachineRunCommandScriptSource

Nom Description Valeur
commandId Spécifie un commandId de script prédéfini. string
script Spécifie le contenu du script à exécuter sur la machine virtuelle. string
scriptUri Spécifie l’emplacement de téléchargement du script. string