DedicatedHostGroupsOperations Class

DedicatedHostGroupsOperations 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).

create_or_update(resource_group_name: str, host_group_name: str, parameters: _models.DedicatedHostGroup, **kwargs: Any) -> _models.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

Exceptions

delete

Delete a dedicated host group.

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

Exceptions

get

Retrieves information about a dedicated host group.

get(resource_group_name: str, host_group_name: str, expand: Optional[str] = 'instanceView', **kwargs: Any) -> _models.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
default value: instanceView

The expand expression to apply on the operation. The response shows the list of instance view of the dedicated hosts under the 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

Exceptions

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) -> Iterable[_models.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

Exceptions

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) -> Iterable[_models.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

Exceptions

update

Update an dedicated host group.

update(resource_group_name: str, host_group_name: str, parameters: _models.DedicatedHostGroupUpdate, **kwargs: Any) -> _models.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

Exceptions

Attributes

models

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