DedicatedHostsOperations Class

DedicatedHostsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
DedicatedHostsOperations

Constructor

DedicatedHostsOperations(client, config, serializer, deserializer) -> None

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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: azure.mgmt.compute.v2019_12_01.models._models_py3.DedicatedHost, **kwargs: typing.Any) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('_models.DedicatedHost')]

Parameters

resource_group_name
str
Required

The name of the resource group.

host_group_name
str
Required

The name of the dedicated host group.

host_name
str
Required

The name of the dedicated host .

parameters
DedicatedHost
Required

Parameters supplied to the Create Dedicated Host.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Delete a dedicated host.

begin_delete(resource_group_name: str, host_group_name: str, host_name: str, **kwargs: typing.Any) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name
str
Required

The name of the resource group.

host_group_name
str
Required

The name of the dedicated host group.

host_name
str
Required

The name of the dedicated host.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_update

Update an dedicated host .

begin_update(resource_group_name: str, host_group_name: str, host_name: str, parameters: azure.mgmt.compute.v2019_12_01.models._models_py3.DedicatedHostUpdate, **kwargs: typing.Any) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('_models.DedicatedHost')]

Parameters

resource_group_name
str
Required

The name of the resource group.

host_group_name
str
Required

The name of the dedicated host group.

host_name
str
Required

The name of the dedicated host .

parameters
DedicatedHostUpdate
Required

Parameters supplied to the Update Dedicated Host operation.

cls
callable

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

get

Retrieves information about a dedicated host.

get(resource_group_name: str, host_group_name: str, host_name: str, expand: typing.Union[str, NoneType] = 'instanceView', **kwargs: typing.Any) -> azure.mgmt.compute.v2019_12_01.models._models_py3.DedicatedHost

Parameters

resource_group_name
str
Required

The name of the resource group.

host_group_name
str
Required

The name of the dedicated host group.

host_name
str
Required

The name of the dedicated host.

expand
str
default value: instanceView

The expand expression to apply on the operation.

cls
callable

A custom type or function that will be passed the direct response

Returns

DedicatedHost, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.DedicatedHostListResult')]

Parameters

resource_group_name
str
Required

The name of the resource group.

host_group_name
str
Required

The name of the dedicated host group.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.compute.v2019_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\compute\\v2019_12_01\\models\\__init__.py'>