VirtualMachineRunCommand interface

Paquet:

@azure/arm-compute

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

Extends

TrackedResource

Propriétés

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.
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
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.
instanceView	La machine virtuelle exécute la vue d’instance de commande. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie 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 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
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.
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 défini sur true, toute défaillance dans le script échoue le déploiement et ProvisioningState est marqué comme ayant échoué. Si treatFailureAsDeploymentFailure 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 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 REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie 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	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

Propriétés héritées

id	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
location	Emplacement géographique où réside la ressource
name	Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
tags	Balises de ressource.
type	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

Détails de la propriété

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.

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

errorBlobManagedIdentity?: RunCommandManagedIdentity

Valeur de propriété

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.

errorBlobUri?: string

Valeur de propriété

string

instanceView

La machine virtuelle exécute la vue d’instance de commande. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie 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 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

outputBlobManagedIdentity?: RunCommandManagedIdentity

Valeur de propriété

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.

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 défini sur true, toute défaillance dans le script échoue le déploiement et ProvisioningState est marqué comme ayant échoué. Si treatFailureAsDeploymentFailure 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 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 REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie 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

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

treatFailureAsDeploymentFailure?: boolean

Valeur de propriété

boolean

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

id

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

id?: string

Valeur de propriété

string

héritée deTrackedResource.id

location

Emplacement géographique où réside la ressource

location: string

Valeur de propriété

string

héritée deTrackedResource.location

name

Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

name?: string

Valeur de propriété

string

héritée deTrackedResource.name

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

systemData?: SystemData

Valeur de propriété

SystemData

héritée deTrackedResource.systemData

tags

Balises de ressource.

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

Valeur de propriété

{[propertyName: string]: string}

héritée deTrackedResource.tags

type

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

type?: string

Valeur de propriété

string

héritée deTrackedResource.type