Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. networkcloud
  5. getBareMetalMachineKeySet
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.networkcloud.getBareMetalMachineKeySet

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get bare metal machine key set of the provided cluster.

    Uses Azure REST API version 2025-02-01.

    Other available API versions: 2024-07-01, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native networkcloud [ApiVersion]. See the version guide for details.

    Using getBareMetalMachineKeySet

    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 getBareMetalMachineKeySet(args: GetBareMetalMachineKeySetArgs, opts?: InvokeOptions): Promise<GetBareMetalMachineKeySetResult>
function getBareMetalMachineKeySetOutput(args: GetBareMetalMachineKeySetOutputArgs, opts?: InvokeOptions): Output<GetBareMetalMachineKeySetResult>
    def get_bare_metal_machine_key_set(bare_metal_machine_key_set_name: Optional[str] = None,
                                   cluster_name: Optional[str] = None,
                                   resource_group_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetBareMetalMachineKeySetResult
def get_bare_metal_machine_key_set_output(bare_metal_machine_key_set_name: Optional[pulumi.Input[str]] = None,
                                   cluster_name: Optional[pulumi.Input[str]] = None,
                                   resource_group_name: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetBareMetalMachineKeySetResult]
    func LookupBareMetalMachineKeySet(ctx *Context, args *LookupBareMetalMachineKeySetArgs, opts ...InvokeOption) (*LookupBareMetalMachineKeySetResult, error)
func LookupBareMetalMachineKeySetOutput(ctx *Context, args *LookupBareMetalMachineKeySetOutputArgs, opts ...InvokeOption) LookupBareMetalMachineKeySetResultOutput

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

    public static class GetBareMetalMachineKeySet 
{
    public static Task<GetBareMetalMachineKeySetResult> InvokeAsync(GetBareMetalMachineKeySetArgs args, InvokeOptions? opts = null)
    public static Output<GetBareMetalMachineKeySetResult> Invoke(GetBareMetalMachineKeySetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBareMetalMachineKeySetResult> getBareMetalMachineKeySet(GetBareMetalMachineKeySetArgs args, InvokeOptions options)
public static Output<GetBareMetalMachineKeySetResult> getBareMetalMachineKeySet(GetBareMetalMachineKeySetArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:networkcloud:getBareMetalMachineKeySet
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BareMetalMachineKeySetName string
    The name of the bare metal machine key set.
    ClusterName string
    The name of the cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    BareMetalMachineKeySetName string
    The name of the bare metal machine key set.
    ClusterName string
    The name of the cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    bareMetalMachineKeySetName String
    The name of the bare metal machine key set.
    clusterName String
    The name of the cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    bareMetalMachineKeySetName string
    The name of the bare metal machine key set.
    clusterName string
    The name of the cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    bare_metal_machine_key_set_name str
    The name of the bare metal machine key set.
    cluster_name str
    The name of the cluster.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    bareMetalMachineKeySetName String
    The name of the bare metal machine key set.
    clusterName String
    The name of the cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getBareMetalMachineKeySet Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    AzureGroupId string
    The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.
    DetailedStatus string
    The more detailed status of the key set.
    DetailedStatusMessage string
    The descriptive message about the current detailed status.
    Etag string
    Resource ETag.
    Expiration string
    The date and time after which the users in this key set will be removed from the bare metal machines.
    ExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    JumpHostsAllowed List<string>
    The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
    LastValidation string
    The last time this key set was validated.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PrivilegeLevel string
    The access level allowed for the users in this key set.
    ProvisioningState string
    The provisioning state of the bare metal machine key set.
    SystemData Pulumi.AzureNative.NetworkCloud.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"
    UserList List<Pulumi.AzureNative.NetworkCloud.Outputs.KeySetUserResponse>
    The unique list of permitted users.
    UserListStatus List<Pulumi.AzureNative.NetworkCloud.Outputs.KeySetUserStatusResponse>
    The status evaluation of each user.
    OsGroupName string
    The name of the group that users will be assigned to on the operating system of the machines.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    AzureGroupId string
    The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.
    DetailedStatus string
    The more detailed status of the key set.
    DetailedStatusMessage string
    The descriptive message about the current detailed status.
    Etag string
    Resource ETag.
    Expiration string
    The date and time after which the users in this key set will be removed from the bare metal machines.
    ExtendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    JumpHostsAllowed []string
    The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
    LastValidation string
    The last time this key set was validated.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PrivilegeLevel string
    The access level allowed for the users in this key set.
    ProvisioningState string
    The provisioning state of the bare metal machine key set.
    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"
    UserList []KeySetUserResponse
    The unique list of permitted users.
    UserListStatus []KeySetUserStatusResponse
    The status evaluation of each user.
    OsGroupName string
    The name of the group that users will be assigned to on the operating system of the machines.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    azureGroupId String
    The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.
    detailedStatus String
    The more detailed status of the key set.
    detailedStatusMessage String
    The descriptive message about the current detailed status.
    etag String
    Resource ETag.
    expiration String
    The date and time after which the users in this key set will be removed from the bare metal machines.
    extendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    jumpHostsAllowed List<String>
    The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
    lastValidation String
    The last time this key set was validated.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    privilegeLevel String
    The access level allowed for the users in this key set.
    provisioningState String
    The provisioning state of the bare metal machine key set.
    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"
    userList List<KeySetUserResponse>
    The unique list of permitted users.
    userListStatus List<KeySetUserStatusResponse>
    The status evaluation of each user.
    osGroupName String
    The name of the group that users will be assigned to on the operating system of the machines.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    azureGroupId string
    The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.
    detailedStatus string
    The more detailed status of the key set.
    detailedStatusMessage string
    The descriptive message about the current detailed status.
    etag string
    Resource ETag.
    expiration string
    The date and time after which the users in this key set will be removed from the bare metal machines.
    extendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    jumpHostsAllowed string[]
    The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
    lastValidation string
    The last time this key set was validated.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    privilegeLevel string
    The access level allowed for the users in this key set.
    provisioningState string
    The provisioning state of the bare metal machine key set.
    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"
    userList KeySetUserResponse[]
    The unique list of permitted users.
    userListStatus KeySetUserStatusResponse[]
    The status evaluation of each user.
    osGroupName string
    The name of the group that users will be assigned to on the operating system of the machines.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    azure_group_id str
    The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.
    detailed_status str
    The more detailed status of the key set.
    detailed_status_message str
    The descriptive message about the current detailed status.
    etag str
    Resource ETag.
    expiration str
    The date and time after which the users in this key set will be removed from the bare metal machines.
    extended_location ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    jump_hosts_allowed Sequence[str]
    The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
    last_validation str
    The last time this key set was validated.
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    privilege_level str
    The access level allowed for the users in this key set.
    provisioning_state str
    The provisioning state of the bare metal machine key set.
    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"
    user_list Sequence[KeySetUserResponse]
    The unique list of permitted users.
    user_list_status Sequence[KeySetUserStatusResponse]
    The status evaluation of each user.
    os_group_name str
    The name of the group that users will be assigned to on the operating system of the machines.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    azureGroupId String
    The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.
    detailedStatus String
    The more detailed status of the key set.
    detailedStatusMessage String
    The descriptive message about the current detailed status.
    etag String
    Resource ETag.
    expiration String
    The date and time after which the users in this key set will be removed from the bare metal machines.
    extendedLocation Property Map
    The extended location of the cluster associated with the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    jumpHostsAllowed List<String>
    The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
    lastValidation String
    The last time this key set was validated.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    privilegeLevel String
    The access level allowed for the users in this key set.
    provisioningState String
    The provisioning state of the bare metal machine key set.
    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"
    userList List<Property Map>
    The unique list of permitted users.
    userListStatus List<Property Map>
    The status evaluation of each user.
    osGroupName String
    The name of the group that users will be assigned to on the operating system of the machines.
    tags Map<String>
    Resource tags.

    Supporting Types

    ExtendedLocationResponse

    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.
    name string
    The resource ID of the extended location on which the resource will be created.
    type string
    The extended location type, for example, CustomLocation.
    name str
    The resource ID of the extended location on which the resource will be created.
    type str
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.

    KeySetUserResponse

    AzureUserName string
    The user name that will be used for access.
    SshPublicKey Pulumi.AzureNative.NetworkCloud.Inputs.SshPublicKeyResponse
    The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
    Description string
    The free-form description for this user.
    UserPrincipalName string
    The user principal name (email format) used to validate this user's group membership.
    AzureUserName string
    The user name that will be used for access.
    SshPublicKey SshPublicKeyResponse
    The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
    Description string
    The free-form description for this user.
    UserPrincipalName string
    The user principal name (email format) used to validate this user's group membership.
    azureUserName String
    The user name that will be used for access.
    sshPublicKey SshPublicKeyResponse
    The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
    description String
    The free-form description for this user.
    userPrincipalName String
    The user principal name (email format) used to validate this user's group membership.
    azureUserName string
    The user name that will be used for access.
    sshPublicKey SshPublicKeyResponse
    The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
    description string
    The free-form description for this user.
    userPrincipalName string
    The user principal name (email format) used to validate this user's group membership.
    azure_user_name str
    The user name that will be used for access.
    ssh_public_key SshPublicKeyResponse
    The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
    description str
    The free-form description for this user.
    user_principal_name str
    The user principal name (email format) used to validate this user's group membership.
    azureUserName String
    The user name that will be used for access.
    sshPublicKey Property Map
    The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in.
    description String
    The free-form description for this user.
    userPrincipalName String
    The user principal name (email format) used to validate this user's group membership.

    KeySetUserStatusResponse

    AzureUserName string
    The user name that will be used for access.
    Status string
    The indicator of whether the user is currently deployed for access.
    StatusMessage string
    The additional information describing the current status of this user, if any available.
    AzureUserName string
    The user name that will be used for access.
    Status string
    The indicator of whether the user is currently deployed for access.
    StatusMessage string
    The additional information describing the current status of this user, if any available.
    azureUserName String
    The user name that will be used for access.
    status String
    The indicator of whether the user is currently deployed for access.
    statusMessage String
    The additional information describing the current status of this user, if any available.
    azureUserName string
    The user name that will be used for access.
    status string
    The indicator of whether the user is currently deployed for access.
    statusMessage string
    The additional information describing the current status of this user, if any available.
    azure_user_name str
    The user name that will be used for access.
    status str
    The indicator of whether the user is currently deployed for access.
    status_message str
    The additional information describing the current status of this user, if any available.
    azureUserName String
    The user name that will be used for access.
    status String
    The indicator of whether the user is currently deployed for access.
    statusMessage String
    The additional information describing the current status of this user, if any available.

    SshPublicKeyResponse

    KeyData string
    The SSH public key data.
    KeyData string
    The SSH public key data.
    keyData String
    The SSH public key data.
    keyData string
    The SSH public key data.
    key_data str
    The SSH public key data.
    keyData String
    The SSH public key data.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.5.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-azure-native