{ "swagger": "2.0", "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", "version": "2024-07-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}": { "put": { "tags": [ "DedicatedHostGroups" ], "operationId": "DedicatedHostGroups_CreateOrUpdate", "description": "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)", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host group." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DedicatedHostGroup" }, "description": "Parameters supplied to the Create Dedicated Host Group." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DedicatedHostGroup" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/DedicatedHostGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create or update a dedicated host group.": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json" }, "Create or update a dedicated host group with Ultra SSD support.": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json" } } }, "patch": { "tags": [ "DedicatedHostGroups" ], "operationId": "DedicatedHostGroups_Update", "description": "Update an dedicated host group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host group." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DedicatedHostGroupUpdate" }, "description": "Parameters supplied to the Update Dedicated Host Group operation." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DedicatedHostGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "DedicatedHostGroup_Update_MaximumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Update_MaximumSet_Gen.json" }, "DedicatedHostGroup_Update_MinimumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Update_MinimumSet_Gen.json" } } }, "delete": { "tags": [ "DedicatedHostGroups" ], "operationId": "DedicatedHostGroups_Delete", "description": "Delete a dedicated host group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host group." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "DedicatedHostGroup_Delete_MaximumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MaximumSet_Gen.json" }, "DedicatedHostGroup_Delete_MinimumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MinimumSet_Gen.json" } } }, "get": { "tags": [ "DedicatedHostGroups" ], "operationId": "DedicatedHostGroups_Get", "description": "Retrieves information about a dedicated host group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host group." }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "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.", "enum": [ "instanceView", "userData" ], "x-ms-enum": { "name": "InstanceViewTypes", "modelAsString": false } }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DedicatedHostGroup" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create a dedicated host group.": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Get.json" }, "Create an ultraSSDEnabled dedicated host group.": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Get_UltraSSDEnabledDedicatedHostGroup.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups": { "get": { "tags": [ "DedicatedHostGroups" ], "operationId": "DedicatedHostGroups_ListByResourceGroup", "description": "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.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DedicatedHostGroupListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen.json" }, "DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups": { "get": { "tags": [ "DedicatedHostGroups" ], "operationId": "DedicatedHostGroups_ListBySubscription", "description": "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.", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DedicatedHostGroupListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "DedicatedHostGroup_ListBySubscription_MaximumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MaximumSet_Gen.json" }, "DedicatedHostGroup_ListBySubscription_MinimumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}": { "put": { "tags": [ "DedicatedHosts" ], "operationId": "DedicatedHosts_CreateOrUpdate", "description": "Create or update a dedicated host .", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host group." }, { "name": "hostName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host ." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DedicatedHost" }, "description": "Parameters supplied to the Create Dedicated Host." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DedicatedHost" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/DedicatedHost" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create or update a dedicated host .": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json" } }, "x-ms-long-running-operation": true }, "patch": { "tags": [ "DedicatedHosts" ], "operationId": "DedicatedHosts_Update", "description": "Update a dedicated host .", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host group." }, { "name": "hostName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host ." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DedicatedHostUpdate" }, "description": "Parameters supplied to the Update Dedicated Host operation." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DedicatedHost" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "DedicatedHost_Update_MaximumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Update_MaximumSet_Gen.json" }, "DedicatedHost_Update_MinimumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Update_MinimumSet_Gen.json" }, "DedicatedHost_Update_Resize": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Update_Resize.json" } } }, "delete": { "tags": [ "DedicatedHosts" ], "operationId": "DedicatedHosts_Delete", "description": "Delete a dedicated host.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host group." }, { "name": "hostName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "DedicatedHost_Delete_MaximumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Delete_MaximumSet_Gen.json" }, "DedicatedHost_Delete_MinimumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Delete_MinimumSet_Gen.json" } } }, "get": { "tags": [ "DedicatedHosts" ], "operationId": "DedicatedHosts_Get", "description": "Retrieves information about a dedicated host.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host group." }, { "name": "hostName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host." }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "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.", "enum": [ "instanceView", "userData" ], "x-ms-enum": { "name": "InstanceViewTypes", "modelAsString": false } }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DedicatedHost" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get a dedicated host.": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts": { "get": { "tags": [ "DedicatedHost" ], "operationId": "DedicatedHosts_ListByHostGroup", "description": "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.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host group." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DedicatedHostListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "DedicatedHost_ListByHostGroup_MaximumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.json" }, "DedicatedHost_ListByHostGroup_MinimumSet_Gen": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/restart": { "post": { "tags": [ "DedicatedHost" ], "operationId": "DedicatedHosts_Restart", "description": "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.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host group." }, { "name": "hostName", "in": "path", "required": true, "type": "string", "description": "The name of the dedicated host." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Restart Dedicated Host.": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Restart.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/redeploy": { "post": { "tags": [ "DedicatedHost" ], "operationId": "DedicatedHosts_Redeploy", "description": "Redeploy the dedicated host. The operation will complete successfully once the dedicated host has migrated to a new node and is running. To determine the health of VMs deployed on the dedicated host after the redeploy 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.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the dedicated host group." }, { "name": "hostName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the dedicated host." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted", "headers": { "Location": { "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Redeploy Dedicated Host.": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Redeploy.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/hostSizes": { "get": { "tags": [ "DedicatedHost" ], "operationId": "DedicatedHosts_ListAvailableSizes", "description": "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.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "hostGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the dedicated host group." }, { "name": "hostName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The name of the dedicated host." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DedicatedHostSizeListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": null }, "x-ms-examples": { "Get Available Dedicated Host Sizes.": { "$ref": "./examples/dedicatedHostExamples/DedicatedHost_ListAvailableSizes.json" } } } } }, "definitions": { "DedicatedHostGroupInstanceView": { "properties": { "hosts": { "type": "array", "items": { "$ref": "#/definitions/DedicatedHostInstanceViewWithName" }, "x-ms-identifiers": [ "name" ], "description": "List of instance view of the dedicated hosts under the dedicated host group." } } }, "DedicatedHostGroupProperties": { "properties": { "platformFaultDomainCount": { "type": "integer", "format": "int32", "minimum": 1, "description": "Number of fault domains that the host group can span." }, "hosts": { "type": "array", "items": { "$ref": "../../common-types/v1/common.json#/definitions/SubResourceReadOnly" }, "readOnly": true, "description": "A list of references to all dedicated hosts in the dedicated host group." }, "instanceView": { "$ref": "#/definitions/DedicatedHostGroupInstanceView", "readOnly": true, "description": "The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group." }, "supportAutomaticPlacement": { "type": "boolean", "description": "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." }, "additionalCapabilities": { "type": "object", "properties": { "ultraSSDEnabled": { "type": "boolean", "description": "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." } }, "description": "Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01." } }, "required": [ "platformFaultDomainCount" ], "description": "Dedicated Host Group Properties." }, "DedicatedHostGroup": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DedicatedHostGroupProperties" }, "zones": { "type": "array", "items": { "type": "string" }, "description": "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." } }, "allOf": [ { "$ref": "../../common-types/v1/common.json#/definitions/Resource" } ], "description": "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." }, "DedicatedHostGroupUpdate": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DedicatedHostGroupProperties" }, "zones": { "type": "array", "items": { "type": "string" }, "description": "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." } }, "allOf": [ { "$ref": "./computeRPCommon.json#/definitions/UpdateResource" } ], "description": "Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated." }, "DedicatedHostGroupListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/DedicatedHostGroup" }, "description": "The list of dedicated host groups" }, "nextLink": { "type": "string", "description": "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." } }, "required": [ "value" ], "description": "The List Dedicated Host Group with resource group response." }, "DedicatedHostLicenseType": { "type": "string", "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.**", "enum": [ "None", "Windows_Server_Hybrid", "Windows_Server_Perpetual" ], "x-ms-enum": { "name": "DedicatedHostLicenseTypes", "modelAsString": false } }, "DedicatedHostAllocatableVM": { "properties": { "vmSize": { "type": "string", "description": "VM size in terms of which the unutilized capacity is represented." }, "count": { "type": "number", "format": "double", "description": "Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity." } }, "description": "Represents the dedicated host unutilized capacity in terms of a specific VM size." }, "DedicatedHostAvailableCapacity": { "properties": { "allocatableVMs": { "type": "array", "items": { "$ref": "#/definitions/DedicatedHostAllocatableVM" }, "x-ms-identifiers": [], "description": "The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host." } }, "description": "Dedicated host unutilized capacity." }, "DedicatedHostInstanceView": { "properties": { "assetId": { "readOnly": true, "type": "string", "description": "Specifies the unique id of the dedicated physical machine on which the dedicated host resides." }, "availableCapacity": { "$ref": "#/definitions/DedicatedHostAvailableCapacity", "description": "Unutilized capacity of the dedicated host." }, "statuses": { "type": "array", "items": { "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" }, "x-ms-identifiers": [], "description": "The resource status information." } }, "description": "The instance view of a dedicated host." }, "DedicatedHostInstanceViewWithName": { "properties": { "name": { "type": "string", "readOnly": true, "description": "The name of the dedicated host." } }, "allOf": [ { "$ref": "#/definitions/DedicatedHostInstanceView" } ], "description": "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." }, "DedicatedHostProperties": { "properties": { "platformFaultDomain": { "type": "integer", "format": "int32", "minimum": 0, "description": "Fault domain of the dedicated host within a dedicated host group." }, "autoReplaceOnFailure": { "type": "boolean", "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided." }, "hostId": { "readOnly": true, "type": "string", "description": "A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host." }, "virtualMachines": { "type": "array", "items": { "$ref": "../../common-types/v1/common.json#/definitions/SubResourceReadOnly" }, "readOnly": true, "description": "A list of references to all virtual machines in the Dedicated Host." }, "licenseType": { "$ref": "#/definitions/DedicatedHostLicenseType", "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.**" }, "provisioningTime": { "readOnly": true, "type": "string", "format": "date-time", "description": "The date when the host was first provisioned." }, "provisioningState": { "readOnly": true, "type": "string", "description": "The provisioning state, which only appears in the response." }, "instanceView": { "$ref": "#/definitions/DedicatedHostInstanceView", "readOnly": true, "description": "The dedicated host instance view." }, "timeCreated": { "readOnly": true, "type": "string", "format": "date-time", "description": "Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01." } }, "description": "Properties of the dedicated host." }, "DedicatedHost": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DedicatedHostProperties" }, "sku": { "$ref": "./computeRPCommon.json#/definitions/Sku", "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values." } }, "allOf": [ { "$ref": "../../common-types/v1/common.json#/definitions/Resource" } ], "required": [ "sku" ], "description": "Specifies information about the Dedicated host." }, "DedicatedHostUpdate": { "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/DedicatedHostProperties" }, "sku": { "$ref": "./computeRPCommon.json#/definitions/Sku", "description": "[List all available dedicated host sizes for resizing] (https://docs.microsoft.com/rest/api/compute/dedicated-hosts/listavailablesizes). Resizing can be only used to scale up DedicatedHost. Only name is required to be set. " } }, "allOf": [ { "$ref": "./computeRPCommon.json#/definitions/UpdateResource" } ], "description": "Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated." }, "DedicatedHostListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/DedicatedHost" }, "description": "The list of dedicated hosts" }, "nextLink": { "type": "string", "description": "The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts." } }, "required": [ "value" ], "description": "The list dedicated host operation response." }, "DedicatedHostSizeListResult": { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" }, "x-ms-identifiers": [ "name" ], "description": "The list of dedicated host sizes." } }, "description": "The List Dedicated Host sizes operation response." } } }