Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. baremetalinfrastructure
  5. getAzureBareMetalInstance
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.baremetalinfrastructure.getAzureBareMetalInstance

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets an Azure Bare Metal Instance for the specified subscription, resource group, and instance name. Azure REST API version: 2024-08-01-preview.

    Using getAzureBareMetalInstance

    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 getAzureBareMetalInstance(args: GetAzureBareMetalInstanceArgs, opts?: InvokeOptions): Promise<GetAzureBareMetalInstanceResult>
function getAzureBareMetalInstanceOutput(args: GetAzureBareMetalInstanceOutputArgs, opts?: InvokeOptions): Output<GetAzureBareMetalInstanceResult>
    def get_azure_bare_metal_instance(azure_bare_metal_instance_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetAzureBareMetalInstanceResult
def get_azure_bare_metal_instance_output(azure_bare_metal_instance_name: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetAzureBareMetalInstanceResult]
    func LookupAzureBareMetalInstance(ctx *Context, args *LookupAzureBareMetalInstanceArgs, opts ...InvokeOption) (*LookupAzureBareMetalInstanceResult, error)
func LookupAzureBareMetalInstanceOutput(ctx *Context, args *LookupAzureBareMetalInstanceOutputArgs, opts ...InvokeOption) LookupAzureBareMetalInstanceResultOutput

    > Note: This function is named LookupAzureBareMetalInstance in the Go SDK.

    public static class GetAzureBareMetalInstance 
{
    public static Task<GetAzureBareMetalInstanceResult> InvokeAsync(GetAzureBareMetalInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetAzureBareMetalInstanceResult> Invoke(GetAzureBareMetalInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAzureBareMetalInstanceResult> getAzureBareMetalInstance(GetAzureBareMetalInstanceArgs args, InvokeOptions options)
public static Output<GetAzureBareMetalInstanceResult> getAzureBareMetalInstance(GetAzureBareMetalInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:baremetalinfrastructure:getAzureBareMetalInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AzureBareMetalInstanceName string
    Name of the Azure Bare Metal Instance, also known as the ResourceName.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AzureBareMetalInstanceName string
    Name of the Azure Bare Metal Instance, also known as the ResourceName.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    azureBareMetalInstanceName String
    Name of the Azure Bare Metal Instance, also known as the ResourceName.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    azureBareMetalInstanceName string
    Name of the Azure Bare Metal Instance, also known as the ResourceName.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    azure_bare_metal_instance_name str
    Name of the Azure Bare Metal Instance, also known as the ResourceName.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    azureBareMetalInstanceName String
    Name of the Azure Bare Metal Instance, also known as the ResourceName.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getAzureBareMetalInstance Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    State of provisioning of the AzureBareMetalInstance
    SystemData Pulumi.AzureNative.BareMetalInfrastructure.Outputs.SystemDataResponse
    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"
    AzureBareMetalInstanceId string
    Specifies the Azure Bare Metal Instance unique ID.
    HardwareProfile Pulumi.AzureNative.BareMetalInfrastructure.Outputs.HardwareProfileResponse
    Specifies the hardware settings for the Azure Bare Metal Instance.
    HwRevision string
    Hardware revision of an Azure Bare Metal Instance
    NetworkProfile Pulumi.AzureNative.BareMetalInfrastructure.Outputs.NetworkProfileResponse
    Specifies the network settings for the Azure Bare Metal Instance.
    OsProfile Pulumi.AzureNative.BareMetalInfrastructure.Outputs.OSProfileResponse
    Specifies the operating system settings for the Azure Bare Metal Instance.
    PartnerNodeId string
    ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance
    PowerState string
    Resource power state
    ProximityPlacementGroup string
    Resource proximity placement group
    StorageProfile Pulumi.AzureNative.BareMetalInfrastructure.Outputs.StorageProfileResponse
    Specifies the storage settings for the Azure Bare Metal Instance disks.
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    State of provisioning of the AzureBareMetalInstance
    SystemData SystemDataResponse
    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"
    AzureBareMetalInstanceId string
    Specifies the Azure Bare Metal Instance unique ID.
    HardwareProfile HardwareProfileResponse
    Specifies the hardware settings for the Azure Bare Metal Instance.
    HwRevision string
    Hardware revision of an Azure Bare Metal Instance
    NetworkProfile NetworkProfileResponse
    Specifies the network settings for the Azure Bare Metal Instance.
    OsProfile OSProfileResponse
    Specifies the operating system settings for the Azure Bare Metal Instance.
    PartnerNodeId string
    ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance
    PowerState string
    Resource power state
    ProximityPlacementGroup string
    Resource proximity placement group
    StorageProfile StorageProfileResponse
    Specifies the storage settings for the Azure Bare Metal Instance disks.
    Tags map[string]string
    Resource tags.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    State of provisioning of the AzureBareMetalInstance
    systemData SystemDataResponse
    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"
    azureBareMetalInstanceId String
    Specifies the Azure Bare Metal Instance unique ID.
    hardwareProfile HardwareProfileResponse
    Specifies the hardware settings for the Azure Bare Metal Instance.
    hwRevision String
    Hardware revision of an Azure Bare Metal Instance
    networkProfile NetworkProfileResponse
    Specifies the network settings for the Azure Bare Metal Instance.
    osProfile OSProfileResponse
    Specifies the operating system settings for the Azure Bare Metal Instance.
    partnerNodeId String
    ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance
    powerState String
    Resource power state
    proximityPlacementGroup String
    Resource proximity placement group
    storageProfile StorageProfileResponse
    Specifies the storage settings for the Azure Bare Metal Instance disks.
    tags Map<String,String>
    Resource tags.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    State of provisioning of the AzureBareMetalInstance
    systemData SystemDataResponse
    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"
    azureBareMetalInstanceId string
    Specifies the Azure Bare Metal Instance unique ID.
    hardwareProfile HardwareProfileResponse
    Specifies the hardware settings for the Azure Bare Metal Instance.
    hwRevision string
    Hardware revision of an Azure Bare Metal Instance
    networkProfile NetworkProfileResponse
    Specifies the network settings for the Azure Bare Metal Instance.
    osProfile OSProfileResponse
    Specifies the operating system settings for the Azure Bare Metal Instance.
    partnerNodeId string
    ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance
    powerState string
    Resource power state
    proximityPlacementGroup string
    Resource proximity placement group
    storageProfile StorageProfileResponse
    Specifies the storage settings for the Azure Bare Metal Instance disks.
    tags {[key: string]: string}
    Resource tags.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    State of provisioning of the AzureBareMetalInstance
    system_data SystemDataResponse
    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"
    azure_bare_metal_instance_id str
    Specifies the Azure Bare Metal Instance unique ID.
    hardware_profile HardwareProfileResponse
    Specifies the hardware settings for the Azure Bare Metal Instance.
    hw_revision str
    Hardware revision of an Azure Bare Metal Instance
    network_profile NetworkProfileResponse
    Specifies the network settings for the Azure Bare Metal Instance.
    os_profile OSProfileResponse
    Specifies the operating system settings for the Azure Bare Metal Instance.
    partner_node_id str
    ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance
    power_state str
    Resource power state
    proximity_placement_group str
    Resource proximity placement group
    storage_profile StorageProfileResponse
    Specifies the storage settings for the Azure Bare Metal Instance disks.
    tags Mapping[str, str]
    Resource tags.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    State of provisioning of the AzureBareMetalInstance
    systemData 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"
    azureBareMetalInstanceId String
    Specifies the Azure Bare Metal Instance unique ID.
    hardwareProfile Property Map
    Specifies the hardware settings for the Azure Bare Metal Instance.
    hwRevision String
    Hardware revision of an Azure Bare Metal Instance
    networkProfile Property Map
    Specifies the network settings for the Azure Bare Metal Instance.
    osProfile Property Map
    Specifies the operating system settings for the Azure Bare Metal Instance.
    partnerNodeId String
    ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance
    powerState String
    Resource power state
    proximityPlacementGroup String
    Resource proximity placement group
    storageProfile Property Map
    Specifies the storage settings for the Azure Bare Metal Instance disks.
    tags Map<String>
    Resource tags.

    Supporting Types

    DiskResponse

    Lun int
    Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
    DiskSizeGB int
    Specifies the size of an empty data disk in gigabytes.
    Name string
    The disk name.
    Lun int
    Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
    DiskSizeGB int
    Specifies the size of an empty data disk in gigabytes.
    Name string
    The disk name.
    lun Integer
    Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
    diskSizeGB Integer
    Specifies the size of an empty data disk in gigabytes.
    name String
    The disk name.
    lun number
    Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
    diskSizeGB number
    Specifies the size of an empty data disk in gigabytes.
    name string
    The disk name.
    lun int
    Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
    disk_size_gb int
    Specifies the size of an empty data disk in gigabytes.
    name str
    The disk name.
    lun Number
    Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
    diskSizeGB Number
    Specifies the size of an empty data disk in gigabytes.
    name String
    The disk name.

    HardwareProfileResponse

    AzureBareMetalInstanceSize string
    Specifies the Azure Bare Metal Instance SKU.
    HardwareType string
    Name of the hardware type (vendor and/or their product name)
    AzureBareMetalInstanceSize string
    Specifies the Azure Bare Metal Instance SKU.
    HardwareType string
    Name of the hardware type (vendor and/or their product name)
    azureBareMetalInstanceSize String
    Specifies the Azure Bare Metal Instance SKU.
    hardwareType String
    Name of the hardware type (vendor and/or their product name)
    azureBareMetalInstanceSize string
    Specifies the Azure Bare Metal Instance SKU.
    hardwareType string
    Name of the hardware type (vendor and/or their product name)
    azure_bare_metal_instance_size str
    Specifies the Azure Bare Metal Instance SKU.
    hardware_type str
    Name of the hardware type (vendor and/or their product name)
    azureBareMetalInstanceSize String
    Specifies the Azure Bare Metal Instance SKU.
    hardwareType String
    Name of the hardware type (vendor and/or their product name)

    NetworkInterfaceResponse

    IpAddress string
    Specifies the IP address of the network interface.
    IpAddress string
    Specifies the IP address of the network interface.
    ipAddress String
    Specifies the IP address of the network interface.
    ipAddress string
    Specifies the IP address of the network interface.
    ip_address str
    Specifies the IP address of the network interface.
    ipAddress String
    Specifies the IP address of the network interface.

    NetworkProfileResponse

    CircuitId string
    Specifies the circuit id for connecting to express route.
    NetworkInterfaces List<Pulumi.AzureNative.BareMetalInfrastructure.Inputs.NetworkInterfaceResponse>
    Specifies the network interfaces for the Azure Bare Metal Instance.
    CircuitId string
    Specifies the circuit id for connecting to express route.
    NetworkInterfaces []NetworkInterfaceResponse
    Specifies the network interfaces for the Azure Bare Metal Instance.
    circuitId String
    Specifies the circuit id for connecting to express route.
    networkInterfaces List<NetworkInterfaceResponse>
    Specifies the network interfaces for the Azure Bare Metal Instance.
    circuitId string
    Specifies the circuit id for connecting to express route.
    networkInterfaces NetworkInterfaceResponse[]
    Specifies the network interfaces for the Azure Bare Metal Instance.
    circuit_id str
    Specifies the circuit id for connecting to express route.
    network_interfaces Sequence[NetworkInterfaceResponse]
    Specifies the network interfaces for the Azure Bare Metal Instance.
    circuitId String
    Specifies the circuit id for connecting to express route.
    networkInterfaces List<Property Map>
    Specifies the network interfaces for the Azure Bare Metal Instance.

    OSProfileResponse

    ComputerName string
    Specifies the host OS name of the Azure Bare Metal instance.
    OsType string
    This property allows you to specify the type of the OS.
    SshPublicKey string
    Specifies the SSH public key used to access the operating system.
    Version string
    Specifies version of operating system.
    ComputerName string
    Specifies the host OS name of the Azure Bare Metal instance.
    OsType string
    This property allows you to specify the type of the OS.
    SshPublicKey string
    Specifies the SSH public key used to access the operating system.
    Version string
    Specifies version of operating system.
    computerName String
    Specifies the host OS name of the Azure Bare Metal instance.
    osType String
    This property allows you to specify the type of the OS.
    sshPublicKey String
    Specifies the SSH public key used to access the operating system.
    version String
    Specifies version of operating system.
    computerName string
    Specifies the host OS name of the Azure Bare Metal instance.
    osType string
    This property allows you to specify the type of the OS.
    sshPublicKey string
    Specifies the SSH public key used to access the operating system.
    version string
    Specifies version of operating system.
    computer_name str
    Specifies the host OS name of the Azure Bare Metal instance.
    os_type str
    This property allows you to specify the type of the OS.
    ssh_public_key str
    Specifies the SSH public key used to access the operating system.
    version str
    Specifies version of operating system.
    computerName String
    Specifies the host OS name of the Azure Bare Metal instance.
    osType String
    This property allows you to specify the type of the OS.
    sshPublicKey String
    Specifies the SSH public key used to access the operating system.
    version String
    Specifies version of operating system.

    StorageProfileResponse

    NfsIpAddress string
    IP Address to connect to storage.
    OsDisks List<Pulumi.AzureNative.BareMetalInfrastructure.Inputs.DiskResponse>
    Specifies information about the operating system disk used by bare metal instance.
    NfsIpAddress string
    IP Address to connect to storage.
    OsDisks []DiskResponse
    Specifies information about the operating system disk used by bare metal instance.
    nfsIpAddress String
    IP Address to connect to storage.
    osDisks List<DiskResponse>
    Specifies information about the operating system disk used by bare metal instance.
    nfsIpAddress string
    IP Address to connect to storage.
    osDisks DiskResponse[]
    Specifies information about the operating system disk used by bare metal instance.
    nfs_ip_address str
    IP Address to connect to storage.
    os_disks Sequence[DiskResponse]
    Specifies information about the operating system disk used by bare metal instance.
    nfsIpAddress String
    IP Address to connect to storage.
    osDisks List<Property Map>
    Specifies information about the operating system disk used by bare metal instance.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native