DedicatedHostGroupsOperations Class

DedicatedHostGroupsOperations 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

DedicatedHostGroupsOperations

Constructor

DedicatedHostGroupsOperations(client, config, serializer, deserializer)

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

create_or_update	Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596).
delete	Delete a dedicated host group.
get	Retrieves information about a dedicated host group.
list_by_resource_group	Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.
list_by_subscription	Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.
update	Update an dedicated host group.

create_or_update

Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596).

async create_or_update(resource_group_name: str, host_group_name: str, parameters: azure.mgmt.compute.v2021_07_01.models._models_py3.DedicatedHostGroup, **kwargs: Any) -> azure.mgmt.compute.v2021_07_01.models._models_py3.DedicatedHostGroup

Parameters

resource_group_name

str

Required

The name of the resource group.

host_group_name

str

Required

The name of the dedicated host group.

parameters

DedicatedHostGroup

Required

Parameters supplied to the Create Dedicated Host Group.

cls

callable

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

Returns

DedicatedHostGroup, or the result of cls(response)

Return type

DedicatedHostGroup

Exceptions

HttpResponseError

delete

Delete a dedicated host group.

async delete(resource_group_name: str, host_group_name: str, **kwargs: Any) -> None

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

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Retrieves information about a dedicated host group.

async get(resource_group_name: str, host_group_name: str, expand: Optional[Union[str, azure.mgmt.compute.v2021_07_01.models._compute_management_client_enums.InstanceViewTypes]] = None, **kwargs: Any) -> azure.mgmt.compute.v2021_07_01.models._models_py3.DedicatedHostGroup

Parameters

resource_group_name

str

Required

The name of the resource group.

host_group_name

str

Required

The name of the dedicated host group.

expand

str or InstanceViewTypes

default value: None

The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group.

cls

callable

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

Returns

DedicatedHostGroup, or the result of cls(response)

Return type

DedicatedHostGroup

Exceptions

HttpResponseError

list_by_resource_group

Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.compute.v2021_07_01.models._models_py3.DedicatedHostGroupListResult]

Parameters

resource_group_name

str

Required

The name of the resource group.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[DedicatedHostGroupListResult]

Exceptions

HttpResponseError

list_by_subscription

Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.

list_by_subscription(**kwargs: Any) -> AsyncIterable[azure.mgmt.compute.v2021_07_01.models._models_py3.DedicatedHostGroupListResult]

Parameters

cls

callable

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

Returns

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

Return type

AsyncItemPaged[DedicatedHostGroupListResult]

Exceptions

HttpResponseError

update

Update an dedicated host group.

async update(resource_group_name: str, host_group_name: str, parameters: azure.mgmt.compute.v2021_07_01.models._models_py3.DedicatedHostGroupUpdate, **kwargs: Any) -> azure.mgmt.compute.v2021_07_01.models._models_py3.DedicatedHostGroup

Parameters

resource_group_name

str

Required

The name of the resource group.

host_group_name

str

Required

The name of the dedicated host group.

parameters

DedicatedHostGroupUpdate

Required

Parameters supplied to the Update Dedicated Host Group operation.

cls

callable

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

Returns

DedicatedHostGroup, or the result of cls(response)

Return type

DedicatedHostGroup

Exceptions

HttpResponseError

Attributes

models

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