Partager via

Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2023-07-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 de ressource

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

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

Valeurs de propriété

Microsoft.Compute/virtualMachineScaleSets/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 : virtualMachineScaleSets/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)

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é si cela est fourni. corde
objectId ID d’objet (valeur GUID) de l’identité managée affectée par l’utilisateur. ClientId ne doit pas être utilisé si cela est fourni. corde

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
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 de l’objet blob avec l’attribution de rôle « Contributeur aux données blob de stockage ». En cas d’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, consultez https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged runCommandManagedIdentity
errorBlobUri Spécifie l’objet blob de stockage Azure dans lequel le flux d’erreurs de script sera chargé. Utilisez un URI SAP avec lecture, ajout, création, accès en écriture OU utiliser l’identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre errorBlobManagedIdentity. corde
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 de l’objet blob avec l’attribution de rôle « Contributeur aux données blob de stockage ». En cas d’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, consultez https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged runCommandManagedIdentity
outputBlobUri Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé. Utilisez un URI SAP avec lecture, ajout, création, accès en écriture OU utiliser l’identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre outputBlobManagedIdentity. 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
treatFailureAsDeploymentFailure Optionnel. Si la valeur est true, tout échec dans le script échoue 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 la vue d’instance de la commande d’exécution en cas d’échecs de script pour voir executionMessage, sortie, erreur : https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

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. Il peut s’agir de l’URI SAP d’un objet blob de stockage Azure avec accès en lecture ou URI public. corde
scriptUriManagedIdentity Identité managée affectée par l’utilisateur qui a accès à scriptUri en cas d’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 été attribuée au conteneur de l’objet blob avec l’attribution de rôle « Lecteur de données blob du stockage ». En cas d’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 la commande Exécuter, reportez-vous https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged. runCommandManagedIdentity

Définition de ressource 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 de l’API, consultez journal des modifications.

Format de ressource

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": "2023-07-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"
  }
}

Valeurs de propriété

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Nom Description Valeur
apiVersion Version de l’API '2023-07-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/virtualMachineScaleSets/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)

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é si cela est fourni. corde
objectId ID d’objet (valeur GUID) de l’identité managée affectée par l’utilisateur. ClientId ne doit pas être utilisé si cela est fourni. corde

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
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 de l’objet blob avec l’attribution de rôle « Contributeur aux données blob de stockage ». En cas d’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, consultez https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged runCommandManagedIdentity
errorBlobUri Spécifie l’objet blob de stockage Azure dans lequel le flux d’erreurs de script sera chargé. Utilisez un URI SAP avec lecture, ajout, création, accès en écriture OU utiliser l’identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre errorBlobManagedIdentity. corde
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 de l’objet blob avec l’attribution de rôle « Contributeur aux données blob de stockage ». En cas d’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, consultez https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged runCommandManagedIdentity
outputBlobUri Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé. Utilisez un URI SAP avec lecture, ajout, création, accès en écriture OU utiliser l’identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre outputBlobManagedIdentity. 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
treatFailureAsDeploymentFailure Optionnel. Si la valeur est true, tout échec dans le script échoue 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 la vue d’instance de la commande d’exécution en cas d’échecs de script pour voir executionMessage, sortie, erreur : https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

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. Il peut s’agir de l’URI SAP d’un objet blob de stockage Azure avec accès en lecture ou URI public. corde
scriptUriManagedIdentity Identité managée affectée par l’utilisateur qui a accès à scriptUri en cas d’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 été attribuée au conteneur de l’objet blob avec l’attribution de rôle « Lecteur de données blob du stockage ». En cas d’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 la commande Exécuter, reportez-vous https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged. runCommandManagedIdentity

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

Format de ressource

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

Valeurs de propriété

Microsoft.Compute/virtualMachineScaleSets/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 : virtualMachineScaleSets/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/virtualMachineScaleSets/virtualMachines/runCommands@2023-07-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)

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é si cela est fourni. corde
objectId ID d’objet (valeur GUID) de l’identité managée affectée par l’utilisateur. ClientId ne doit pas être utilisé si cela est fourni. corde

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
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 de l’objet blob avec l’attribution de rôle « Contributeur aux données blob de stockage ». En cas d’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, consultez https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged runCommandManagedIdentity
errorBlobUri Spécifie l’objet blob de stockage Azure dans lequel le flux d’erreurs de script sera chargé. Utilisez un URI SAP avec lecture, ajout, création, accès en écriture OU utiliser l’identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre errorBlobManagedIdentity. corde
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 de l’objet blob avec l’attribution de rôle « Contributeur aux données blob de stockage ». En cas d’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, consultez https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged runCommandManagedIdentity
outputBlobUri Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé. Utilisez un URI SAP avec lecture, ajout, création, accès en écriture OU utiliser l’identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre outputBlobManagedIdentity. 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
treatFailureAsDeploymentFailure Optionnel. Si la valeur est true, tout échec dans le script échoue 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 la vue d’instance de la commande d’exécution en cas d’échecs de script pour voir executionMessage, sortie, erreur : https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

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. Il peut s’agir de l’URI SAP d’un objet blob de stockage Azure avec accès en lecture ou URI public. corde
scriptUriManagedIdentity Identité managée affectée par l’utilisateur qui a accès à scriptUri en cas d’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 été attribuée au conteneur de l’objet blob avec l’attribution de rôle « Lecteur de données blob du stockage ». En cas d’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 la commande Exécuter, reportez-vous https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged. runCommandManagedIdentity