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.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups?api-version=2023-07-01

URI Parameters

Name In Required Type Description
subscriptionId
path True

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client Api Version.

Responses

Name Type Description
200 OK

DedicatedHostGroupListResult

OK

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

DedicatedHostGroup_ListBySubscription_MaximumSet_Gen
DedicatedHostGroup_ListBySubscription_MinimumSet_Gen

DedicatedHostGroup_ListBySubscription_MaximumSet_Gen

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/hostGroups?api-version=2023-07-01

Sample Response

{
  "value": [
    {
      "location": "westus",
      "tags": {},
      "zones": [
        "1"
      ],
      "properties": {
        "platformFaultDomainCount": 3,
        "supportAutomaticPlacement": true,
        "hosts": [
          {
            "id": "aaaa"
          }
        ],
        "instanceView": {
          "hosts": [
            {
              "name": "aaaaaaaaaaaaaaaaaa",
              "assetId": "aaaa",
              "availableCapacity": {
                "allocatableVMs": [
                  {
                    "vmSize": "aaaaaaaaaaaaaaaaaaaa",
                    "count": 26
                  }
                ]
              },
              "statuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ]
            }
          ]
        }
      },
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup",
      "name": "myDedicatedHostGroup",
      "type": "aaaa"
    }
  ],
  "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

DedicatedHostGroup_ListBySubscription_MinimumSet_Gen

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/hostGroups?api-version=2023-07-01

Sample Response

{
  "value": [
    {
      "location": "westus",
      "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup"
    }
  ]
}

Definitions

Name Description
AdditionalCapabilities

Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

ApiError

Api error.

ApiErrorBase

Api error base.

CloudError

An error response from the Compute service.

DedicatedHostAllocatableVM

Represents the dedicated host unutilized capacity in terms of a specific VM size.

DedicatedHostAvailableCapacity

Dedicated host unutilized capacity.

DedicatedHostGroup

Specifies information about the dedicated host group that the dedicated hosts should be assigned to. Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group.

DedicatedHostGroupInstanceView
DedicatedHostGroupListResult

The List Dedicated Host Group with resource group response.

DedicatedHostInstanceViewWithName

The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group.

InnerError

Inner error details.

InstanceViewStatus

Instance view status.

StatusLevelTypes

The level code.

SubResourceReadOnly

AdditionalCapabilities

Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

Name Type Description
ultraSSDEnabled

boolean

The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. Note: The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01.

ApiError

Api error.

Name Type Description
code

string

The error code.

details

ApiErrorBase[]

The Api error details

innererror

InnerError

The Api inner error

message

string

The error message.

target

string

The target of the particular error.

ApiErrorBase

Api error base.

Name Type Description
code

string

The error code.

message

string

The error message.

target

string

The target of the particular error.

CloudError

An error response from the Compute service.

Name Type Description
error

ApiError

Api error.

DedicatedHostAllocatableVM

Represents the dedicated host unutilized capacity in terms of a specific VM size.

Name Type Description
count

number

Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.

vmSize

string

VM size in terms of which the unutilized capacity is represented.

DedicatedHostAvailableCapacity

Dedicated host unutilized capacity.

Name Type Description
allocatableVMs

DedicatedHostAllocatableVM[]

The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.

DedicatedHostGroup

Specifies information about the dedicated host group that the dedicated hosts should be assigned to. Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group.

Name Type Description
id

string

Resource Id

location

string

Resource location

name

string

Resource name

properties.additionalCapabilities

AdditionalCapabilities

Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

properties.hosts

SubResourceReadOnly[]

A list of references to all dedicated hosts in the dedicated host group.

properties.instanceView

DedicatedHostGroupInstanceView

The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.

properties.platformFaultDomainCount

integer

Number of fault domains that the host group can span.

properties.supportAutomaticPlacement

boolean

Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01.

tags

object

Resource tags

type

string

Resource type

zones

string[]

Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.

DedicatedHostGroupInstanceView

Name Type Description
hosts

DedicatedHostInstanceViewWithName[]

List of instance view of the dedicated hosts under the dedicated host group.

DedicatedHostGroupListResult

The List Dedicated Host Group with resource group response.

Name Type Description
nextLink

string

The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups.

value

DedicatedHostGroup[]

The list of dedicated host groups

DedicatedHostInstanceViewWithName

The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group.

Name Type Description
assetId

string

Specifies the unique id of the dedicated physical machine on which the dedicated host resides.

availableCapacity

DedicatedHostAvailableCapacity

Unutilized capacity of the dedicated host.

name

string

The name of the dedicated host.

statuses

InstanceViewStatus[]

The resource status information.

InnerError

Inner error details.

Name Type Description
errordetail

string

The internal error message or exception dump.

exceptiontype

string

The exception type.

InstanceViewStatus

Instance view status.

Name Type Description
code

string

The status code.

displayStatus

string

The short localizable label for the status.

level

StatusLevelTypes

The level code.

message

string

The detailed status message, including for alerts and error messages.

time

string

The time of the status.

StatusLevelTypes

The level code.

Name Type Description
Error

string

Info

string

Warning

string

SubResourceReadOnly

Name Type Description
id

string

Resource Id