DedicatedHost interface
Specifies information about the Dedicated host.
- Extends
Properties
| auto |
Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided. |
| host |
A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. NOTE: This property will not be serialized. It can only be populated by the server. |
| instance |
The dedicated host instance view. NOTE: This property will not be serialized. It can only be populated by the server. |
| license |
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. |
| platform |
Fault domain of the dedicated host within a dedicated host group. |
| provisioning |
The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server. |
| provisioning |
The date when the host was first provisioned. NOTE: This property will not be serialized. It can only be populated by the server. |
| sku | 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. |
| time |
Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. NOTE: This property will not be serialized. It can only be populated by the server. |
| virtual |
A list of references to all virtual machines in the Dedicated Host. NOTE: This property will not be serialized. It can only be populated by the server. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server. |
| location | The geo-location where the resource lives |
| name | The name of the resource NOTE: This property will not be serialized. It can only be populated by the server. |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server. |
| tags | Resource tags. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
autoReplaceOnFailure
Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.
autoReplaceOnFailure?: booleanProperty Value
boolean
hostId
A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host. NOTE: This property will not be serialized. It can only be populated by the server.
hostId?: stringProperty Value
string
instanceView
The dedicated host instance view. NOTE: This property will not be serialized. It can only be populated by the server.
instanceView?: DedicatedHostInstanceViewProperty Value
licenseType
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.
licenseType?: DedicatedHostLicenseTypesProperty Value
platformFaultDomain
Fault domain of the dedicated host within a dedicated host group.
platformFaultDomain?: numberProperty Value
number
provisioningState
The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: stringProperty Value
string
provisioningTime
The date when the host was first provisioned. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningTime?: DateProperty Value
Date
sku
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.
sku: SkuProperty Value
timeCreated
Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01. NOTE: This property will not be serialized. It can only be populated by the server.
timeCreated?: DateProperty Value
Date
virtualMachines
A list of references to all virtual machines in the Dedicated Host. NOTE: This property will not be serialized. It can only be populated by the server.
virtualMachines?: SubResourceReadOnly[]Property Value
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
id?: stringProperty Value
string
Inherited From TrackedResource.id
location
The geo-location where the resource lives
location: stringProperty Value
string
Inherited From TrackedResource.location
name
The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
name?: stringProperty Value
string
Inherited From TrackedResource.name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemDataProperty Value
Inherited From TrackedResource.systemData
tags
Resource tags.
tags?: {[propertyName: string]: string}Property Value
{[propertyName: string]: string}
Inherited From TrackedResource.tags
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.
type?: stringProperty Value
string
Inherited From TrackedResource.type