Microsoft.Compute virtualMachines/runCommands 2021-11-01

• dernière
• 2024-07-01
• 2024-03-01
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01

Définition de ressource Bicep

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

• groupes de ressources - Consultez commandes de déploiement de groupes de ressources

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

Format de ressource

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

resource symbolicname 'Microsoft.Compute/virtualMachines/runCommands@2021-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é

virtualMachines/runCommands

Nom	Description	Valeur
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep.	chaîne (obligatoire)
emplacement	Emplacement des ressources	chaîne (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
parent	Dans Bicep, vous pouvez spécifier la ressource parente d’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
Propriétés	Décrit les propriétés d’une commande d’exécution de machine virtuelle.	VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nom	Description	Valeur
asyncExecution	Optionnel. 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 dans lequel le flux d’erreurs de script sera chargé.	corde
outputBlobUri	Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé.	corde
Paramètres	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.	corde
runAsUser	Spécifie le compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande d’exécution.	corde
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
nom	Nom du paramètre de commande d’exécution.	chaîne (obligatoire)
valeur	Valeur du paramètre de commande d’exécution.	chaîne (obligatoire)

VirtualMachineRunCommandScriptSource

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

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle

Description

abonnement SharePoint / 2019 / 2016 / 2013 tous les configurés

Ce modèle crée un abonnement SharePoint / 2019 / 2016 / 2013 avec une configuration étendue qui prend des âges pour effectuer manuellement, notamment une authentification fédérée avec ADFS, une approbation OAuth, le service Profils utilisateur et une application web avec 2 zones qui contiennent plusieurs collections de sites nommées par chemin d’accès et hôte. Sur les machines virtuelles SharePoint, Chocolatey est utilisé pour installer la dernière version de Notepad++, Visual Studio Code, Azure Data Studio, Fiddler, ULS Viewer et 7-Zip.

Définition de ressource de modèle ARM

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

• groupes de ressources - Consultez commandes de déploiement de groupes de ressources

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

Format de ressource

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

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

virtualMachines/runCommands

Nom	Description	Valeur
type	Type de ressource	'Microsoft.Compute/virtualMachines/runCommands'
apiVersion	Version de l’API de ressource	'2021-11-01'
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON.	chaîne (obligatoire)
emplacement	Emplacement des ressources	chaîne (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
Propriétés	Décrit les propriétés d’une commande d’exécution de machine virtuelle.	VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Nom	Description	Valeur
asyncExecution	Optionnel. 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 dans lequel le flux d’erreurs de script sera chargé.	corde
outputBlobUri	Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé.	corde
Paramètres	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.	corde
runAsUser	Spécifie le compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande d’exécution.	corde
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
nom	Nom du paramètre de commande d’exécution.	chaîne (obligatoire)
valeur	Valeur du paramètre de commande d’exécution.	chaîne (obligatoire)

VirtualMachineRunCommandScriptSource

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

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle

Description

abonnement SharePoint / 2019 / 2016 / 2013 tous les configurés

Ce modèle crée un abonnement SharePoint / 2019 / 2016 / 2013 avec une configuration étendue qui prend des âges pour effectuer manuellement, notamment une authentification fédérée avec ADFS, une approbation OAuth, le service Profils utilisateur et une application web avec 2 zones qui contiennent plusieurs collections de sites nommées par chemin d’accès et hôte. Sur les machines virtuelles SharePoint, Chocolatey est utilisé pour installer la dernière version de Notepad++, Visual Studio Code, Azure Data Studio, Fiddler, ULS Viewer et 7-Zip.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource 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 de l’API, consultez journal des modifications.

Format de ressource

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/runCommands@2021-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é

virtualMachines/runCommands

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

VirtualMachineRunCommandProperties

Nom	Description	Valeur
asyncExecution	Optionnel. 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 dans lequel le flux d’erreurs de script sera chargé.	corde
outputBlobUri	Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé.	corde
Paramètres	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.	corde
runAsUser	Spécifie le compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande d’exécution.	corde
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
nom	Nom du paramètre de commande d’exécution.	chaîne (obligatoire)
valeur	Valeur du paramètre de commande d’exécution.	chaîne (obligatoire)

VirtualMachineRunCommandScriptSource

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