DedicatedHostGroupsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:dedicated_host_groups> attribute.
Constructor
DedicatedHostGroupsOperations(*args, **kwargs)
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, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DedicatedHostGroup
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
host_group_name
Required
|
The name of the dedicated host group. Required. |
|
parameters
Required
|
Parameters supplied to the Create Dedicated Host Group. Is either a DedicatedHostGroup type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
DedicatedHostGroup or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Delete a dedicated host group.
delete(resource_group_name: str, host_group_name: str, **kwargs: Any) -> None
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
host_group_name
Required
|
The name of the dedicated host group. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Retrieves information about a dedicated host group.
get(resource_group_name: str, host_group_name: str, expand: str | InstanceViewTypes | None = None, **kwargs: Any) -> DedicatedHostGroup
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
host_group_name
Required
|
The name of the dedicated host group. Required. |
|
expand
|
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. Known values are: "instanceView", "userData", and "resiliencyView". Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
DedicatedHostGroup or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> ItemPaged[DedicatedHostGroup]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either DedicatedHostGroup or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> ItemPaged[DedicatedHostGroup]
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either DedicatedHostGroup or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
update
Update an dedicated host group.
update(resource_group_name: str, host_group_name: str, parameters: _models.DedicatedHostGroupUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DedicatedHostGroup
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
host_group_name
Required
|
The name of the dedicated host group. Required. |
|
parameters
Required
|
Parameters supplied to the Update Dedicated Host Group operation. Is either a DedicatedHostGroupUpdate type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
DedicatedHostGroup or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.compute.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv89\\Lib\\site-packages\\azure\\mgmt\\compute\\models\\__init__.py'>