UNPKG

@pulumi/azure-native

Version:

[![Slack](http://www.pulumi.com/images/docs/badges/slack.svg)](https://slack.pulumi.com) [![NPM version](https://badge.fury.io/js/%40pulumi%2Fazure-native.svg)](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

106 lines (105 loc) 4.9 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * Retrieves information about a dedicated host group. * * 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 getDedicatedHostGroup(args: GetDedicatedHostGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetDedicatedHostGroupResult>; export interface GetDedicatedHostGroupArgs { /** * 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. */ expand?: string; /** * The name of the dedicated host group. */ hostGroupName: string; /** * The name of the resource group. The name is case insensitive. */ resourceGroupName: string; } /** * 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. */ export interface GetDedicatedHostGroupResult { /** * Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. */ readonly additionalCapabilities?: outputs.compute.DedicatedHostGroupPropertiesAdditionalCapabilitiesResponse; /** * The Azure API version of the resource. */ readonly azureApiVersion: string; /** * A list of references to all dedicated hosts in the dedicated host group. */ readonly hosts: outputs.compute.SubResourceReadOnlyResponse[]; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ readonly id: string; /** * The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group. */ readonly instanceView: outputs.compute.DedicatedHostGroupInstanceViewResponse; /** * The geo-location where the resource lives */ readonly location: string; /** * The name of the resource */ readonly name: string; /** * Number of fault domains that the host group can span. */ readonly platformFaultDomainCount: number; /** * 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. */ readonly supportAutomaticPlacement?: boolean; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ readonly systemData: outputs.compute.SystemDataResponse; /** * Resource tags. */ readonly tags?: { [key: string]: string; }; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ readonly type: string; /** * The availability zones. */ readonly zones?: string[]; } /** * Retrieves information about a dedicated host group. * * 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 getDedicatedHostGroupOutput(args: GetDedicatedHostGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDedicatedHostGroupResult>; export interface GetDedicatedHostGroupOutputArgs { /** * 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. */ expand?: pulumi.Input<string>; /** * The name of the dedicated host group. */ hostGroupName: pulumi.Input<string>; /** * The name of the resource group. The name is case insensitive. */ resourceGroupName: pulumi.Input<string>; }