Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The clusters/bmcKeySets resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetworkCloud/clusters/bmcKeySets resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.NetworkCloud/clusters/bmcKeySets@2024-06-01-preview' = {
parent: resourceSymbolicName
extendedLocation: {
name: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
azureGroupId: 'string'
expiration: 'string'
privilegeLevel: 'string'
userList: [
{
azureUserName: 'string'
description: 'string'
sshPublicKey: {
keyData: 'string'
}
userPrincipalName: 'string'
}
]
}
tags: {
{customized property}: 'string'
}
}
Property Values
BmcKeySetProperties
| Name | Description | Value |
|---|---|---|
| azureGroupId | 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. | string (required) |
| expiration | The date and time after which the users in this key set will be removed from the baseboard management controllers. | string (required) |
| privilegeLevel | The access level allowed for the users in this key set. | 'Administrator' 'ReadOnly' (required) |
| userList | The unique list of permitted users. | KeySetUser[] (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The resource ID of the extended location on which the resource will be created. | string (required) |
| type | The extended location type, for example, CustomLocation. | string (required) |
KeySetUser
| Name | Description | Value |
|---|---|---|
| azureUserName | The user name that will be used for access. | string (required) |
| description | The free-form description for this user. | string Constraints: Max length = 256 |
| sshPublicKey | 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. | SshPublicKey (required) |
| userPrincipalName | The user principal name (email format) used to validate this user's group membership. | string |
Microsoft.NetworkCloud/clusters/bmcKeySets
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location of the cluster associated with the resource. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: clusters |
| properties | The list of the resource properties. | BmcKeySetProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
SshPublicKey
| Name | Description | Value |
|---|---|---|
| keyData | The SSH public key data. | string Constraints: Min length = 1 (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The clusters/bmcKeySets resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetworkCloud/clusters/bmcKeySets resource, add the following JSON to your template.
{
"type": "Microsoft.NetworkCloud/clusters/bmcKeySets",
"apiVersion": "2024-06-01-preview",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"location": "string",
"properties": {
"azureGroupId": "string",
"expiration": "string",
"privilegeLevel": "string",
"userList": [
{
"azureUserName": "string",
"description": "string",
"sshPublicKey": {
"keyData": "string"
},
"userPrincipalName": "string"
}
]
},
"tags": {
"{customized property}": "string"
}
}
Property Values
BmcKeySetProperties
| Name | Description | Value |
|---|---|---|
| azureGroupId | 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. | string (required) |
| expiration | The date and time after which the users in this key set will be removed from the baseboard management controllers. | string (required) |
| privilegeLevel | The access level allowed for the users in this key set. | 'Administrator' 'ReadOnly' (required) |
| userList | The unique list of permitted users. | KeySetUser[] (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The resource ID of the extended location on which the resource will be created. | string (required) |
| type | The extended location type, for example, CustomLocation. | string (required) |
KeySetUser
| Name | Description | Value |
|---|---|---|
| azureUserName | The user name that will be used for access. | string (required) |
| description | The free-form description for this user. | string Constraints: Max length = 256 |
| sshPublicKey | 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. | SshPublicKey (required) |
| userPrincipalName | The user principal name (email format) used to validate this user's group membership. | string |
Microsoft.NetworkCloud/clusters/bmcKeySets
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-06-01-preview' |
| extendedLocation | The extended location of the cluster associated with the resource. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ (required) |
| properties | The list of the resource properties. | BmcKeySetProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.NetworkCloud/clusters/bmcKeySets' |
SshPublicKey
| Name | Description | Value |
|---|---|---|
| keyData | The SSH public key data. | string Constraints: Min length = 1 (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The clusters/bmcKeySets resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetworkCloud/clusters/bmcKeySets resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NetworkCloud/clusters/bmcKeySets@2024-06-01-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
extendedLocation = {
name = "string"
type = "string"
}
properties = {
azureGroupId = "string"
expiration = "string"
privilegeLevel = "string"
userList = [
{
azureUserName = "string"
description = "string"
sshPublicKey = {
keyData = "string"
}
userPrincipalName = "string"
}
]
}
}
}
Property Values
BmcKeySetProperties
| Name | Description | Value |
|---|---|---|
| azureGroupId | 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. | string (required) |
| expiration | The date and time after which the users in this key set will be removed from the baseboard management controllers. | string (required) |
| privilegeLevel | The access level allowed for the users in this key set. | 'Administrator' 'ReadOnly' (required) |
| userList | The unique list of permitted users. | KeySetUser[] (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The resource ID of the extended location on which the resource will be created. | string (required) |
| type | The extended location type, for example, CustomLocation. | string (required) |
KeySetUser
| Name | Description | Value |
|---|---|---|
| azureUserName | The user name that will be used for access. | string (required) |
| description | The free-form description for this user. | string Constraints: Max length = 256 |
| sshPublicKey | 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. | SshPublicKey (required) |
| userPrincipalName | The user principal name (email format) used to validate this user's group membership. | string |
Microsoft.NetworkCloud/clusters/bmcKeySets
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location of the cluster associated with the resource. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: clusters |
| properties | The list of the resource properties. | BmcKeySetProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.NetworkCloud/clusters/bmcKeySets@2024-06-01-preview" |
SshPublicKey
| Name | Description | Value |
|---|---|---|
| keyData | The SSH public key data. | string Constraints: Min length = 1 (required) |
TrackedResourceTags
| Name | Description | Value |
|---|