Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. portal
  5. Console
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
pulumi/pulumi-azure-native

azure-native-v2.portal.Console

Explore with Pulumi AI

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
pulumi/pulumi-azure-native

Cloud shell console Azure REST API version: 2018-10-01. Prior API version in Azure Native 1.x: 2018-10-01.

Example Usage

PutConsole

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

return await Deployment.RunAsync(() => 
{
    var console = new AzureNative.Portal.Console("console", new()
    {
        ConsoleName = "default",
        Properties = new AzureNative.Portal.Inputs.ConsoleCreatePropertiesArgs
        {
            OsType = AzureNative.Portal.OsType.Linux,
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := portal.NewConsole(ctx, "console", &portal.ConsoleArgs{
			ConsoleName: pulumi.String("default"),
			Properties: &portal.ConsoleCreatePropertiesArgs{
				OsType: pulumi.String(portal.OsTypeLinux),
			},
		})
		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.portal.Console;
import com.pulumi.azurenative.portal.ConsoleArgs;
import com.pulumi.azurenative.portal.inputs.ConsoleCreatePropertiesArgs;
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")
            .properties(ConsoleCreatePropertiesArgs.builder()
                .osType("Linux")
                .build())
            .build());

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

const console = new azure_native.portal.Console("console", {
    consoleName: "default",
    properties: {
        osType: azure_native.portal.OsType.Linux,
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

console = azure_native.portal.Console("console",
    console_name="default",
    properties={
        "os_type": azure_native.portal.OsType.LINUX,
    })
Copy
resources:
  console:
    type: azure-native:portal:Console
    properties:
      consoleName: default
      properties:
        osType: Linux
Copy

Create Console Resource

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

Constructor syntax

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

@overload
def Console(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            properties: Optional[ConsoleCreatePropertiesArgs] = None,
            console_name: Optional[str] = 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:portal:Console
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. ConsoleArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. ConsoleArgs
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. ConsoleArgs
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. ConsoleArgs
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 azure_nativeConsoleResource = new AzureNative.Portal.Console("azure-nativeConsoleResource", new()
{
    Properties = 
    {
        { "osType", "string" },
        { "provisioningState", "string" },
        { "uri", "string" },
    },
    ConsoleName = "string",
});
Copy
example, err := portal.NewConsole(ctx, "azure-nativeConsoleResource", &portal.ConsoleArgs{
	Properties: map[string]interface{}{
		"osType":            "string",
		"provisioningState": "string",
		"uri":               "string",
	},
	ConsoleName: "string",
})
Copy
var azure_nativeConsoleResource = new Console("azure-nativeConsoleResource", ConsoleArgs.builder()
    .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .consoleName("string")
    .build());
Copy
azure_native_console_resource = azure_native.portal.Console("azure-nativeConsoleResource",
    properties={
        osType: string,
        provisioningState: string,
        uri: string,
    },
    console_name=string)
Copy
const azure_nativeConsoleResource = new azure_native.portal.Console("azure-nativeConsoleResource", {
    properties: {
        osType: "string",
        provisioningState: "string",
        uri: "string",
    },
    consoleName: "string",
});
Copy
type: azure-native:portal:Console
properties:
    consoleName: string
    properties:
        osType: string
        provisioningState: string
        uri: string
Copy

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

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

The Console resource accepts the following input properties:

Properties This property is required. Pulumi.AzureNative.Portal.Inputs.ConsoleCreateProperties
Cloud shell properties for creating a console.
ConsoleName Changes to this property will trigger replacement. string
The name of the console
Properties This property is required. ConsoleCreatePropertiesArgs
Cloud shell properties for creating a console.
ConsoleName Changes to this property will trigger replacement. string
The name of the console
properties This property is required. ConsoleCreateProperties
Cloud shell properties for creating a console.
consoleName Changes to this property will trigger replacement. String
The name of the console
properties This property is required. ConsoleCreateProperties
Cloud shell properties for creating a console.
consoleName Changes to this property will trigger replacement. string
The name of the console
properties This property is required. ConsoleCreatePropertiesArgs
Cloud shell properties for creating a console.
console_name Changes to this property will trigger replacement. str
The name of the console
properties This property is required. Property Map
Cloud shell properties for creating a console.
consoleName Changes to this property will trigger replacement. String
The name of the console

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

ConsoleCreateProperties
, ConsoleCreatePropertiesArgs

OsType This property is required. string | Pulumi.AzureNative.Portal.OsType
The operating system type of the cloud shell.
ProvisioningState string | Pulumi.AzureNative.Portal.ProvisioningState
Provisioning state of the console.
Uri string
Uri of the console.
OsType This property is required. string | OsType
The operating system type of the cloud shell.
ProvisioningState string | ProvisioningState
Provisioning state of the console.
Uri string
Uri of the console.
osType This property is required. String | OsType
The operating system type of the cloud shell.
provisioningState String | ProvisioningState
Provisioning state of the console.
uri String
Uri of the console.
osType This property is required. string | OsType
The operating system type of the cloud shell.
provisioningState string | ProvisioningState
Provisioning state of the console.
uri string
Uri of the console.
os_type This property is required. str | OsType
The operating system type of the cloud shell.
provisioning_state str | ProvisioningState
Provisioning state of the console.
uri str
Uri of the console.
osType This property is required. String | "Windows" | "Linux"
The operating system type of the cloud shell.
provisioningState String | "NotSpecified" | "Accepted" | "Pending" | "Updating" | "Creating" | "Repairing" | "Failed" | "Canceled" | "Succeeded"
Provisioning state of the console.
uri String
Uri of the console.

ConsolePropertiesResponse
, ConsolePropertiesResponseArgs

OsType This property is required. string
The operating system type of the cloud shell.
ProvisioningState This property is required. string
Provisioning state of the console.
Uri This property is required. string
Uri of the console.
OsType This property is required. string
The operating system type of the cloud shell.
ProvisioningState This property is required. string
Provisioning state of the console.
Uri This property is required. string
Uri of the console.
osType This property is required. String
The operating system type of the cloud shell.
provisioningState This property is required. String
Provisioning state of the console.
uri This property is required. String
Uri of the console.
osType This property is required. string
The operating system type of the cloud shell.
provisioningState This property is required. string
Provisioning state of the console.
uri This property is required. string
Uri of the console.
os_type This property is required. str
The operating system type of the cloud shell.
provisioning_state This property is required. str
Provisioning state of the console.
uri This property is required. str
Uri of the console.
osType This property is required. String
The operating system type of the cloud shell.
provisioningState This property is required. String
Provisioning state of the console.
uri This property is required. String
Uri of the console.

OsType
, OsTypeArgs

Windows
Windows
Linux
Linux
OsTypeWindows
Windows
OsTypeLinux
Linux
Windows
Windows
Linux
Linux
Windows
Windows
Linux
Linux
WINDOWS
Windows
LINUX
Linux
"Windows"
Windows
"Linux"
Linux

ProvisioningState
, ProvisioningStateArgs

NotSpecified
NotSpecified
Accepted
Accepted
Pending
Pending
Updating
Updating
Creating
Creating
Repairing
Repairing
Failed
Failed
Canceled
Canceled
Succeeded
Succeeded
ProvisioningStateNotSpecified
NotSpecified
ProvisioningStateAccepted
Accepted
ProvisioningStatePending
Pending
ProvisioningStateUpdating
Updating
ProvisioningStateCreating
Creating
ProvisioningStateRepairing
Repairing
ProvisioningStateFailed
Failed
ProvisioningStateCanceled
Canceled
ProvisioningStateSucceeded
Succeeded
NotSpecified
NotSpecified
Accepted
Accepted
Pending
Pending
Updating
Updating
Creating
Creating
Repairing
Repairing
Failed
Failed
Canceled
Canceled
Succeeded
Succeeded
NotSpecified
NotSpecified
Accepted
Accepted
Pending
Pending
Updating
Updating
Creating
Creating
Repairing
Repairing
Failed
Failed
Canceled
Canceled
Succeeded
Succeeded
NOT_SPECIFIED
NotSpecified
ACCEPTED
Accepted
PENDING
Pending
UPDATING
Updating
CREATING
Creating
REPAIRING
Repairing
FAILED
Failed
CANCELED
Canceled
SUCCEEDED
Succeeded
"NotSpecified"
NotSpecified
"Accepted"
Accepted
"Pending"
Pending
"Updating"
Updating
"Creating"
Creating
"Repairing"
Repairing
"Failed"
Failed
"Canceled"
Canceled
"Succeeded"
Succeeded

Import

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

$ pulumi import azure-native:portal:Console myresource1 /providers/Microsoft.Portal/consoles/{consoleName}
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
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
pulumi/pulumi-azure-native