@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Specifies information about the Dedicated host.
*
* Uses Azure REST API version 2024-11-01. In version 2.x of the Azure Native provider, it used API version 2023-03-01.
*
* Other available API versions: 2022-08-01, 2022-11-01, 2023-03-01, 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01, 2025-04-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native compute [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class DedicatedHost extends pulumi.CustomResource {
/**
* Get an existing DedicatedHost resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): DedicatedHost;
/**
* Returns true if the given object is an instance of DedicatedHost. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DedicatedHost;
/**
* Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.
*/
readonly autoReplaceOnFailure: pulumi.Output<boolean | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host.
*/
readonly hostId: pulumi.Output<string>;
/**
* The dedicated host instance view.
*/
readonly instanceView: pulumi.Output<outputs.compute.DedicatedHostInstanceViewResponse>;
/**
* 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.**
*/
readonly licenseType: pulumi.Output<string | undefined>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Fault domain of the dedicated host within a dedicated host group.
*/
readonly platformFaultDomain: pulumi.Output<number | undefined>;
/**
* The provisioning state, which only appears in the response.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The date when the host was first provisioned.
*/
readonly provisioningTime: pulumi.Output<string>;
/**
* 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.
*/
readonly sku: pulumi.Output<outputs.compute.SkuResponse>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.compute.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.
*/
readonly timeCreated: pulumi.Output<string>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* A list of references to all virtual machines in the Dedicated Host.
*/
readonly virtualMachines: pulumi.Output<outputs.compute.SubResourceReadOnlyResponse[]>;
/**
* Create a DedicatedHost resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DedicatedHostArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a DedicatedHost resource.
*/
export interface DedicatedHostArgs {
/**
* Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.
*/
autoReplaceOnFailure?: pulumi.Input<boolean>;
/**
* The name of the dedicated host group.
*/
hostGroupName: pulumi.Input<string>;
/**
* The name of the dedicated host.
*/
hostName?: pulumi.Input<string>;
/**
* 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?: pulumi.Input<enums.compute.DedicatedHostLicenseTypes>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* Fault domain of the dedicated host within a dedicated host group.
*/
platformFaultDomain?: pulumi.Input<number>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* 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: pulumi.Input<inputs.compute.SkuArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}