1. Packages
  2. Azure Native
  3. API Docs
  4. networkcloud
  5. getBmcKeySet
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.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.networkcloud.getBmcKeySet

Explore with Pulumi AI

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.2.0 published on Monday, Apr 14, 2025 by Pulumi

Get baseboard management controller key set of the provided cluster.

Uses Azure REST API version 2025-02-01.

Other available API versions: 2023-10-01-preview, 2024-06-01-preview, 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 getBmcKeySet

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 getBmcKeySet(args: GetBmcKeySetArgs, opts?: InvokeOptions): Promise<GetBmcKeySetResult>
function getBmcKeySetOutput(args: GetBmcKeySetOutputArgs, opts?: InvokeOptions): Output<GetBmcKeySetResult>
Copy
def get_bmc_key_set(bmc_key_set_name: Optional[str] = None,
                    cluster_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetBmcKeySetResult
def get_bmc_key_set_output(bmc_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[GetBmcKeySetResult]
Copy
func LookupBmcKeySet(ctx *Context, args *LookupBmcKeySetArgs, opts ...InvokeOption) (*LookupBmcKeySetResult, error)
func LookupBmcKeySetOutput(ctx *Context, args *LookupBmcKeySetOutputArgs, opts ...InvokeOption) LookupBmcKeySetResultOutput
Copy

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

public static class GetBmcKeySet 
{
    public static Task<GetBmcKeySetResult> InvokeAsync(GetBmcKeySetArgs args, InvokeOptions? opts = null)
    public static Output<GetBmcKeySetResult> Invoke(GetBmcKeySetInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBmcKeySetResult> getBmcKeySet(GetBmcKeySetArgs args, InvokeOptions options)
public static Output<GetBmcKeySetResult> getBmcKeySet(GetBmcKeySetArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:networkcloud:getBmcKeySet
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BmcKeySetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the baseboard management controller key set.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
BmcKeySetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the baseboard management controller key set.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
bmcKeySetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the baseboard management controller key set.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
bmcKeySetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the baseboard management controller key set.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
bmc_key_set_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the baseboard management controller key set.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
bmcKeySetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the baseboard management controller key set.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getBmcKeySet 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 baseboard management controllers.
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}"
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 baseboard management controller 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.
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 baseboard management controllers.
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}"
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 baseboard management controller 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.
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 baseboard management controllers.
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}"
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 baseboard management controller 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.
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 baseboard management controllers.
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}"
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 baseboard management controller 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.
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 baseboard management controllers.
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}"
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 baseboard management controller 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.
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 baseboard management controllers.
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}"
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 baseboard management controller 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.
tags Map<String>
Resource tags.

Supporting Types

ExtendedLocationResponse

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

KeySetUserResponse

AzureUserName This property is required. string
The user name that will be used for access.
SshPublicKey This property is required. 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 This property is required. string
The user name that will be used for access.
SshPublicKey This property is required. 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 This property is required. String
The user name that will be used for access.
sshPublicKey This property is required. 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 This property is required. string
The user name that will be used for access.
sshPublicKey This property is required. 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 This property is required. str
The user name that will be used for access.
ssh_public_key This property is required. 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 This property is required. String
The user name that will be used for access.
sshPublicKey This property is required. 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 This property is required. string
The user name that will be used for access.
Status This property is required. string
The indicator of whether the user is currently deployed for access.
StatusMessage This property is required. string
The additional information describing the current status of this user, if any available.
AzureUserName This property is required. string
The user name that will be used for access.
Status This property is required. string
The indicator of whether the user is currently deployed for access.
StatusMessage This property is required. string
The additional information describing the current status of this user, if any available.
azureUserName This property is required. String
The user name that will be used for access.
status This property is required. String
The indicator of whether the user is currently deployed for access.
statusMessage This property is required. String
The additional information describing the current status of this user, if any available.
azureUserName This property is required. string
The user name that will be used for access.
status This property is required. string
The indicator of whether the user is currently deployed for access.
statusMessage This property is required. string
The additional information describing the current status of this user, if any available.
azure_user_name This property is required. str
The user name that will be used for access.
status This property is required. str
The indicator of whether the user is currently deployed for access.
status_message This property is required. str
The additional information describing the current status of this user, if any available.
azureUserName This property is required. String
The user name that will be used for access.
status This property is required. String
The indicator of whether the user is currently deployed for access.
statusMessage This property is required. String
The additional information describing the current status of this user, if any available.

SshPublicKeyResponse

KeyData This property is required. string
The SSH public key data.
KeyData This property is required. string
The SSH public key data.
keyData This property is required. String
The SSH public key data.
keyData This property is required. string
The SSH public key data.
key_data This property is required. str
The SSH public key data.
keyData This property is required. 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
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.2.0 published on Monday, Apr 14, 2025 by Pulumi