Share via

DedicatedHostsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ComputeManagementClient's

<xref:dedicated_hosts> attribute.

Inheritance
builtins.object
DedicatedHostsOperations

Constructor

DedicatedHostsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update a dedicated host .
begin_delete

Delete a dedicated host.
begin_restart

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 for more details.
begin_update

Update a dedicated host .
get

Retrieves information about a dedicated host.
list_available_sizes

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

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.

begin_create_or_update

Create or update a dedicated host .

async 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) -> AsyncLROPoller[_models.DedicatedHost]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
host_group_name
Required
str

The name of the dedicated host group. Required.
host_name
Required
str

The name of the dedicated host . Required.
parameters
Required
DedicatedHost or IO[bytes]

Parameters supplied to the Create Dedicated Host. Is either a DedicatedHost type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[DedicatedHost]

An instance of AsyncLROPoller that returns either DedicatedHost or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a dedicated host.

async begin_delete(resource_group_name: str, host_group_name: str, host_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
host_group_name
Required
str

The name of the dedicated host group. Required.
host_name
Required
str

The name of the dedicated host. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_restart

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 for more details.

async begin_restart(resource_group_name: str, host_group_name: str, host_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
host_group_name
Required
str

The name of the dedicated host group. Required.
host_name
Required
str

The name of the dedicated host. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

Update a dedicated host .

async begin_update(resource_group_name: str, host_group_name: str, host_name: str, parameters: _models.DedicatedHostUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.DedicatedHost]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
host_group_name
Required
str

The name of the dedicated host group. Required.
host_name
Required
str

The name of the dedicated host . Required.
parameters
Required
DedicatedHostUpdate or IO[bytes]

Parameters supplied to the Update Dedicated Host operation. Is either a DedicatedHostUpdate type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[DedicatedHost]

An instance of AsyncLROPoller that returns either DedicatedHost or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Retrieves information about a dedicated host.

async get(resource_group_name: str, host_group_name: str, host_name: str, *, expand: str | InstanceViewTypes | None = None, **kwargs: Any) -> DedicatedHost

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
host_group_name
Required
str

The name of the dedicated host group. Required.
host_name
Required
str

The name of the dedicated host. Required.

Keyword-Only Parameters

Name Description
expand
str or InstanceViewTypes

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.

Returns

Type Description
DedicatedHost

DedicatedHost or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_available_sizes

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.

list_available_sizes(resource_group_name: str, host_group_name: str, host_name: str, **kwargs: Any) -> AsyncIterable[str]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
host_group_name
Required
str

The name of the dedicated host group. Required.
host_name
Required
str

The name of the dedicated host. Required.

Returns

Type Description
AsyncItemPaged[str]

An iterator like instance of either str or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_host_group

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.

list_by_host_group(resource_group_name: str, host_group_name: str, **kwargs: Any) -> AsyncIterable[DedicatedHost]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
host_group_name
Required
str

The name of the dedicated host group. Required.

Returns

Type Description
AsyncItemPaged[DedicatedHost]

An iterator like instance of either DedicatedHost or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.compute.v2023_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2023_03_01\\models\\__init__.py'>