azure.mgmt.compute.v2024_03_01.operations.DedicatedHostsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2024_03_01.operations.DedicatedHostsOperations
name: DedicatedHostsOperations
fullName: azure.mgmt.compute.v2024_03_01.operations.DedicatedHostsOperations
module: azure.mgmt.compute.v2024_03_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.v2024_03_01.ComputeManagementClient>'s\n\
  >\n> <xref:dedicated_hosts> attribute.\n>"
constructor:
  syntax: DedicatedHostsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2024_03_01.operations.DedicatedHostsOperations.begin_create_or_update
  name: begin_create_or_update
  summary: Create or update a dedicated host .
  signature: 'begin_create_or_update(resource_group_name: str, host_group_name: str,
    host_name: str, parameters: _models.DedicatedHost, *, content_type: str = ''application/json'',
    **kwargs: Any) -> LROPoller[_models.DedicatedHost]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_group_name
    description: The name of the dedicated host group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_name
    description: The name of the dedicated host . Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the Create Dedicated Host. Is either a DedicatedHost

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

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2024_03_01.models.DedicatedHost>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2024_03_01.operations.DedicatedHostsOperations.begin_delete
  name: begin_delete
  summary: Delete a dedicated host.
  signature: 'begin_delete(resource_group_name: str, host_group_name: str, host_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: host_group_name
    description: The name of the dedicated host group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_name
    description: The name of the dedicated host. 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.v2024_03_01.operations.DedicatedHostsOperations.begin_redeploy
  name: begin_redeploy
  summary: 'Redeploy the dedicated host. The operation will complete successfully
    once the dedicated host

    has migrated to a new node and is running. To determine the health of VMs deployed
    on the

    dedicated host after the redeploy check the Resource Health Center in the Azure
    Portal. Please

    refer to [https://docs.microsoft.com/azure/service-health/resource-health-overview](https://docs.microsoft.com/azure/service-health/resource-health-overview)
    for more

    details.'
  signature: 'begin_redeploy(resource_group_name: str, host_group_name: str, host_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: host_group_name
    description: The name of the dedicated host group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_name
    description: The name of the dedicated host. 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.v2024_03_01.operations.DedicatedHostsOperations.begin_restart
  name: begin_restart
  summary: 'Restart the dedicated host. The operation will complete successfully once
    the dedicated host

    has restarted and is running. To determine the health of VMs deployed on the dedicated
    host

    after the restart check the Resource Health Center in the Azure Portal. Please
    refer to

    [https://docs.microsoft.com/azure/service-health/resource-health-overview](https://docs.microsoft.com/azure/service-health/resource-health-overview)
    for more details.'
  signature: 'begin_restart(resource_group_name: str, host_group_name: str, host_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: host_group_name
    description: The name of the dedicated host group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_name
    description: The name of the dedicated host. 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.v2024_03_01.operations.DedicatedHostsOperations.begin_update
  name: begin_update
  summary: Update a dedicated host .
  signature: 'begin_update(resource_group_name: str, host_group_name: str, host_name:
    str, parameters: _models.DedicatedHostUpdate, *, content_type: str = ''application/json'',
    **kwargs: Any) -> LROPoller[_models.DedicatedHost]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_group_name
    description: The name of the dedicated host group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_name
    description: The name of the dedicated host . Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to the Update Dedicated Host operation. Is either
      a

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

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2024_03_01.models.DedicatedHost>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2024_03_01.operations.DedicatedHostsOperations.get
  name: get
  summary: Retrieves information about a dedicated host.
  signature: 'get(resource_group_name: str, host_group_name: str, host_name: str,
    *, expand: str | InstanceViewTypes | None = None, **kwargs: Any) -> DedicatedHost'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_group_name
    description: The name of the dedicated host group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_name
    description: The name of the dedicated host. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: expand
    description: 'The expand expression to apply on the operation. ''InstanceView''
      will retrieve

      the list of instance views of the dedicated host. ''UserData'' is not supported
      for dedicated

      host. Known values are: "instanceView" and "userData". Default value is None.'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2024_03_01.models.InstanceViewTypes>
  return:
    description: DedicatedHost or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2024_03_01.models.DedicatedHost>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2024_03_01.operations.DedicatedHostsOperations.list_available_sizes
  name: list_available_sizes
  summary: 'Lists all available dedicated host sizes to which the specified dedicated
    host can be resized.

    NOTE: The dedicated host sizes provided can be used to only scale up the existing
    dedicated

    host.'
  signature: 'list_available_sizes(resource_group_name: str, host_group_name: str,
    host_name: str, **kwargs: Any) -> Iterable[str]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_group_name
    description: The name of the dedicated host group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_name
    description: The name of the dedicated host. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either str or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:str>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2024_03_01.operations.DedicatedHostsOperations.list_by_host_group
  name: list_by_host_group
  summary: 'Lists all of the dedicated hosts in the specified dedicated host group.
    Use the nextLink

    property in the response to get the next page of dedicated hosts.'
  signature: 'list_by_host_group(resource_group_name: str, host_group_name: str, **kwargs:
    Any) -> Iterable[DedicatedHost]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: host_group_name
    description: The name of the dedicated host group. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either DedicatedHost or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2024_03_01.models.DedicatedHost>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2024_03_01.operations.DedicatedHostsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.compute.v2024_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2024_03_01\\models\\__init__.py'>