azure-native.portal.Console
Explore with Pulumi AI
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,
},
});
});
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
})
}
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());
}
}
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,
})
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,
},
});
resources:
console:
type: azure-native:portal:Console
properties:
consoleName: default
properties:
osType: Linux
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 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var azure_nativeConsoleResource = new AzureNative.Portal.Console("azure-nativeConsoleResource", new()
{
Properties = new AzureNative.Portal.Inputs.ConsoleCreatePropertiesArgs
{
OsType = "string",
ProvisioningState = "string",
Uri = "string",
},
ConsoleName = "string",
});
example, err := portal.NewConsole(ctx, "azure-nativeConsoleResource", &portal.ConsoleArgs{
Properties: &portal.ConsoleCreatePropertiesArgs{
OsType: pulumi.String("string"),
ProvisioningState: pulumi.String("string"),
Uri: pulumi.String("string"),
},
ConsoleName: pulumi.String("string"),
})
var azure_nativeConsoleResource = new Console("azure-nativeConsoleResource", ConsoleArgs.builder()
.properties(ConsoleCreatePropertiesArgs.builder()
.osType("string")
.provisioningState("string")
.uri("string")
.build())
.consoleName("string")
.build());
azure_native_console_resource = azure_native.portal.Console("azure-nativeConsoleResource",
properties={
"osType": "string",
"provisioningState": "string",
"uri": "string",
},
console_name="string")
const azure_nativeConsoleResource = new azure_native.portal.Console("azure-nativeConsoleResource", {
properties: {
osType: "string",
provisioningState: "string",
uri: "string",
},
consoleName: "string",
});
type: azure-native:portal:Console
properties:
consoleName: string
properties:
osType: string
provisioningState: string
uri: string
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:
- Properties
Pulumi.
Azure Native. Portal. Inputs. Console Create Properties - Cloud shell properties for creating a console.
- Console
Name string - The name of the console
- Properties
Console
Create Properties Args - Cloud shell properties for creating a console.
- Console
Name string - The name of the console
- properties
Console
Create Properties - Cloud shell properties for creating a console.
- console
Name String - The name of the console
- properties
Console
Create Properties - Cloud shell properties for creating a console.
- console
Name string - The name of the console
- properties
Console
Create Properties Args - Cloud shell properties for creating a console.
- console_
name str - The name of the console
- properties Property Map
- Cloud shell properties for creating a console.
- console
Name 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
- Os
Type string | Pulumi.Azure Native. Portal. Os Type - The operating system type of the cloud shell.
- Provisioning
State string | Pulumi.Azure Native. Portal. Provisioning State - Provisioning state of the console.
- Uri string
- Uri of the console.
- Os
Type string | OsType - The operating system type of the cloud shell.
- Provisioning
State string | ProvisioningState - Provisioning state of the console.
- Uri string
- Uri of the console.
- os
Type String | OsType - The operating system type of the cloud shell.
- provisioning
State String | ProvisioningState - Provisioning state of the console.
- uri String
- Uri of the console.
- os
Type string | OsType - The operating system type of the cloud shell.
- provisioning
State string | ProvisioningState - Provisioning state of the console.
- uri string
- Uri of the console.
- os_
type 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.
- os
Type String | "Windows" | "Linux" - The operating system type of the cloud shell.
- provisioning
State String | "NotSpecified" | "Accepted" | "Pending" | "Updating" | "Creating" | "Repairing" | "Failed" | "Canceled" | "Succeeded" - Provisioning state of the console.
- uri String
- Uri of the console.
ConsolePropertiesResponse, ConsolePropertiesResponseArgs
- Os
Type string - The operating system type of the cloud shell.
- Provisioning
State string - Provisioning state of the console.
- Uri string
- Uri of the console.
- Os
Type string - The operating system type of the cloud shell.
- Provisioning
State string - Provisioning state of the console.
- Uri string
- Uri of the console.
- os
Type String - The operating system type of the cloud shell.
- provisioning
State String - Provisioning state of the console.
- uri String
- Uri of the console.
- os
Type string - The operating system type of the cloud shell.
- provisioning
State string - Provisioning state of the console.
- uri string
- Uri of the console.
- os_
type str - The operating system type of the cloud shell.
- provisioning_
state str - Provisioning state of the console.
- uri str
- Uri of the console.
- os
Type String - The operating system type of the cloud shell.
- provisioning
State String - Provisioning state of the console.
- uri String
- Uri of the console.
OsType, OsTypeArgs
- Windows
- Windows
- Linux
- Linux
- Os
Type Windows - Windows
- Os
Type Linux - Linux
- Windows
- Windows
- Linux
- Linux
- Windows
- Windows
- Linux
- Linux
- WINDOWS
- Windows
- LINUX
- Linux
- "Windows"
- Windows
- "Linux"
- Linux
ProvisioningState, ProvisioningStateArgs
- Not
Specified - NotSpecified
- Accepted
- Accepted
- Pending
- Pending
- Updating
- Updating
- Creating
- Creating
- Repairing
- Repairing
- Failed
- Failed
- Canceled
- Canceled
- Succeeded
- Succeeded
- Provisioning
State Not Specified - NotSpecified
- Provisioning
State Accepted - Accepted
- Provisioning
State Pending - Pending
- Provisioning
State Updating - Updating
- Provisioning
State Creating - Creating
- Provisioning
State Repairing - Repairing
- Provisioning
State Failed - Failed
- Provisioning
State Canceled - Canceled
- Provisioning
State Succeeded - Succeeded
- Not
Specified - 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
- NOT_SPECIFIED
- 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
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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0