Partager via


Microsoft.Compute virtualMachines/runCommands

Définition de ressource Bicep

Le type de ressource 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/virtualMachines/runCommands, ajoutez le Bicep suivant à votre modèle.

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

Valeurs de propriétés

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.
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
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 le démarrage du script et n’attend pas la fin du script. bool
errorBlobManagedIdentity Identité managée affectée par l’utilisateur qui a accès à l’objet blob de stockage errorBlobUri. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’identité managée a reçu l’accès au conteneur d’objets blob avec l’attribution de rôle « Contributeur aux données Blob de stockage ». Dans le cas d’une identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et exécuter la commande, reportez-vous à https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Spécifie l’objet blob de stockage Azure où le flux d’erreurs de script sera chargé. Utilisez un URI SAS avec accès en lecture, ajout, création, écriture OU utiliser une identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre errorBlobManagedIdentity. string
outputBlobManagedIdentity Identité managée affectée par l’utilisateur qui a accès à l’objet blob de stockage outputBlobUri. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’identité managée a reçu l’accès au conteneur d’objets blob avec l’attribution de rôle « Contributeur aux données Blob de stockage ». Dans le cas d’une identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et exécuter la commande, reportez-vous à https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Spécifie l’objet blob de stockage Azure où le flux de sortie de script sera chargé. Utilisez un URI SAS avec accès en lecture, ajout, création, écriture OU utiliser une identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre outputBlobManagedIdentity. 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
treatFailureAsDeploymentFailure facultatif. Si la valeur est true, tout échec dans le script échoue dans le déploiement et ProvisioningState est marqué comme Ayant échoué. Si la valeur est false, ProvisioningState indique uniquement si la commande d’exécution a été exécutée ou non par la plateforme d’extensions, elle n’indique pas si le script a échoué en cas d’échec de script. Consultez instance vue de la commande d’exécution en cas d’échecs de script pour voir executionMessage, output, error :https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

Nom Description Valeur
clientId ID client (valeur GUID) de l’identité managée affectée par l’utilisateur. ObjectId ne doit pas être utilisé s’il est fourni. string
objectId ID d’objet (valeur GUID) de l’identité managée affectée par l’utilisateur. ClientId ne doit pas être utilisé s’il est fourni. string

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. Il peut s’agir d’UN URI SAS d’un objet blob de stockage Azure avec accès en lecture ou d’UN URI public. string
scriptUriManagedIdentity Identité managée affectée par l’utilisateur qui a accès à scriptUri dans le cas d’un objet blob de stockage Azure. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’objet blob de stockage Azure existe et que l’identité managée a reçu l’accès au conteneur de l’objet blob avec l’attribution de rôle « Lecteur de données blob de stockage ». Dans le cas d’une identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et exécuter la commande, reportez-vous à https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

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 configurés

Déployer sur Azure
Ce modèle crée une batterie de serveurs Abonnement SharePoint /2019/2016/2013 avec une configuration étendue qui prendrait du temps à effectuer manuellement, y compris une authentification fédérée avec ADFS, une approbation OAuth, le service Profils utilisateur et une application web avec 2 zones qui contient plusieurs collections de sites basées sur des chemins d’accès et nommées par l’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 ressources de modèle ARM

Le type de ressource 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/virtualMachines/runCommands, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriétés

virtualMachines/runCommands

Nom Description Valeur
type Type de ressource 'Microsoft.Compute/virtualMachines/runCommands'
apiVersion Version de l’API de ressource '2023-09-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
errorBlobManagedIdentity Identité managée affectée par l’utilisateur qui a accès à l’objet blob de stockage errorBlobUri. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’identité managée a reçu l’accès au conteneur d’objets blob avec l’attribution de rôle « Contributeur aux données Blob de stockage ». Dans le cas d’une identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et exécuter la commande, reportez-vous à https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Spécifie l’objet blob de stockage Azure où le flux d’erreurs de script sera chargé. Utilisez un URI SAS avec accès en lecture, ajout, création, écriture OU utiliser une identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre errorBlobManagedIdentity. string
outputBlobManagedIdentity Identité managée affectée par l’utilisateur qui a accès à l’objet blob de stockage outputBlobUri. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’identité managée a reçu l’accès au conteneur d’objets blob avec l’attribution de rôle « Contributeur aux données Blob de stockage ». Dans le cas d’une identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et exécuter la commande, reportez-vous à https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Spécifie l’objet blob de stockage Azure où le flux de sortie de script sera chargé. Utilisez un URI SAS avec accès en lecture, ajout, création, écriture OU utiliser une identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre outputBlobManagedIdentity. 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
treatFailureAsDeploymentFailure facultatif. Si la valeur est true, tout échec dans le script échoue dans le déploiement et ProvisioningState est marqué comme Ayant échoué. Si la valeur est false, ProvisioningState indique uniquement si la commande d’exécution a été exécutée ou non par la plateforme d’extensions, elle n’indique pas si le script a échoué en cas d’échec de script. Consultez instance vue de la commande d’exécution en cas d’échecs de script pour voir executionMessage, output, error :https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

