azure.mgmt.compute.v2023_03_01.models.VirtualMachineRunCommand.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2023_03_01.models.VirtualMachineRunCommand
name: VirtualMachineRunCommand
fullName: azure.mgmt.compute.v2023_03_01.models.VirtualMachineRunCommand
module: azure.mgmt.compute.v2023_03_01.models
inheritances:
- azure.mgmt.compute.v2023_03_01.models._models_py3.Resource
summary: 'Describes a Virtual Machine run command.


  Variables are only populated by the server, and will be ignored when sending a request.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: '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)'
  keywordOnlyParameters:
  - name: location
    description: Resource location. Required.
    types:
    - <xref:str>
  - name: tags
    description: Resource tags.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: source
    description: The source of the run command script.
    types:
    - <xref:azure.mgmt.compute.v2023_03_01.models.VirtualMachineRunCommandScriptSource>
  - name: parameters
    description: The parameters used by the script.
    types:
    - <xref:list>[<xref:azure.mgmt.compute.v2023_03_01.models.RunCommandInputParameter>]
  - name: protected_parameters
    description: The parameters used by the script.
    types:
    - <xref:list>[<xref:azure.mgmt.compute.v2023_03_01.models.RunCommandInputParameter>]
  - name: async_execution
    description: 'Optional. If set to true, provisioning will complete as soon as
      the

      script starts and will not wait for script to complete.'
    types:
    - <xref:bool>
  - name: run_as_user
    description: Specifies the user account on the VM when executing the run command.
    types:
    - <xref:str>
  - name: run_as_password
    description: 'Specifies the user account password on the VM when executing the
      run

      command.'
    types:
    - <xref:str>
  - name: timeout_in_seconds
    description: The timeout in seconds to execute the run command.
    types:
    - <xref:int>
  - name: output_blob_uri
    description: 'Specifies the Azure storage blob where script output stream will
      be

      uploaded. Use a SAS URI with read, append, create, write access OR use managed
      identity to

      provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.'
    types:
    - <xref:str>
  - name: error_blob_uri
    description: 'Specifies the Azure storage blob where script error stream will
      be

      uploaded. Use a SAS URI with read, append, create, write access OR use managed
      identity to

      provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.'
    types:
    - <xref:str>
  - name: output_blob_managed_identity
    description: 'User-assigned managed identity that has access to

      outputBlobUri storage blob. Use an empty object in case of system-assigned identity.
      Make sure

      managed identity has been given access to blob''s container with ''Storage Blob
      Data Contributor''

      role assignment. In case of user-assigned identity, make sure you add it under
      VM''s identity.

      For more info on managed identity and Run Command, refer [https://aka.ms/ManagedIdentity](https://aka.ms/ManagedIdentity)
      and

      [https://aka.ms/RunCommandManaged](https://aka.ms/RunCommandManaged).'
    types:
    - <xref:azure.mgmt.compute.v2023_03_01.models.RunCommandManagedIdentity>
  - name: error_blob_managed_identity
    description: 'User-assigned managed identity that has access to

      errorBlobUri storage blob. Use an empty object in case of system-assigned identity.
      Make sure

      managed identity has been given access to blob''s container with ''Storage Blob
      Data Contributor''

      role assignment. In case of user-assigned identity, make sure you add it under
      VM''s identity.

      For more info on managed identity and Run Command, refer [https://aka.ms/ManagedIdentity](https://aka.ms/ManagedIdentity)
      and

      [https://aka.ms/RunCommandManaged](https://aka.ms/RunCommandManaged).'
    types:
    - <xref:azure.mgmt.compute.v2023_03_01.models.RunCommandManagedIdentity>
  - name: treat_failure_as_deployment_failure
    description: 'Optional. If set to true, any failure in the

      script will fail the deployment and ProvisioningState will be marked as Failed.
      If set to

      false, ProvisioningState would only reflect whether the run command was run
      or not by the

      extensions platform, it would not indicate whether script failed in case of
      script failures.

      See instance view of run command in case of script failures to see executionMessage,
      output,

      error: [https://aka.ms/runcommandmanaged#get-execution-status-and-results](https://aka.ms/runcommandmanaged#get-execution-status-and-results).'
    types:
    - <xref:bool>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource name.
  name: name
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: Resource location. Required.
  name: location
  types:
  - <xref:str>
- description: Resource tags.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: The source of the run command script.
  name: source
  types:
  - <xref:azure.mgmt.compute.v2023_03_01.models.VirtualMachineRunCommandScriptSource>
- description: The parameters used by the script.
  name: parameters
  types:
  - <xref:list>[<xref:azure.mgmt.compute.v2023_03_01.models.RunCommandInputParameter>]
- description: The parameters used by the script.
  name: protected_parameters
  types:
  - <xref:list>[<xref:azure.mgmt.compute.v2023_03_01.models.RunCommandInputParameter>]
- description: 'Optional. If set to true, provisioning will complete as soon as the

    script starts and will not wait for script to complete.'
  name: async_execution
  types:
  - <xref:bool>
- description: Specifies the user account on the VM when executing the run command.
  name: run_as_user
  types:
  - <xref:str>
- description: 'Specifies the user account password on the VM when executing the run

    command.'
  name: run_as_password
  types:
  - <xref:str>
- description: The timeout in seconds to execute the run command.
  name: timeout_in_seconds
  types:
  - <xref:int>
- description: 'Specifies the Azure storage blob where script output stream will be

    uploaded. Use a SAS URI with read, append, create, write access OR use managed
    identity to

    provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.'
  name: output_blob_uri
  types:
  - <xref:str>
- description: 'Specifies the Azure storage blob where script error stream will be

    uploaded. Use a SAS URI with read, append, create, write access OR use managed
    identity to

    provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.'
  name: error_blob_uri
  types:
  - <xref:str>
- description: 'User-assigned managed identity that has access to

    outputBlobUri storage blob. Use an empty object in case of system-assigned identity.
    Make sure

    managed identity has been given access to blob''s container with ''Storage Blob
    Data Contributor''

    role assignment. In case of user-assigned identity, make sure you add it under
    VM''s identity.

    For more info on managed identity and Run Command, refer [https://aka.ms/ManagedIdentity](https://aka.ms/ManagedIdentity)
    and

    [https://aka.ms/RunCommandManaged](https://aka.ms/RunCommandManaged).'
  name: output_blob_managed_identity
  types:
  - <xref:azure.mgmt.compute.v2023_03_01.models.RunCommandManagedIdentity>
- description: 'User-assigned managed identity that has access to

    errorBlobUri storage blob. Use an empty object in case of system-assigned identity.
    Make sure

    managed identity has been given access to blob''s container with ''Storage Blob
    Data Contributor''

    role assignment. In case of user-assigned identity, make sure you add it under
    VM''s identity.

    For more info on managed identity and Run Command, refer [https://aka.ms/ManagedIdentity](https://aka.ms/ManagedIdentity)
    and

    [https://aka.ms/RunCommandManaged](https://aka.ms/RunCommandManaged).'
  name: error_blob_managed_identity
  types:
  - <xref:azure.mgmt.compute.v2023_03_01.models.RunCommandManagedIdentity>
- description: 'The provisioning state, which only appears in the response. If

    treatFailureAsDeploymentFailure set to true, any failure in the script will fail
    the deployment

    and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure
    set to

    false, ProvisioningState would only reflect whether the run command was run or
    not by the

    extensions platform, it would not indicate whether script failed in case of script
    failures.

    See instance view of run command in case of script failures to see executionMessage,
    output,

    error: [https://aka.ms/runcommandmanaged#get-execution-status-and-results](https://aka.ms/runcommandmanaged#get-execution-status-and-results).'
  name: provisioning_state
  types:
  - <xref:str>
- description: The virtual machine run command instance view.
  name: instance_view
  types:
  - <xref:azure.mgmt.compute.v2023_03_01.models.VirtualMachineRunCommandInstanceView>
- description: 'Optional. If set to true, any failure in the script

    will fail the deployment and ProvisioningState will be marked as Failed. If set
    to false,

    ProvisioningState would only reflect whether the run command was run or not by
    the extensions

    platform, it would not indicate whether script failed in case of script failures.
    See instance

    view of run command in case of script failures to see executionMessage, output,
    error:

    [https://aka.ms/runcommandmanaged#get-execution-status-and-results](https://aka.ms/runcommandmanaged#get-execution-status-and-results).'
  name: treat_failure_as_deployment_failure
  types:
  - <xref:bool>