Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. portal
  5. ConsoleWithLocation
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.portal.ConsoleWithLocation

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Cloud shell console

Uses Azure REST API version 2018-10-01. In version 2.x of the Azure Native provider, it used API version 2018-10-01.

Example Usage

PutConsole

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

return await Deployment.RunAsync(() => 
{
    var consoleWithLocation = new AzureNative.Portal.ConsoleWithLocation("consoleWithLocation", new()
    {
        ConsoleName = "default",
        Location = "eastus",
    });

});
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.NewConsoleWithLocation(ctx, "consoleWithLocation", &portal.ConsoleWithLocationArgs{
			ConsoleName: pulumi.String("default"),
			Location:    pulumi.String("eastus"),
		})
		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.ConsoleWithLocation;
import com.pulumi.azurenative.portal.ConsoleWithLocationArgs;
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 consoleWithLocation = new ConsoleWithLocation("consoleWithLocation", ConsoleWithLocationArgs.builder()
            .consoleName("default")
            .location("eastus")
            .build());

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

const consoleWithLocation = new azure_native.portal.ConsoleWithLocation("consoleWithLocation", {
    consoleName: "default",
    location: "eastus",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

console_with_location = azure_native.portal.ConsoleWithLocation("consoleWithLocation",
    console_name="default",
    location="eastus")
Copy
resources:
  consoleWithLocation:
    type: azure-native:portal:ConsoleWithLocation
    properties:
      consoleName: default
      location: eastus
Copy

Create ConsoleWithLocation Resource

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

Constructor syntax

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

@overload
def ConsoleWithLocation(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        location: Optional[str] = None,
                        console_name: Optional[str] = None)
func NewConsoleWithLocation(ctx *Context, name string, args ConsoleWithLocationArgs, opts ...ResourceOption) (*ConsoleWithLocation, error)
public ConsoleWithLocation(string name, ConsoleWithLocationArgs args, CustomResourceOptions? opts = null)
public ConsoleWithLocation(String name, ConsoleWithLocationArgs args)
public ConsoleWithLocation(String name, ConsoleWithLocationArgs args, CustomResourceOptions options)

type: azure-native:portal:ConsoleWithLocation
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. ConsoleWithLocationArgs
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. ConsoleWithLocationArgs
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. ConsoleWithLocationArgs
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. ConsoleWithLocationArgs
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. ConsoleWithLocationArgs
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 consoleWithLocationResource = new AzureNative.Portal.ConsoleWithLocation("consoleWithLocationResource", new()
{
    Location = "string",
    ConsoleName = "string",
});
Copy
example, err := portal.NewConsoleWithLocation(ctx, "consoleWithLocationResource", &portal.ConsoleWithLocationArgs{
	Location:    pulumi.String("string"),
	ConsoleName: pulumi.String("string"),
})
Copy
var consoleWithLocationResource = new ConsoleWithLocation("consoleWithLocationResource", ConsoleWithLocationArgs.builder()
    .location("string")
    .consoleName("string")
    .build());
Copy
console_with_location_resource = azure_native.portal.ConsoleWithLocation("consoleWithLocationResource",
    location="string",
    console_name="string")
Copy
const consoleWithLocationResource = new azure_native.portal.ConsoleWithLocation("consoleWithLocationResource", {
    location: "string",
    consoleName: "string",
});
Copy
type: azure-native:portal:ConsoleWithLocation
properties:
    consoleName: string
    location: string
Copy

ConsoleWithLocation 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 ConsoleWithLocation resource accepts the following input properties:

Location
This property is required.
Changes to this property will trigger replacement.
string
The provider location
ConsoleName Changes to this property will trigger replacement. string
The name of the console
Location
This property is required.
Changes to this property will trigger replacement.
string
The provider location
ConsoleName Changes to this property will trigger replacement. string
The name of the console
location
This property is required.
Changes to this property will trigger replacement.
String
The provider location
consoleName Changes to this property will trigger replacement. String
The name of the console
location
This property is required.
Changes to this property will trigger replacement.
string
The provider location
consoleName Changes to this property will trigger replacement. string
The name of the console
location
This property is required.
Changes to this property will trigger replacement.
str
The provider location
console_name Changes to this property will trigger replacement. str
The name of the console
location
This property is required.
Changes to this property will trigger replacement.
String
The provider location
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 ConsoleWithLocation resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Properties Pulumi.AzureNative.Portal.Outputs.ConsolePropertiesResponse
Cloud shell console properties.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Properties ConsolePropertiesResponse
Cloud shell console properties.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
properties ConsolePropertiesResponse
Cloud shell console properties.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
properties ConsolePropertiesResponse
Cloud shell console properties.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
properties ConsolePropertiesResponse
Cloud shell console properties.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
properties Property Map
Cloud shell console properties.

Supporting Types

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.

Import

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

$ pulumi import azure-native:portal:ConsoleWithLocation myresource1 /providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native