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

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

Gets the console for the user. Azure REST API version: 2018-10-01.

Using getConsoleWithLocation

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConsoleWithLocation(args: GetConsoleWithLocationArgs, opts?: InvokeOptions): Promise<GetConsoleWithLocationResult>
function getConsoleWithLocationOutput(args: GetConsoleWithLocationOutputArgs, opts?: InvokeOptions): Output<GetConsoleWithLocationResult>
Copy
def get_console_with_location(console_name: Optional[str] = None,
                              location: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetConsoleWithLocationResult
def get_console_with_location_output(console_name: Optional[pulumi.Input[str]] = None,
                              location: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetConsoleWithLocationResult]
Copy
func LookupConsoleWithLocation(ctx *Context, args *LookupConsoleWithLocationArgs, opts ...InvokeOption) (*LookupConsoleWithLocationResult, error)
func LookupConsoleWithLocationOutput(ctx *Context, args *LookupConsoleWithLocationOutputArgs, opts ...InvokeOption) LookupConsoleWithLocationResultOutput
Copy

> Note: This function is named LookupConsoleWithLocation in the Go SDK.

public static class GetConsoleWithLocation 
{
    public static Task<GetConsoleWithLocationResult> InvokeAsync(GetConsoleWithLocationArgs args, InvokeOptions? opts = null)
    public static Output<GetConsoleWithLocationResult> Invoke(GetConsoleWithLocationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConsoleWithLocationResult> getConsoleWithLocation(GetConsoleWithLocationArgs args, InvokeOptions options)
public static Output<GetConsoleWithLocationResult> getConsoleWithLocation(GetConsoleWithLocationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:portal:getConsoleWithLocation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConsoleName
This property is required.
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
This property is required.
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
This property is required.
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
This property is required.
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
console_name
This property is required.
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.
str
The provider location
consoleName
This property is required.
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

getConsoleWithLocation Result

The following output properties are available:

Properties ConsolePropertiesResponse
Cloud shell console properties.
properties ConsolePropertiesResponse
Cloud shell console properties.
properties ConsolePropertiesResponse
Cloud shell console properties.
properties ConsolePropertiesResponse
Cloud shell console properties.
properties Property Map
Cloud shell console properties.

Supporting Types

ConsolePropertiesResponse

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.

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