azure.mgmt.compute.v2020_12_01.operations.VirtualMachineRunCommandsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2020_12_01.operations.VirtualMachineRunCommandsOperations
name: VirtualMachineRunCommandsOperations
fullName: azure.mgmt.compute.v2020_12_01.operations.VirtualMachineRunCommandsOperations
module: azure.mgmt.compute.v2020_12_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.compute.v2020_12_01.ComputeManagementClient>'s\n\
  >\n> <xref:virtual_machine_run_commands> attribute.\n>"
constructor:
  syntax: VirtualMachineRunCommandsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2020_12_01.operations.VirtualMachineRunCommandsOperations.begin_create_or_update
  name: begin_create_or_update
  summary: The operation to create or update the run command.
  signature: 'begin_create_or_update(resource_group_name: str, vm_name: str, run_command_name:
    str, run_command: _models.VirtualMachineRunCommand, *, content_type: str = ''application/json'',
    **kwargs: Any) -> LROPoller[_models.VirtualMachineRunCommand]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_name
    description: 'The name of the virtual machine where the run command should be
      created or

      updated. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: run_command_name
    description: The name of the virtual machine run command. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: run_command
    description: 'Parameters supplied to the Create Virtual Machine RunCommand operation.
      Is

      either a VirtualMachineRunCommand type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2020_12_01.models.VirtualMachineRunCommand>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of LROPoller that returns either VirtualMachineRunCommand
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2020_12_01.models.VirtualMachineRunCommand>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_12_01.operations.VirtualMachineRunCommandsOperations.begin_delete
  name: begin_delete
  summary: The operation to delete the run command.
  signature: 'begin_delete(resource_group_name: str, vm_name: str, run_command_name:
    str, **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_name
    description: 'The name of the virtual machine where the run command should be
      deleted.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: run_command_name
    description: The name of the virtual machine run command. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_12_01.operations.VirtualMachineRunCommandsOperations.begin_update
  name: begin_update
  summary: The operation to update the run command.
  signature: 'begin_update(resource_group_name: str, vm_name: str, run_command_name:
    str, run_command: _models.VirtualMachineRunCommandUpdate, *, content_type: str
    = ''application/json'', **kwargs: Any) -> LROPoller[_models.VirtualMachineRunCommand]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_name
    description: 'The name of the virtual machine where the run command should be
      updated.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: run_command_name
    description: The name of the virtual machine run command. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: run_command
    description: 'Parameters supplied to the Update Virtual Machine RunCommand operation.
      Is

      either a VirtualMachineRunCommandUpdate type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2020_12_01.models.VirtualMachineRunCommandUpdate>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of LROPoller that returns either VirtualMachineRunCommand
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2020_12_01.models.VirtualMachineRunCommand>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_12_01.operations.VirtualMachineRunCommandsOperations.get
  name: get
  summary: Gets specific run command for a subscription in a location.
  signature: 'get(location: str, command_id: str, **kwargs: Any) -> RunCommandDocument'
  parameters:
  - name: location
    description: The location upon which run commands is queried. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: command_id
    description: The command id. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: RunCommandDocument or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2020_12_01.models.RunCommandDocument>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_12_01.operations.VirtualMachineRunCommandsOperations.get_by_virtual_machine
  name: get_by_virtual_machine
  summary: The operation to get the run command.
  signature: 'get_by_virtual_machine(resource_group_name: str, vm_name: str, run_command_name:
    str, *, expand: str | None = None, **kwargs: Any) -> VirtualMachineRunCommand'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_name
    description: The name of the virtual machine containing the run command. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: run_command_name
    description: The name of the virtual machine run command. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: expand
    description: The expand expression to apply on the operation. Default value is
      None.
    types:
    - <xref:str>
  return:
    description: VirtualMachineRunCommand or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2020_12_01.models.VirtualMachineRunCommand>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_12_01.operations.VirtualMachineRunCommandsOperations.list
  name: list
  summary: Lists all available run commands for a subscription in a location.
  signature: 'list(location: str, **kwargs: Any) -> Iterable[RunCommandDocumentBase]'
  parameters:
  - name: location
    description: The location upon which run commands is queried. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: 'An iterator like instance of either RunCommandDocumentBase or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2020_12_01.models.RunCommandDocumentBase>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2020_12_01.operations.VirtualMachineRunCommandsOperations.list_by_virtual_machine
  name: list_by_virtual_machine
  summary: The operation to get all run commands of a Virtual Machine.
  signature: 'list_by_virtual_machine(resource_group_name: str, vm_name: str, *, expand:
    str | None = None, **kwargs: Any) -> Iterable[VirtualMachineRunCommand]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: vm_name
    description: The name of the virtual machine containing the run command. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: expand
    description: The expand expression to apply on the operation. Default value is
      None.
    types:
    - <xref:str>
  return:
    description: 'An iterator like instance of either VirtualMachineRunCommand or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2020_12_01.models.VirtualMachineRunCommand>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2020_12_01.operations.VirtualMachineRunCommandsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.compute.v2020_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2020_12_01\\models\\__init__.py'>