DedicatedHostsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:dedicated_hosts> attribute.
- Inheritance
-
builtins.objectDedicatedHostsOperations
Constructor
DedicatedHostsOperations(*args, **kwargs)Methods
| begin_create_or_update |
Create or update a dedicated host . |
| begin_delete |
Delete a dedicated host. |
| begin_restart |
Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details. |
| begin_update |
Update a dedicated host . |
| get |
Retrieves information about a dedicated host. |
| list_available_sizes |
Lists all available dedicated host sizes to which the specified dedicated host can be resized. NOTE: The dedicated host sizes provided can be used to only scale up the existing 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
|
The name of the resource group. Required. |
|
host_group_name
Required
|
The name of the dedicated host group. Required. |
|
host_name
Required
|
The name of the dedicated host . Required. |
|
parameters
Required
|
Parameters supplied to the Create Dedicated Host. Is either a DedicatedHost type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either DedicatedHost or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. Required. |
|
host_group_name
Required
|
The name of the dedicated host group. Required. |
|
host_name
Required
|
The name of the dedicated host. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_restart
Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.
begin_restart(resource_group_name: str, host_group_name: str, host_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
host_group_name
Required
|
The name of the dedicated host group. Required. |
|
host_name
Required
|
The name of the dedicated host. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_update
Update a 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
|
The name of the resource group. Required. |
|
host_group_name
Required
|
The name of the dedicated host group. Required. |
|
host_name
Required
|
The name of the dedicated host . Required. |
|
parameters
Required
|
Parameters supplied to the Update Dedicated Host operation. Is either a DedicatedHostUpdate type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either DedicatedHost or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Retrieves information about a dedicated host.
get(resource_group_name: str, host_group_name: str, host_name: str, *, expand: str | InstanceViewTypes | None = None, **kwargs: Any) -> DedicatedHostParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
host_group_name
Required
|
The name of the dedicated host group. Required. |
|
host_name
Required
|
The name of the dedicated host. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
expand
|
The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated host. 'UserData' is not supported for dedicated host. Known values are: "instanceView" and "userData". Default value is None. |
Returns
| Type | Description |
|---|---|
|
DedicatedHost or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_available_sizes
Lists all available dedicated host sizes to which the specified dedicated host can be resized. NOTE: The dedicated host sizes provided can be used to only scale up the existing dedicated host.
list_available_sizes(resource_group_name: str, host_group_name: str, host_name: str, **kwargs: Any) -> Iterable[str]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
host_group_name
Required
|
The name of the dedicated host group. Required. |
|
host_name
Required
|
The name of the dedicated host. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either str or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. Required. |
|
host_group_name
Required
|
The name of the dedicated host group. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either DedicatedHost or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.compute.v2023_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2023_03_01\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for