VirtualMachineRunCommand Classe
Décrit une commande d’exécution de machine virtuelle.
Les variables sont uniquement renseignées par le serveur et sont ignorées lors de l’envoi d’une requête.
Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
- Héritage
-
azure.mgmt.compute.v2023_09_01.models._models_py3.ResourceVirtualMachineRunCommand
Constructeur
VirtualMachineRunCommand(*, location: str, tags: Dict[str, str] | None = None, source: _models.VirtualMachineRunCommandScriptSource | None = None, parameters: List[_models.RunCommandInputParameter] | None = None, protected_parameters: List[_models.RunCommandInputParameter] | None = None, async_execution: bool = False, run_as_user: str | None = None, run_as_password: str | None = None, timeout_in_seconds: int | None = None, output_blob_uri: str | None = None, error_blob_uri: str | None = None, output_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, error_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, treat_failure_as_deployment_failure: bool = False, **kwargs: Any)Keyword-Only Parameters
- location
- str
Emplacement de la ressource. Obligatoire.
Source du script de commande d’exécution.
- parameters
- list[RunCommandInputParameter]
Paramètres utilisés par le script.
- protected_parameters
- list[RunCommandInputParameter]
Paramètres utilisés par le script.
- async_execution
- bool
facultatif. 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.
- run_as_user
- str
Spécifie le compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande run.
- run_as_password
- str
Spécifie le mot de passe du compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande run.
- timeout_in_seconds
- int
Délai d’attente en secondes pour exécuter la commande d’exécution.
- output_blob_uri
- str
Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé. Utilisez un URI SAS avec accès en lecture, ajout, création, écriture OU utilisez une identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre outputBlobManagedIdentity.
- error_blob_uri
- str
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 utilisez une identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre errorBlobManagedIdentity.
- output_blob_managed_identity
- RunCommandManagedIdentity
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. Assurez-vous que l’identité managée a accès au conteneur d’objets 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 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.
- error_blob_managed_identity
- RunCommandManagedIdentity
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. Assurez-vous que l’identité managée a accès au conteneur d’objets 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 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.
- treat_failure_as_deployment_failure
- bool
facultatif. Si la valeur est true, toute défaillance dans le script échouera le déploiement et ProvisioningState sera marqué comme ayant échoué. Si la valeur est false, ProvisioningState indique uniquement si la commande run 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 : https://aka.ms/runcommandmanaged#get-execution-status-and-results.
Variables
- id
- str
ID de ressource.
- name
- str
Nom de la ressource.
- type
- str
Type de ressource.
- location
- str
Emplacement de la ressource. Obligatoire.
Source du script de commande d’exécution.
- parameters
- list[RunCommandInputParameter]
Paramètres utilisés par le script.
- protected_parameters
- list[RunCommandInputParameter]
Paramètres utilisés par le script.
- async_execution
- bool
facultatif. 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.
- run_as_user
- str
Spécifie le compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande run.
- run_as_password
- str
Spécifie le mot de passe du compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande run.
- timeout_in_seconds
- int
Délai d’attente en secondes pour exécuter la commande d’exécution.
- output_blob_uri
- str
Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé. Utilisez un URI SAS avec accès en lecture, ajout, création, écriture OU utilisez une identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre outputBlobManagedIdentity.
- error_blob_uri
- str
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 utilisez une identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre errorBlobManagedIdentity.
- output_blob_managed_identity
- RunCommandManagedIdentity
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. Assurez-vous que l’identité managée a accès au conteneur d’objets 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 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.
- error_blob_managed_identity
- RunCommandManagedIdentity
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. Assurez-vous que l’identité managée a accès au conteneur d’objets 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 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.
- provisioning_state
- str
État d’approvisionnement, qui apparaît uniquement dans la réponse. Si treatFailureAsDeploymentFailure a la valeur true, toute défaillance dans le script échouera le déploiement et ProvisioningState sera marqué comme ayant échoué. Si treatFailureAsDeploymentFailure a la valeur false, ProvisioningState indique uniquement si la commande run a été exécutée ou non par la plateforme d’extensions, il 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 : https://aka.ms/runcommandmanaged#get-execution-status-and-results.
- instance_view
- VirtualMachineRunCommandInstanceView
La commande d’exécution de la machine virtuelle instance vue.
- treat_failure_as_deployment_failure
- bool
facultatif. Si la valeur est true, toute défaillance dans le script échouera le déploiement et ProvisioningState sera marqué comme ayant échoué. Si la valeur est false, ProvisioningState indique uniquement si la commande run 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 : https://aka.ms/runcommandmanaged#get-execution-status-and-results.
Azure SDK for Python