Azure Native v1.98.1, Mar 24 23

azure-native.networkcloud.Console

API Version: 2022-12-12-preview.

Example Usage

Create or update virtual machine console

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

return await Deployment.RunAsync(() => 
{
    var console = new AzureNative.NetworkCloud.Console("console", new()
    {
        ConsoleName = "default",
        Enabled = "True",
        Expiration = "2022-06-01T01:27:03.008Z",
        ExtendedLocation = new AzureNative.NetworkCloud.Inputs.ExtendedLocationArgs
        {
            Name = "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName",
            Type = "CustomLocation",
        },
        Location = "location",
        ResourceGroupName = "resourceGroupName",
        SshPublicKey = new AzureNative.NetworkCloud.Inputs.SshPublicKeyArgs
        {
            KeyData = "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm",
        },
        Tags = 
        {
            { "key1", "myvalue1" },
            { "key2", "myvalue2" },
        },
        VirtualMachineName = "virtualMachineName",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkcloud.NewConsole(ctx, "console", &networkcloud.ConsoleArgs{
			ConsoleName: pulumi.String("default"),
			Enabled:     pulumi.String("True"),
			Expiration:  pulumi.String("2022-06-01T01:27:03.008Z"),
			ExtendedLocation: &networkcloud.ExtendedLocationArgs{
				Name: pulumi.String("/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName"),
				Type: pulumi.String("CustomLocation"),
			},
			Location:          pulumi.String("location"),
			ResourceGroupName: pulumi.String("resourceGroupName"),
			SshPublicKey: &networkcloud.SshPublicKeyArgs{
				KeyData: pulumi.String("ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"),
			},
			Tags: pulumi.StringMap{
				"key1": pulumi.String("myvalue1"),
				"key2": pulumi.String("myvalue2"),
			},
			VirtualMachineName: pulumi.String("virtualMachineName"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.networkcloud.Console;
import com.pulumi.azurenative.networkcloud.ConsoleArgs;
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 console = new Console("console", ConsoleArgs.builder()        
            .consoleName("default")
            .enabled("True")
            .expiration("2022-06-01T01:27:03.008Z")
            .extendedLocation(Map.ofEntries(
                Map.entry("name", "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName"),
                Map.entry("type", "CustomLocation")
            ))
            .location("location")
            .resourceGroupName("resourceGroupName")
            .sshPublicKey(Map.of("keyData", "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"))
            .tags(Map.ofEntries(
                Map.entry("key1", "myvalue1"),
                Map.entry("key2", "myvalue2")
            ))
            .virtualMachineName("virtualMachineName")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

console = azure_native.networkcloud.Console("console",
    console_name="default",
    enabled="True",
    expiration="2022-06-01T01:27:03.008Z",
    extended_location=azure_native.networkcloud.ExtendedLocationArgs(
        name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName",
        type="CustomLocation",
    ),
    location="location",
    resource_group_name="resourceGroupName",
    ssh_public_key=azure_native.networkcloud.SshPublicKeyArgs(
        key_data="ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm",
    ),
    tags={
        "key1": "myvalue1",
        "key2": "myvalue2",
    },
    virtual_machine_name="virtualMachineName")

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

const console = new azure_native.networkcloud.Console("console", {
    consoleName: "default",
    enabled: "True",
    expiration: "2022-06-01T01:27:03.008Z",
    extendedLocation: {
        name: "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName",
        type: "CustomLocation",
    },
    location: "location",
    resourceGroupName: "resourceGroupName",
    sshPublicKey: {
        keyData: "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm",
    },
    tags: {
        key1: "myvalue1",
        key2: "myvalue2",
    },
    virtualMachineName: "virtualMachineName",
});

resources:
  console:
    type: azure-native:networkcloud:Console
    properties:
      consoleName: default
      enabled: True
      expiration: 2022-06-01T01:27:03.008Z
      extendedLocation:
        name: /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName
        type: CustomLocation
      location: location
      resourceGroupName: resourceGroupName
      sshPublicKey:
        keyData: ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm
      tags:
        key1: myvalue1
        key2: myvalue2
      virtualMachineName: virtualMachineName

Create Console Resource

new Console(name: string, args: ConsoleArgs, opts?: CustomResourceOptions);

@overload
def Console(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            console_name: Optional[str] = None,
            enabled: Optional[Union[str, ConsoleEnabled]] = None,
            expiration: Optional[str] = None,
            extended_location: Optional[ExtendedLocationArgs] = None,
            location: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            ssh_public_key: Optional[SshPublicKeyArgs] = None,
            tags: Optional[Mapping[str, str]] = None,
            virtual_machine_name: Optional[str] = None)
@overload
def Console(resource_name: str,
            args: ConsoleArgs,
            opts: Optional[ResourceOptions] = None)

func NewConsole(ctx *Context, name string, args ConsoleArgs, opts ...ResourceOption) (*Console, error)

public Console(string name, ConsoleArgs args, CustomResourceOptions? opts = null)

public Console(String name, ConsoleArgs args)
public Console(String name, ConsoleArgs args, CustomResourceOptions options)

type: azure-native:networkcloud:Console
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConsoleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ConsoleArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ConsoleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConsoleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ConsoleArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Console Resource Properties

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

Inputs

The Console resource accepts the following input properties:

Enabled string | Pulumi.AzureNative.NetworkCloud.ConsoleEnabled: The indicator of whether the console access is enabled.
ExtendedLocation Pulumi.AzureNative.NetworkCloud.Inputs.ExtendedLocationArgs: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
SshPublicKey Pulumi.AzureNative.NetworkCloud.Inputs.SshPublicKeyArgs
VirtualMachineName string: The name of the virtual machine.
ConsoleName string: The name of the virtual machine console.
Expiration string: The date and time after which the key will be disallowed access.
Location string: The geo-location where the resource lives
Tags Dictionary<string, string>: Resource tags.

Enabled string | ConsoleEnabled: The indicator of whether the console access is enabled.
ExtendedLocation ExtendedLocationArgs: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
SshPublicKey SshPublicKeyArgs
VirtualMachineName string: The name of the virtual machine.
ConsoleName string: The name of the virtual machine console.
Expiration string: The date and time after which the key will be disallowed access.
Location string: The geo-location where the resource lives
Tags map[string]string: Resource tags.

enabled String | ConsoleEnabled: The indicator of whether the console access is enabled.
extendedLocation ExtendedLocationArgs: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
resourceGroupName String: The name of the resource group. The name is case insensitive.
sshPublicKey SshPublicKeyArgs
virtualMachineName String: The name of the virtual machine.
consoleName String: The name of the virtual machine console.
expiration String: The date and time after which the key will be disallowed access.
location String: The geo-location where the resource lives
tags Map<String,String>: Resource tags.

enabled string | ConsoleEnabled: The indicator of whether the console access is enabled.
extendedLocation ExtendedLocationArgs: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
resourceGroupName string: The name of the resource group. The name is case insensitive.
sshPublicKey SshPublicKeyArgs
virtualMachineName string: The name of the virtual machine.
consoleName string: The name of the virtual machine console.
expiration string: The date and time after which the key will be disallowed access.
location string: The geo-location where the resource lives
tags {[key: string]: string}: Resource tags.

enabled str | ConsoleEnabled: The indicator of whether the console access is enabled.
extended_location ExtendedLocationArgs: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
resource_group_name str: The name of the resource group. The name is case insensitive.
ssh_public_key SshPublicKeyArgs
virtual_machine_name str: The name of the virtual machine.
console_name str: The name of the virtual machine console.
expiration str: The date and time after which the key will be disallowed access.
location str: The geo-location where the resource lives
tags Mapping[str, str]: Resource tags.

enabled String | "True" | "False": The indicator of whether the console access is enabled.
extendedLocation Property Map: The extended location of the cluster manager associated with the cluster this virtual machine is created on.
resourceGroupName String: The name of the resource group. The name is case insensitive.
sshPublicKey Property Map
virtualMachineName String: The name of the virtual machine.
consoleName String: The name of the virtual machine console.
expiration String: The date and time after which the key will be disallowed access.
location String: The geo-location where the resource lives
tags Map<String>: Resource tags.

Outputs

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

DetailedStatus string: The more detailed status of the console.
DetailedStatusMessage string: The descriptive message about the current detailed status.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the resource
PrivateLinkServiceId string: The resource ID of the private link service that is used to provide virtual machine console access.
ProvisioningState string: The provisioning state of the virtual machine console.
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"
VirtualMachineAccessId string: The unique identifier for the virtual machine that is used to access the console.

DetailedStatus string: The more detailed status of the console.
DetailedStatusMessage string: The descriptive message about the current detailed status.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the resource
PrivateLinkServiceId string: The resource ID of the private link service that is used to provide virtual machine console access.
ProvisioningState string: The provisioning state of the virtual machine console.
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"
VirtualMachineAccessId string: The unique identifier for the virtual machine that is used to access the console.

detailedStatus String: The more detailed status of the console.
detailedStatusMessage String: The descriptive message about the current detailed status.
id String: The provider-assigned unique ID for this managed resource.
name String: The name of the resource
privateLinkServiceId String: The resource ID of the private link service that is used to provide virtual machine console access.
provisioningState String: The provisioning state of the virtual machine console.
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"
virtualMachineAccessId String: The unique identifier for the virtual machine that is used to access the console.

detailedStatus string: The more detailed status of the console.
detailedStatusMessage string: The descriptive message about the current detailed status.
id string: The provider-assigned unique ID for this managed resource.
name string: The name of the resource
privateLinkServiceId string: The resource ID of the private link service that is used to provide virtual machine console access.
provisioningState string: The provisioning state of the virtual machine console.
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"
virtualMachineAccessId string: The unique identifier for the virtual machine that is used to access the console.

detailed_status str: The more detailed status of the console.
detailed_status_message str: The descriptive message about the current detailed status.
id str: The provider-assigned unique ID for this managed resource.
name str: The name of the resource
private_link_service_id str: The resource ID of the private link service that is used to provide virtual machine console access.
provisioning_state str: The provisioning state of the virtual machine console.
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"
virtual_machine_access_id str: The unique identifier for the virtual machine that is used to access the console.

detailedStatus String: The more detailed status of the console.
detailedStatusMessage String: The descriptive message about the current detailed status.
id String: The provider-assigned unique ID for this managed resource.
name String: The name of the resource
privateLinkServiceId String: The resource ID of the private link service that is used to provide virtual machine console access.
provisioningState String: The provisioning state of the virtual machine console.
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"
virtualMachineAccessId String: The unique identifier for the virtual machine that is used to access the console.

Supporting Types

ConsoleEnabled

True: True
False: False

ConsoleEnabledTrue: True
ConsoleEnabledFalse: False

True: True
False: False

True: True
False: False

TRUE: True
FALSE: False

"True": True
"False": False

ExtendedLocation

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.

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.

SshPublicKey

KeyData string: The public ssh key of the user.

KeyData string: The public ssh key of the user.

keyData String: The public ssh key of the user.

keyData string: The public ssh key of the user.

key_data str: The public ssh key of the user.

keyData String: The public ssh key of the user.

SshPublicKeyResponse

KeyData string: The public ssh key of the user.

KeyData string: The public ssh key of the user.

keyData String: The public ssh key of the user.

keyData string: The public ssh key of the user.

key_data str: The public ssh key of the user.

keyData String: The public ssh key of the user.

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.

Import

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

$ pulumi import azure-native:networkcloud:Console default /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0