Microsoft.Compute virtualMachines/runCommands 2022-03-01

• Dernier
• 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
• 2020-06-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@2022-03-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  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
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Microsoft.Compute/virtualMachines/runCommands

Nom	Description	Valeur
emplacement	Emplacement des ressources	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
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
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

ResourceTags

Nom	Description	Valeur

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)

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

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

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep	Description
GitLab GitLab	Ce modèle simplifie le déploiement de GitLab Omnibus sur une machine virtuelle avec un DNS public, en tirant parti du DNS de l’adresse IP publique. Il utilise la taille d’instance Standard_F8s_v2, qui s’aligne sur l’architecture de référence et prend en charge jusqu’à 1 000 utilisateurs (20 RPS). L’instance est préconfigurée pour utiliser HTTPS avec un certificat Let’s Encrypt pour les connexions sécurisées.
abonnement SharePoint / 2019 / 2016 entièrement configuré	Créez un contrôleur de domaine, un serveur SQL Server 2022 et de 1 à 5 serveurs hébergeant un abonnement SharePoint / 2019 / 2016 avec une configuration étendue, notamment l’authentification approuvée, les profils utilisateur avec des sites personnels, une approbation OAuth (à l’aide d’un certificat), un site IIS dédié pour l’hébergement de compléments à haut niveau de fiabilité, etc. La dernière version des logiciels clés (y compris Fiddler, vscode, np++, 7zip, ULS Viewer) est installée. Les machines SharePoint disposent d’un réglage précis supplémentaire pour les rendre immédiatement utilisables (outils d’administration à distance, stratégies personnalisées pour Edge et Chrome, raccourcis, etc.).

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": "2022-03-01",
  "name": "string",
  "location": "string",
  "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Microsoft.Compute/virtualMachines/runCommands

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

ResourceTags

Nom	Description	Valeur

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)

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

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
GitLab GitLab	Ce modèle simplifie le déploiement de GitLab Omnibus sur une machine virtuelle avec un DNS public, en tirant parti du DNS de l’adresse IP publique. Il utilise la taille d’instance Standard_F8s_v2, qui s’aligne sur l’architecture de référence et prend en charge jusqu’à 1 000 utilisateurs (20 RPS). L’instance est préconfigurée pour utiliser HTTPS avec un certificat Let’s Encrypt pour les connexions sécurisées.
abonnement SharePoint / 2019 / 2016 entièrement configuré	Créez un contrôleur de domaine, un serveur SQL Server 2022 et de 1 à 5 serveurs hébergeant un abonnement SharePoint / 2019 / 2016 avec une configuration étendue, notamment l’authentification approuvée, les profils utilisateur avec des sites personnels, une approbation OAuth (à l’aide d’un certificat), un site IIS dédié pour l’hébergement de compléments à haut niveau de fiabilité, etc. La dernière version des logiciels clés (y compris Fiddler, vscode, np++, 7zip, ULS Viewer) est installée. Les machines SharePoint disposent d’un réglage précis supplémentaire pour les rendre immédiatement utilisables (outils d’administration à distance, stratégies personnalisées pour Edge et Chrome, raccourcis, etc.).

Définition de ressource Terraform (fournisseur AzAPI)

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

• Groupe 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@2022-03-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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é

Microsoft.Compute/virtualMachines/runCommands

Nom	Description	Valeur
emplacement	Emplacement des ressources	chaîne (obligatoire)
nom	Nom 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
Propriétés	Décrit les propriétés d’une commande d’exécution de machine virtuelle.	VirtualMachineRunCommandProperties
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.Compute/virtualMachines/runCommands@2022-03-01 »

ResourceTags

Nom	Description	Valeur

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)

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

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