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_update

Update an dedicated host .
get

Retrieves information about a 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 .

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 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
LROPoller[DedicatedHost]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a dedicated host.

begin_delete(resource_group_name: str, host_group_name: str, host_name: str, **kwargs: Any) -> LROPoller[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
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_update

Update an dedicated host .

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 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
LROPoller[DedicatedHost]

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

Exceptions

Type Description
HttpResponseError

get

Retrieves information about a dedicated host.

get(resource_group_name: str, host_group_name: str, host_name: str, *, expand: Literal['instanceView'] = 'instanceView', **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

The expand expression to apply on the operation. Known values are "instanceView" and None. Default value is "instanceView".

Returns

Type Description
DedicatedHost

DedicatedHost 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) -> Iterable[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
ItemPaged[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.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'>