@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Retrieves information about a dedicated host.
*
* Uses Azure REST API version 2024-11-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. 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 function getDedicatedHost(args: GetDedicatedHostArgs, opts?: pulumi.InvokeOptions): Promise<GetDedicatedHostResult>;
export interface GetDedicatedHostArgs {
/**
* 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.
*/
expand?: string;
/**
* The name of the dedicated host group.
*/
hostGroupName: string;
/**
* The name of the dedicated host.
*/
hostName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Specifies information about the Dedicated host.
*/
export interface GetDedicatedHostResult {
/**
* 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?: boolean;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: 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: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The dedicated host instance view.
*/
readonly instanceView: 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?: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* Fault domain of the dedicated host within a dedicated host group.
*/
readonly platformFaultDomain?: number;
/**
* The provisioning state, which only appears in the response.
*/
readonly provisioningState: string;
/**
* The date when the host was first provisioned.
*/
readonly provisioningTime: 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: outputs.compute.SkuResponse;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.compute.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01.
*/
readonly timeCreated: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* A list of references to all virtual machines in the Dedicated Host.
*/
readonly virtualMachines: outputs.compute.SubResourceReadOnlyResponse[];
}
/**
* Retrieves information about a dedicated host.
*
* Uses Azure REST API version 2024-11-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. 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 function getDedicatedHostOutput(args: GetDedicatedHostOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDedicatedHostResult>;
export interface GetDedicatedHostOutputArgs {
/**
* 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.
*/
expand?: pulumi.Input<string>;
/**
* The name of the dedicated host group.
*/
hostGroupName: pulumi.Input<string>;
/**
* The name of the dedicated host.
*/
hostName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}