azure-native.compute.getDedicatedHostGroup
Explore with Pulumi AI
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 for details.
Using getDedicatedHostGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDedicatedHostGroup(args: GetDedicatedHostGroupArgs, opts?: InvokeOptions): Promise<GetDedicatedHostGroupResult>
function getDedicatedHostGroupOutput(args: GetDedicatedHostGroupOutputArgs, opts?: InvokeOptions): Output<GetDedicatedHostGroupResult>
def get_dedicated_host_group(expand: Optional[str] = None,
host_group_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDedicatedHostGroupResult
def get_dedicated_host_group_output(expand: Optional[pulumi.Input[str]] = None,
host_group_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDedicatedHostGroupResult]
func LookupDedicatedHostGroup(ctx *Context, args *LookupDedicatedHostGroupArgs, opts ...InvokeOption) (*LookupDedicatedHostGroupResult, error)
func LookupDedicatedHostGroupOutput(ctx *Context, args *LookupDedicatedHostGroupOutputArgs, opts ...InvokeOption) LookupDedicatedHostGroupResultOutput
> Note: This function is named LookupDedicatedHostGroup
in the Go SDK.
public static class GetDedicatedHostGroup
{
public static Task<GetDedicatedHostGroupResult> InvokeAsync(GetDedicatedHostGroupArgs args, InvokeOptions? opts = null)
public static Output<GetDedicatedHostGroupResult> Invoke(GetDedicatedHostGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDedicatedHostGroupResult> getDedicatedHostGroup(GetDedicatedHostGroupArgs args, InvokeOptions options)
public static Output<GetDedicatedHostGroupResult> getDedicatedHostGroup(GetDedicatedHostGroupArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:compute:getDedicatedHostGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Host
Group stringName - The name of the dedicated host group.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Expand string
- 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.
- Host
Group stringName - The name of the dedicated host group.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Expand string
- 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.
- host
Group StringName - The name of the dedicated host group.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- expand String
- 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.
- host
Group stringName - The name of the dedicated host group.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- expand string
- 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.
- host_
group_ strname - The name of the dedicated host group.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- expand str
- 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.
- host
Group StringName - The name of the dedicated host group.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- expand String
- 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.
getDedicatedHostGroup Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Hosts
List<Pulumi.
Azure Native. Compute. Outputs. Sub Resource Read Only Response> - A list of references to all dedicated hosts in the dedicated host group.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Instance
View Pulumi.Azure Native. Compute. Outputs. Dedicated Host Group Instance View Response - The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Platform
Fault intDomain Count - Number of fault domains that the host group can span.
- System
Data Pulumi.Azure Native. Compute. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Additional
Capabilities Pulumi.Azure Native. Compute. Outputs. Dedicated Host Group Properties Additional Capabilities Response - Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
- Support
Automatic boolPlacement - 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.
- Dictionary<string, string>
- Resource tags.
- Zones List<string>
- The availability zones.
- Azure
Api stringVersion - The Azure API version of the resource.
- Hosts
[]Sub
Resource Read Only Response - A list of references to all dedicated hosts in the dedicated host group.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Instance
View DedicatedHost Group Instance View Response - The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Platform
Fault intDomain Count - Number of fault domains that the host group can span.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Additional
Capabilities DedicatedHost Group Properties Additional Capabilities Response - Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
- Support
Automatic boolPlacement - 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.
- map[string]string
- Resource tags.
- Zones []string
- The availability zones.
- azure
Api StringVersion - The Azure API version of the resource.
- hosts
List<Sub
Resource Read Only Response> - A list of references to all dedicated hosts in the dedicated host group.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- instance
View DedicatedHost Group Instance View Response - The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- platform
Fault IntegerDomain Count - Number of fault domains that the host group can span.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- additional
Capabilities DedicatedHost Group Properties Additional Capabilities Response - Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
- support
Automatic BooleanPlacement - 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.
- Map<String,String>
- Resource tags.
- zones List<String>
- The availability zones.
- azure
Api stringVersion - The Azure API version of the resource.
- hosts
Sub
Resource Read Only Response[] - A list of references to all dedicated hosts in the dedicated host group.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- instance
View DedicatedHost Group Instance View Response - The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- platform
Fault numberDomain Count - Number of fault domains that the host group can span.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- additional
Capabilities DedicatedHost Group Properties Additional Capabilities Response - Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
- support
Automatic booleanPlacement - 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.
- {[key: string]: string}
- Resource tags.
- zones string[]
- The availability zones.
- azure_
api_ strversion - The Azure API version of the resource.
- hosts
Sequence[Sub
Resource Read Only Response] - A list of references to all dedicated hosts in the dedicated host group.
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- instance_
view DedicatedHost Group Instance View Response - The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- platform_
fault_ intdomain_ count - Number of fault domains that the host group can span.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- additional_
capabilities DedicatedHost Group Properties Additional Capabilities Response - Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
- support_
automatic_ boolplacement - 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.
- Mapping[str, str]
- Resource tags.
- zones Sequence[str]
- The availability zones.
- azure
Api StringVersion - The Azure API version of the resource.
- hosts List<Property Map>
- A list of references to all dedicated hosts in the dedicated host group.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- instance
View Property Map - The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group.
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- platform
Fault NumberDomain Count - Number of fault domains that the host group can span.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- additional
Capabilities Property Map - Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.
- support
Automatic BooleanPlacement - 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.
- Map<String>
- Resource tags.
- zones List<String>
- The availability zones.
Supporting Types
DedicatedHostAllocatableVMResponse
DedicatedHostAvailableCapacityResponse
- Allocatable
VMs List<Pulumi.Azure Native. Compute. Inputs. Dedicated Host Allocatable VMResponse> - The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.
- Allocatable
VMs []DedicatedHost Allocatable VMResponse - The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.
- allocatable
VMs List<DedicatedHost Allocatable VMResponse> - The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.
- allocatable
VMs DedicatedHost Allocatable VMResponse[] - The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.
- allocatable_
vms Sequence[DedicatedHost Allocatable VMResponse] - The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.
- allocatable
VMs List<Property Map> - The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.
DedicatedHostGroupInstanceViewResponse
- Hosts
List<Pulumi.
Azure Native. Compute. Inputs. Dedicated Host Instance View With Name Response> - List of instance view of the dedicated hosts under the dedicated host group.
- Hosts
[]Dedicated
Host Instance View With Name Response - List of instance view of the dedicated hosts under the dedicated host group.
- hosts
List<Dedicated
Host Instance View With Name Response> - List of instance view of the dedicated hosts under the dedicated host group.
- hosts
Dedicated
Host Instance View With Name Response[] - List of instance view of the dedicated hosts under the dedicated host group.
- hosts
Sequence[Dedicated
Host Instance View With Name Response] - List of instance view of the dedicated hosts under the dedicated host group.
- hosts List<Property Map>
- List of instance view of the dedicated hosts under the dedicated host group.
DedicatedHostGroupPropertiesAdditionalCapabilitiesResponse
- Ultra
SSDEnabled bool - 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.
- Ultra
SSDEnabled bool - 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.
- ultra
SSDEnabled Boolean - 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.
- ultra
SSDEnabled boolean - 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.
- ultra_
ssd_ boolenabled - 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.
- ultra
SSDEnabled Boolean - 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.
DedicatedHostInstanceViewWithNameResponse
- Asset
Id string - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- Name string
- The name of the dedicated host.
- Available
Capacity Pulumi.Azure Native. Compute. Inputs. Dedicated Host Available Capacity Response - Unutilized capacity of the dedicated host.
- Statuses
List<Pulumi.
Azure Native. Compute. Inputs. Instance View Status Response> - The resource status information.
- Asset
Id string - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- Name string
- The name of the dedicated host.
- Available
Capacity DedicatedHost Available Capacity Response - Unutilized capacity of the dedicated host.
- Statuses
[]Instance
View Status Response - The resource status information.
- asset
Id String - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- name String
- The name of the dedicated host.
- available
Capacity DedicatedHost Available Capacity Response - Unutilized capacity of the dedicated host.
- statuses
List<Instance
View Status Response> - The resource status information.
- asset
Id string - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- name string
- The name of the dedicated host.
- available
Capacity DedicatedHost Available Capacity Response - Unutilized capacity of the dedicated host.
- statuses
Instance
View Status Response[] - The resource status information.
- asset_
id str - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- name str
- The name of the dedicated host.
- available_
capacity DedicatedHost Available Capacity Response - Unutilized capacity of the dedicated host.
- statuses
Sequence[Instance
View Status Response] - The resource status information.
- asset
Id String - Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- name String
- The name of the dedicated host.
- available
Capacity Property Map - Unutilized capacity of the dedicated host.
- statuses List<Property Map>
- The resource status information.
InstanceViewStatusResponse
- Code string
- The status code.
- Display
Status string - The short localizable label for the status.
- Level string
- The level code.
- Message string
- The detailed status message, including for alerts and error messages.
- Time string
- The time of the status.
- Code string
- The status code.
- Display
Status string - The short localizable label for the status.
- Level string
- The level code.
- Message string
- The detailed status message, including for alerts and error messages.
- Time string
- The time of the status.
- code String
- The status code.
- display
Status String - The short localizable label for the status.
- level String
- The level code.
- message String
- The detailed status message, including for alerts and error messages.
- time String
- The time of the status.
- code string
- The status code.
- display
Status string - The short localizable label for the status.
- level string
- The level code.
- message string
- The detailed status message, including for alerts and error messages.
- time string
- The time of the status.
- code str
- The status code.
- display_
status str - The short localizable label for the status.
- level str
- The level code.
- message str
- The detailed status message, including for alerts and error messages.
- time str
- The time of the status.
- code String
- The status code.
- display
Status String - The short localizable label for the status.
- level String
- The level code.
- message String
- The detailed status message, including for alerts and error messages.
- time String
- The time of the status.
SubResourceReadOnlyResponse
- Id string
- Resource Id
- Id string
- Resource Id
- id String
- Resource Id
- id string
- Resource Id
- id str
- Resource Id
- id String
- Resource Id
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0