1. Packages
  2. Azure Native v2
  3. API Docs
  4. networkcloud
  5. BareMetalMachineKeySet
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.networkcloud.BareMetalMachineKeySet

Explore with Pulumi AI

Azure REST API version: 2023-10-01-preview. Prior API version in Azure Native 1.x: 2022-12-12-preview.

Other available API versions: 2023-07-01, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview.

Example Usage

Create or update bare metal machine key set of cluster

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var bareMetalMachineKeySet = new AzureNative.NetworkCloud.BareMetalMachineKeySet("bareMetalMachineKeySet", new()
    {
        AzureGroupId = "f110271b-XXXX-4163-9b99-214d91660f0e",
        BareMetalMachineKeySetName = "bareMetalMachineKeySetName",
        ClusterName = "clusterName",
        Expiration = "2022-12-31T23:59:59.008Z",
        ExtendedLocation = new AzureNative.NetworkCloud.Inputs.ExtendedLocationArgs
        {
            Name = "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
            Type = "CustomLocation",
        },
        JumpHostsAllowed = new[]
        {
            "192.0.2.1",
            "192.0.2.5",
        },
        Location = "location",
        OsGroupName = "standardAccessGroup",
        PrivilegeLevel = AzureNative.NetworkCloud.BareMetalMachineKeySetPrivilegeLevel.Standard,
        ResourceGroupName = "resourceGroupName",
        Tags = 
        {
            { "key1", "myvalue1" },
            { "key2", "myvalue2" },
        },
        UserList = new[]
        {
            new AzureNative.NetworkCloud.Inputs.KeySetUserArgs
            {
                AzureUserName = "userABC",
                Description = "Needs access for troubleshooting as a part of the support team",
                SshPublicKey = new AzureNative.NetworkCloud.Inputs.SshPublicKeyArgs
                {
                    KeyData = "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm",
                },
                UserPrincipalName = "userABC@contoso.com",
            },
            new AzureNative.NetworkCloud.Inputs.KeySetUserArgs
            {
                AzureUserName = "userXYZ",
                Description = "Needs access for troubleshooting as a part of the support team",
                SshPublicKey = new AzureNative.NetworkCloud.Inputs.SshPublicKeyArgs
                {
                    KeyData = "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm",
                },
                UserPrincipalName = "userABC@contoso.com",
            },
        },
    });

});
Copy
package main