Nom Description Valeur
clientId ID client (valeur GUID) de l’identité managée affectée par l’utilisateur. ObjectId ne doit pas être utilisé s’il est fourni. string
objectId ID d’objet (valeur GUID) de l’identité managée affectée par l’utilisateur. ClientId ne doit pas être utilisé s’il est fourni. string

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. Il peut s’agir d’UN URI SAS d’un objet blob de stockage Azure avec accès en lecture ou d’UN URI public. string
scriptUriManagedIdentity Identité managée affectée par l’utilisateur qui a accès à scriptUri dans le cas d’un objet blob de stockage Azure. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’objet blob de stockage Azure existe et que l’identité managée a reçu l’accès au conteneur de l’objet blob avec l’attribution de rôle « Lecteur de données blob de stockage ». Dans le cas d’une identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et exécuter la commande, reportez-vous à https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

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 configurés

Déployer sur Azure
Ce modèle crée une batterie de serveurs Abonnement SharePoint /2019/2016/2013 avec une configuration étendue qui prendrait du temps à effectuer manuellement, y compris une authentification fédérée avec ADFS, une approbation OAuth, le service Profils utilisateur et une application web avec 2 zones qui contient plusieurs collections de sites basées sur des chemins d’accès et nommées par l’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 d’API, consultez journal des modifications.

Format des ressources

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@2023-09-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
    }
  })
}

Valeurs de propriétés

virtualMachines/runCommands

Nom Description Valeur
type Type de ressource « Microsoft.Compute/virtualMachines/runCommands@2023-09-01 »
name Nom de la ressource string (obligatoire)
location Emplacement de la ressource string (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 le démarrage du script et n’attend pas la fin du script. bool
errorBlobManagedIdentity Identité managée affectée par l’utilisateur qui a accès à l’objet blob de stockage errorBlobUri. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’identité managée a reçu l’accès au conteneur d’objets blob avec l’attribution de rôle « Contributeur aux données Blob de stockage ». Dans le cas d’une identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et exécuter la commande, reportez-vous à https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Spécifie l’objet blob de stockage Azure où le flux d’erreurs de script sera chargé. Utilisez un URI SAS avec accès en lecture, ajout, création, écriture OU utiliser une identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre errorBlobManagedIdentity. string
outputBlobManagedIdentity Identité managée affectée par l’utilisateur qui a accès à l’objet blob de stockage outputBlobUri. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’identité managée a reçu l’accès au conteneur d’objets blob avec l’attribution de rôle « Contributeur aux données Blob de stockage ». Dans le cas d’une identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et exécuter la commande, reportez-vous à https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Spécifie l’objet blob de stockage Azure où le flux de sortie de script sera chargé. Utilisez un URI SAS avec accès en lecture, ajout, création, écriture OU utiliser une identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre outputBlobManagedIdentity. 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
treatFailureAsDeploymentFailure facultatif. Si la valeur est true, tout échec dans le script échoue dans le déploiement et ProvisioningState est marqué comme Ayant échoué. Si la valeur est false, ProvisioningState indique uniquement si la commande d’exécution a été exécutée ou non par la plateforme d’extensions, elle n’indique pas si le script a échoué en cas d’échec de script. Consultez instance vue de la commande d’exécution en cas d’échecs de script pour voir executionMessage, output, error :https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

Nom Description Valeur
clientId ID client (valeur GUID) de l’identité managée affectée par l’utilisateur. ObjectId ne doit pas être utilisé s’il est fourni. string
objectId ID d’objet (valeur GUID) de l’identité managée affectée par l’utilisateur. ClientId ne doit pas être utilisé s’il est fourni. string

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 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. Il peut s’agir d’UN URI SAS d’un objet blob de stockage Azure avec accès en lecture ou d’UN URI public. string
scriptUriManagedIdentity Identité managée affectée par l’utilisateur qui a accès à scriptUri dans le cas d’un objet blob de stockage Azure. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’objet blob de stockage Azure existe et que l’identité managée a accès au conteneur de l’objet blob avec l’attribution de rôle « Lecteur de données blob de stockage ». En cas d’identité affectée par l’utilisateur, veillez à l’ajouter sous identité de machine virtuelle. Pour plus d’informations sur l’identité managée et exécuter la commande, reportez-vous à https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged. RunCommandManagedIdentity