Partager via

VirtualMachineRunCommand interface

  • Référence
Paquet:
@azure/arm-compute

Décrit une commande d’exécution de machine virtuelle.

Extends
Resource

Propriétés

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.
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
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.
instanceView

La commande d’exécution de la machine virtuelle instance vue. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
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
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.
parameters

Paramètres utilisés par le script.
protectedParameters

Paramètres utilisés par le script.
provisioningState

État d’approvisionnement, qui apparaît uniquement dans la réponse. Si treatFailureAsDeploymentFailure est défini sur true, tout échec dans le script échouera le déploiement et ProvisioningState sera marqué comme Failed. Si treatFailureAsDeploymentFailure est défini sur 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’échec de script pour voir executionMessage, output, error: REMARQUE : https://aka.ms/runcommandmanaged#get-execution-status-and-results Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
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.
runAsUser

Spécifie le compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande d’exécution.
source

Source du script de commande d’exécution.
timeoutInSeconds

Délai d’expiration en secondes pour exécuter la commande d’exécution.
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

Propriétés héritées

id

REMARQUE DE l’ID de ressource : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
location

Emplacement de la ressource
name

Remarque : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
tags

Balises de ressource
type

Type de ressource REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

Détails de la propriété

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.

asyncExecution?: boolean

Valeur de propriété

boolean

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

errorBlobManagedIdentity?: RunCommandManagedIdentity

Valeur de propriété

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.

errorBlobUri?: string

Valeur de propriété

string

instanceView

La commande d’exécution de la machine virtuelle instance vue. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

instanceView?: VirtualMachineRunCommandInstanceView

Valeur de propriété

VirtualMachineRunCommandInstanceView

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

outputBlobManagedIdentity?: RunCommandManagedIdentity

Valeur de propriété

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.

outputBlobUri?: string

Valeur de propriété

string

parameters

Paramètres utilisés par le script.

parameters?: RunCommandInputParameter[]

Valeur de propriété

RunCommandInputParameter[]

protectedParameters

Paramètres utilisés par le script.

protectedParameters?: RunCommandInputParameter[]

Valeur de propriété

RunCommandInputParameter[]

provisioningState

État d’approvisionnement, qui apparaît uniquement dans la réponse. Si treatFailureAsDeploymentFailure est défini sur true, tout échec dans le script échouera le déploiement et ProvisioningState sera marqué comme Failed. Si treatFailureAsDeploymentFailure est défini sur 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’échec de script pour voir executionMessage, output, error: REMARQUE : https://aka.ms/runcommandmanaged#get-execution-status-and-results Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

provisioningState?: string

Valeur de propriété

string

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.

runAsPassword?: string

Valeur de propriété

string

runAsUser

Spécifie le compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande d’exécution.

runAsUser?: string

Valeur de propriété

string

source

Source du script de commande d’exécution.

source?: VirtualMachineRunCommandScriptSource

Valeur de propriété

VirtualMachineRunCommandScriptSource

timeoutInSeconds

Délai d’expiration en secondes pour exécuter la commande d’exécution.

timeoutInSeconds?: number

Valeur de propriété

number

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

treatFailureAsDeploymentFailure?: boolean

Valeur de propriété

boolean

Détails de la propriété héritée

id

REMARQUE DE l’ID de ressource : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

id?: string

Valeur de propriété

string

Hérité deResource.id

location

Emplacement de la ressource

location: string

Valeur de propriété

string

Hérité deResource.location

name

Remarque : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

name?: string

Valeur de propriété

string

Hérité deResource.name

tags

Balises de ressource

tags?: {[propertyName: string]: string}

Valeur de propriété

{[propertyName: string]: string}

Hérité deResource.tags

type

Type de ressource REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

type?: string

Valeur de propriété

string

Hérité deResource.type