import (
	networkcloud "github.com/pulumi/pulumi-azure-native-sdk/networkcloud/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkcloud.NewBareMetalMachineKeySet(ctx, "bareMetalMachineKeySet", &networkcloud.BareMetalMachineKeySetArgs{
			AzureGroupId:               pulumi.String("f110271b-XXXX-4163-9b99-214d91660f0e"),
			BareMetalMachineKeySetName: pulumi.String("bareMetalMachineKeySetName"),
			ClusterName:                pulumi.String("clusterName"),
			Expiration:                 pulumi.String("2022-12-31T23:59:59.008Z"),
			ExtendedLocation: &networkcloud.ExtendedLocationArgs{
				Name: pulumi.String("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
				Type: pulumi.String("CustomLocation"),
			},
			JumpHostsAllowed: pulumi.StringArray{
				pulumi.String("192.0.2.1"),
				pulumi.String("192.0.2.5"),
			},
			Location:          pulumi.String("location"),
			OsGroupName:       pulumi.String("standardAccessGroup"),
			PrivilegeLevel:    pulumi.String(networkcloud.BareMetalMachineKeySetPrivilegeLevelStandard),
			ResourceGroupName: pulumi.String("resourceGroupName"),
			Tags: pulumi.StringMap{
				"key1": pulumi.String("myvalue1"),
				"key2": pulumi.String("myvalue2"),
			},
			UserList: networkcloud.KeySetUserArray{
				&networkcloud.KeySetUserArgs{
					AzureUserName: pulumi.String("userABC"),
					Description:   pulumi.String("Needs access for troubleshooting as a part of the support team"),
					SshPublicKey: &networkcloud.SshPublicKeyArgs{
						KeyData: pulumi.String("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"),
					},
					UserPrincipalName: pulumi.String("userABC@contoso.com"),
				},
				&networkcloud.KeySetUserArgs{
					AzureUserName: pulumi.String("userXYZ"),
					Description:   pulumi.String("Needs access for troubleshooting as a part of the support team"),
					SshPublicKey: &networkcloud.SshPublicKeyArgs{
						KeyData: pulumi.String("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"),
					},
					UserPrincipalName: pulumi.String("userABC@contoso.com"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.networkcloud.BareMetalMachineKeySet;
import com.pulumi.azurenative.networkcloud.BareMetalMachineKeySetArgs;
import com.pulumi.azurenative.networkcloud.inputs.ExtendedLocationArgs;
import com.pulumi.azurenative.networkcloud.inputs.KeySetUserArgs;
import com.pulumi.azurenative.networkcloud.inputs.SshPublicKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var bareMetalMachineKeySet = new BareMetalMachineKeySet("bareMetalMachineKeySet", BareMetalMachineKeySetArgs.builder()
            .azureGroupId("f110271b-XXXX-4163-9b99-214d91660f0e")
            .bareMetalMachineKeySetName("bareMetalMachineKeySetName")
            .clusterName("clusterName")
            .expiration("2022-12-31T23:59:59.008Z")
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName")
                .type("CustomLocation")
                .build())
            .jumpHostsAllowed(            
                "192.0.2.1",
                "192.0.2.5")
            .location("location")
            .osGroupName("standardAccessGroup")
            .privilegeLevel("Standard")
            .resourceGroupName("resourceGroupName")
            .tags(Map.ofEntries(
                Map.entry("key1", "myvalue1"),
                Map.entry("key2", "myvalue2")
            ))
            .userList(            
                KeySetUserArgs.builder()
                    .azureUserName("userABC")
                    .description("Needs access for troubleshooting as a part of the support team")
                    .sshPublicKey(SshPublicKeyArgs.builder()
                        .keyData("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm")
                        .build())
                    .userPrincipalName("userABC@contoso.com")
                    .build(),
                KeySetUserArgs.builder()
                    .azureUserName("userXYZ")
                    .description("Needs access for troubleshooting as a part of the support team")
                    .sshPublicKey(SshPublicKeyArgs.builder()
                        .keyData("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm")
                        .build())
                    .userPrincipalName("userABC@contoso.com")
                    .build())
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const bareMetalMachineKeySet = new azure_native.networkcloud.BareMetalMachineKeySet("bareMetalMachineKeySet", {
    azureGroupId: "f110271b-XXXX-4163-9b99-214d91660f0e",
    bareMetalMachineKeySetName: "bareMetalMachineKeySetName",
    clusterName: "clusterName",
    expiration: "2022-12-31T23:59:59.008Z",
    extendedLocation: {
        name: "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
        type: "CustomLocation",
    },
    jumpHostsAllowed: [
        "192.0.2.1",
        "192.0.2.5",
    ],
    location: "location",
    osGroupName: "standardAccessGroup",
    privilegeLevel: azure_native.networkcloud.BareMetalMachineKeySetPrivilegeLevel.Standard,
    resourceGroupName: "resourceGroupName",
    tags: {
        key1: "myvalue1",
        key2: "myvalue2",
    },
    userList: [
        {
            azureUserName: "userABC",
            description: "Needs access for troubleshooting as a part of the support team",
            sshPublicKey: {
                keyData: "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm",
            },
            userPrincipalName: "userABC@contoso.com",
        },
        {
            azureUserName: "userXYZ",
            description: "Needs access for troubleshooting as a part of the support team",
            sshPublicKey: {
                keyData: "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm",
            },
            userPrincipalName: "userABC@contoso.com",
        },
    ],
});
Copy
import pulumi
import pulumi_azure_native as azure_native

bare_metal_machine_key_set = azure_native.networkcloud.BareMetalMachineKeySet("bareMetalMachineKeySet",
    azure_group_id="f110271b-XXXX-4163-9b99-214d91660f0e",
    bare_metal_machine_key_set_name="bareMetalMachineKeySetName",
    cluster_name="clusterName",
    expiration="2022-12-31T23:59:59.008Z",
    extended_location={
        "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
        "type": "CustomLocation",
    },
    jump_hosts_allowed=[
        "192.0.2.1",
        "192.0.2.5",
    ],
    location="location",
    os_group_name="standardAccessGroup",
    privilege_level=azure_native.networkcloud.BareMetalMachineKeySetPrivilegeLevel.STANDARD,
    resource_group_name="resourceGroupName",
    tags={
        "key1": "myvalue1",
        "key2": "myvalue2",
    },
    user_list=[
        {
            "azure_user_name": "userABC",
            "description": "Needs access for troubleshooting as a part of the support team",
            "ssh_public_key": {
                "key_data": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm",
            },
            "user_principal_name": "userABC@contoso.com",
        },
        {
            "azure_user_name": "userXYZ",
            "description": "Needs access for troubleshooting as a part of the support team",
            "ssh_public_key": {
                "key_data": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm",
            },
            "user_principal_name": "userABC@contoso.com",
        },
    ])
Copy
resources:
  bareMetalMachineKeySet:
    type: azure-native:networkcloud:BareMetalMachineKeySet
    properties:
      azureGroupId: f110271b-XXXX-4163-9b99-214d91660f0e
      bareMetalMachineKeySetName: bareMetalMachineKeySetName
      clusterName: clusterName
      expiration: 2022-12-31T23:59:59.008Z
      extendedLocation:
        name: /subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName
        type: CustomLocation
      jumpHostsAllowed:
        - 192.0.2.1
        - 192.0.2.5
      location: location
      osGroupName: standardAccessGroup
      privilegeLevel: Standard
      resourceGroupName: resourceGroupName
      tags:
        key1: myvalue1
        key2: myvalue2
      userList:
        - azureUserName: userABC
          description: Needs access for troubleshooting as a part of the support team
          sshPublicKey:
            keyData: ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm
          userPrincipalName: userABC@contoso.com
        - azureUserName: userXYZ
          description: Needs access for troubleshooting as a part of the support team
          sshPublicKey:
            keyData: ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm
          userPrincipalName: userABC@contoso.com
Copy

Create BareMetalMachineKeySet Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BareMetalMachineKeySet(name: string, args: BareMetalMachineKeySetArgs, opts?: CustomResourceOptions);
@overload
def BareMetalMachineKeySet(resource_name: str,
                           args: BareMetalMachineKeySetArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def BareMetalMachineKeySet(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           azure_group_id: Optional[str] = None,
                           cluster_name: Optional[str] = None,
                           expiration: Optional[str] = None,
                           extended_location: Optional[ExtendedLocationArgs] = None,
                           jump_hosts_allowed: Optional[Sequence[str]] = None,
                           privilege_level: Optional[Union[str, BareMetalMachineKeySetPrivilegeLevel]] = None,
                           resource_group_name: Optional[str] = None,
                           user_list: Optional[Sequence[KeySetUserArgs]] = None,
                           bare_metal_machine_key_set_name: Optional[str] = None,
                           location: Optional[str] = None,
                           os_group_name: Optional[str] = None,
                           tags: Optional[Mapping[str, str]] = None)
func NewBareMetalMachineKeySet(ctx *Context, name string, args BareMetalMachineKeySetArgs, opts ...ResourceOption) (*BareMetalMachineKeySet, error)
public BareMetalMachineKeySet(string name, BareMetalMachineKeySetArgs args, CustomResourceOptions? opts = null)
public BareMetalMachineKeySet(String name, BareMetalMachineKeySetArgs args)
public BareMetalMachineKeySet(String name, BareMetalMachineKeySetArgs args, CustomResourceOptions options)
type: azure-native:networkcloud:BareMetalMachineKeySet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BareMetalMachineKeySetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BareMetalMachineKeySetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BareMetalMachineKeySetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BareMetalMachineKeySetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BareMetalMachineKeySetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var bareMetalMachineKeySetResource = new AzureNative.Networkcloud.BareMetalMachineKeySet("bareMetalMachineKeySetResource", new()
{
    AzureGroupId = "string",
    ClusterName = "string",
    Expiration = "string",
    ExtendedLocation = 
    {
        { "name", "string" },
        { "type", "string" },
    },
    JumpHostsAllowed = new[]
    {
        "string",
    },
    PrivilegeLevel = "string",
    ResourceGroupName = "string",
    UserList = new[]
    {
        
        {
            { "azureUserName", "string" },
            { "sshPublicKey", 
            {
                { "keyData", "string" },
            } },
            { "description", "string" },
            { "userPrincipalName", "string" },
        },
    },
    BareMetalMachineKeySetName = "string",
    Location = "string",
    OsGroupName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := networkcloud.NewBareMetalMachineKeySet(ctx, "bareMetalMachineKeySetResource", &networkcloud.BareMetalMachineKeySetArgs{
	AzureGroupId: "string",
	ClusterName:  "string",
	Expiration:   "string",
	ExtendedLocation: map[string]interface{}{
		"name": "string",
		"type": "string",
	},
	JumpHostsAllowed: []string{
		"string",
	},
	PrivilegeLevel:    "string",
	ResourceGroupName: "string",
	UserList: []map[string]interface{}{
		map[string]interface{}{
			"azureUserName": "string",
			"sshPublicKey": map[string]interface{}{
				"keyData": "string",
			},
			"description":       "string",
			"userPrincipalName": "string",
		},
	},
	BareMetalMachineKeySetName: "string",
	Location:                   "string",
	OsGroupName:                "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})
Copy
var bareMetalMachineKeySetResource = new BareMetalMachineKeySet("bareMetalMachineKeySetResource", BareMetalMachineKeySetArgs.builder()
    .azureGroupId("string")
    .clusterName("string")
    .expiration("string")
    .extendedLocation(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .jumpHostsAllowed("string")
    .privilegeLevel("string")
    .resourceGroupName("string")
    .userList(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .bareMetalMachineKeySetName("string")
    .location("string")
    .osGroupName("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
bare_metal_machine_key_set_resource = azure_native.networkcloud.BareMetalMachineKeySet("bareMetalMachineKeySetResource",
    azure_group_id=string,
    cluster_name=string,
    expiration=string,
    extended_location={
        name: string,
        type: string,
    },
    jump_hosts_allowed=[string],
    privilege_level=string,
    resource_group_name=string,
    user_list=[{
        azureUserName: string,
        sshPublicKey: {
            keyData: string,
        },
        description: string,
        userPrincipalName: string,
    }],
    bare_metal_machine_key_set_name=string,
    location=string,
    os_group_name=string,
    tags={
        string: string,
    })
Copy
const bareMetalMachineKeySetResource = new azure_native.networkcloud.BareMetalMachineKeySet("bareMetalMachineKeySetResource", {
    azureGroupId: "string",
    clusterName: "string",
    expiration: "string",
    extendedLocation: {
        name: "string",
        type: "string",
    },
    jumpHostsAllowed: ["string"],
    privilegeLevel: "string",
    resourceGroupName: "string",
    userList: [{
        azureUserName: "string",
        sshPublicKey: {
            keyData: "string",
        },
        description: "string",
        userPrincipalName: "string",
    }],
    bareMetalMachineKeySetName: "string",
    location: "string",
    osGroupName: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:networkcloud:BareMetalMachineKeySet
properties:
    azureGroupId: string
    bareMetalMachineKeySetName: string
    clusterName: string
    expiration: string
    extendedLocation:
        name: string
        type: string
    jumpHostsAllowed:
        - string
    location: string
    osGroupName: string
    privilegeLevel: string
    resourceGroupName: string
    tags:
        string: string
    userList:
        - azureUserName: string
          description: string
          sshPublicKey:
            keyData: string
          userPrincipalName: string
Copy

BareMetalMachineKeySet Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BareMetalMachineKeySet resource accepts the following input properties:

AzureGroupId
This property is required.
Changes to this property will trigger replacement.
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.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
Expiration This property is required. string
The date and time after which the users in this key set will be removed from the bare metal machines.
ExtendedLocation This property is required. Pulumi.AzureNative.NetworkCloud.Inputs.ExtendedLocation
The extended location of the cluster associated with the resource.
JumpHostsAllowed This property is required. List<string>
The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
PrivilegeLevel
This property is required.
Changes to this property will trigger replacement.
string | Pulumi.AzureNative.NetworkCloud.BareMetalMachineKeySetPrivilegeLevel
The access level allowed for the users in this key set.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
UserList This property is required. List<Pulumi.AzureNative.NetworkCloud.Inputs.KeySetUser>
The unique list of permitted users.
BareMetalMachineKeySetName Changes to this property will trigger replacement. string
The name of the bare metal machine key set.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
OsGroupName Changes to this property will trigger replacement. 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.
AzureGroupId
This property is required.
Changes to this property will trigger replacement.
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.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
Expiration This property is required. string
The date and time after which the users in this key set will be removed from the bare metal machines.
ExtendedLocation This property is required. ExtendedLocationArgs
The extended location of the cluster associated with the resource.
JumpHostsAllowed This property is required. []string
The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
PrivilegeLevel
This property is required.
Changes to this property will trigger replacement.
string | BareMetalMachineKeySetPrivilegeLevel
The access level allowed for the users in this key set.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
UserList This property is required. []KeySetUserArgs
The unique list of permitted users.
BareMetalMachineKeySetName Changes to this property will trigger replacement. string
The name of the bare metal machine key set.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
OsGroupName Changes to this property will trigger replacement. 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.
azureGroupId
This property is required.
Changes to this property will trigger replacement.
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.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
expiration This property is required. String
The date and time after which the users in this key set will be removed from the bare metal machines.
extendedLocation This property is required. ExtendedLocation
The extended location of the cluster associated with the resource.
jumpHostsAllowed This property is required. List<String>
The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
privilegeLevel
This property is required.
Changes to this property will trigger replacement.
String | BareMetalMachineKeySetPrivilegeLevel
The access level allowed for the users in this key set.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
userList This property is required. List<KeySetUser>
The unique list of permitted users.
bareMetalMachineKeySetName Changes to this property will trigger replacement. String
The name of the bare metal machine key set.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
osGroupName Changes to this property will trigger replacement. 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.
azureGroupId
This property is required.
Changes to this property will trigger replacement.
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.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
expiration This property is required. string
The date and time after which the users in this key set will be removed from the bare metal machines.
extendedLocation This property is required. ExtendedLocation
The extended location of the cluster associated with the resource.
jumpHostsAllowed This property is required. string[]
The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
privilegeLevel
This property is required.
Changes to this property will trigger replacement.
string | BareMetalMachineKeySetPrivilegeLevel
The access level allowed for the users in this key set.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
userList This property is required. KeySetUser[]
The unique list of permitted users.
bareMetalMachineKeySetName Changes to this property will trigger replacement. string
The name of the bare metal machine key set.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
osGroupName Changes to this property will trigger replacement. 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_group_id
This property is required.
Changes to this property will trigger replacement.
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.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cluster.
expiration This property is required. str
The date and time after which the users in this key set will be removed from the bare metal machines.
extended_location This property is required. ExtendedLocationArgs
The extended location of the cluster associated with the resource.
jump_hosts_allowed This property is required. Sequence[str]
The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
privilege_level
This property is required.
Changes to this property will trigger replacement.
str | BareMetalMachineKeySetPrivilegeLevel
The access level allowed for the users in this key set.
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.
user_list This property is required. Sequence[KeySetUserArgs]
The unique list of permitted users.
bare_metal_machine_key_set_name Changes to this property will trigger replacement. str
The name of the bare metal machine key set.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
os_group_name Changes to this property will trigger replacement. 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.
azureGroupId
This property is required.
Changes to this property will trigger replacement.
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.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
expiration This property is required. String
The date and time after which the users in this key set will be removed from the bare metal machines.
extendedLocation This property is required. Property Map
The extended location of the cluster associated with the resource.
jumpHostsAllowed This property is required. List<String>
The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
privilegeLevel
This property is required.
Changes to this property will trigger replacement.
String | "Standard" | "Superuser"
The access level allowed for the users in this key set.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
userList This property is required. List<Property Map>
The unique list of permitted users.
bareMetalMachineKeySetName Changes to this property will trigger replacement. String
The name of the bare metal machine key set.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
osGroupName Changes to this property will trigger replacement. String
The name of the group that users will be assigned to on the operating system of the machines.
tags Map<String>
Resource tags.

Outputs

All input properties are implicitly available as output properties. Additionally, the BareMetalMachineKeySet resource produces the following output properties:

DetailedStatus string
The more detailed status of the key set.
DetailedStatusMessage string
The descriptive message about the current detailed status.
Id string
The provider-assigned unique ID for this managed resource.
LastValidation string
The last time this key set was validated.
Name string
The name of the resource
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"
UserListStatus List<Pulumi.AzureNative.NetworkCloud.Outputs.KeySetUserStatusResponse>
The status evaluation of each user.
DetailedStatus string
The more detailed status of the key set.
DetailedStatusMessage string
The descriptive message about the current detailed status.
Id string
The provider-assigned unique ID for this managed resource.
LastValidation string
The last time this key set was validated.
Name string
The name of the resource
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"
UserListStatus []KeySetUserStatusResponse
The status evaluation of each user.
detailedStatus String
The more detailed status of the key set.
detailedStatusMessage String
The descriptive message about the current detailed status.
id String
The provider-assigned unique ID for this managed resource.
lastValidation String
The last time this key set was validated.
name String
The name of the resource
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"
userListStatus List<KeySetUserStatusResponse>
The status evaluation of each user.
detailedStatus string
The more detailed status of the key set.
detailedStatusMessage string
The descriptive message about the current detailed status.
id string
The provider-assigned unique ID for this managed resource.
lastValidation string
The last time this key set was validated.
name string
The name of the resource
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"
userListStatus KeySetUserStatusResponse[]
The status evaluation of each user.
detailed_status str
The more detailed status of the key set.
detailed_status_message str
The descriptive message about the current detailed status.
id str
The provider-assigned unique ID for this managed resource.
last_validation str
The last time this key set was validated.
name str
The name of the resource
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_status Sequence[KeySetUserStatusResponse]
The status evaluation of each user.
detailedStatus String
The more detailed status of the key set.
detailedStatusMessage String
The descriptive message about the current detailed status.
id String
The provider-assigned unique ID for this managed resource.
lastValidation String
The last time this key set was validated.
name String
The name of the resource
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"
userListStatus List<Property Map>
The status evaluation of each user.

Supporting Types

BareMetalMachineKeySetPrivilegeLevel
, BareMetalMachineKeySetPrivilegeLevelArgs

Standard
Standard
Superuser
Superuser
BareMetalMachineKeySetPrivilegeLevelStandard
Standard
BareMetalMachineKeySetPrivilegeLevelSuperuser
Superuser
Standard
Standard
Superuser
Superuser
Standard
Standard
Superuser
Superuser
STANDARD
Standard
SUPERUSER
Superuser
"Standard"
Standard
"Superuser"
Superuser

ExtendedLocation
, ExtendedLocationArgs

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.

ExtendedLocationResponse
, ExtendedLocationResponseArgs

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.

KeySetUser
, KeySetUserArgs

AzureUserName This property is required. string
The user name that will be used for access.
SshPublicKey This property is required. Pulumi.AzureNative.NetworkCloud.Inputs.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.
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. 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.
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. 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.
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. 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.
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. 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.
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.

KeySetUserResponse
, KeySetUserResponseArgs

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
, KeySetUserStatusResponseArgs

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.

SshPublicKey
, SshPublicKeyArgs

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.

SshPublicKeyResponse
, SshPublicKeyResponseArgs

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
, SystemDataResponseArgs

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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:networkcloud:BareMetalMachineKeySet bareMetalMachineKeySetName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets/{bareMetalMachineKeySetName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0