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

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 configured settings for a serial port Azure REST API version: 2018-05-01.

Using getSerialPort

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 getSerialPort(args: GetSerialPortArgs, opts?: InvokeOptions): Promise<GetSerialPortResult>
function getSerialPortOutput(args: GetSerialPortOutputArgs, opts?: InvokeOptions): Output<GetSerialPortResult>
Copy
def get_serial_port(parent_resource: Optional[str] = None,
                    parent_resource_type: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    resource_provider_namespace: Optional[str] = None,
                    serial_port: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetSerialPortResult
def get_serial_port_output(parent_resource: Optional[pulumi.Input[str]] = None,
                    parent_resource_type: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    resource_provider_namespace: Optional[pulumi.Input[str]] = None,
                    serial_port: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetSerialPortResult]
Copy
func LookupSerialPort(ctx *Context, args *LookupSerialPortArgs, opts ...InvokeOption) (*LookupSerialPortResult, error)
func LookupSerialPortOutput(ctx *Context, args *LookupSerialPortOutputArgs, opts ...InvokeOption) LookupSerialPortResultOutput
Copy

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

public static class GetSerialPort 
{
    public static Task<GetSerialPortResult> InvokeAsync(GetSerialPortArgs args, InvokeOptions? opts = null)
    public static Output<GetSerialPortResult> Invoke(GetSerialPortInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSerialPortResult> getSerialPort(GetSerialPortArgs args, InvokeOptions options)
public static Output<GetSerialPortResult> getSerialPort(GetSerialPortArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:serialconsole:getSerialPort
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ParentResource
This property is required.
Changes to this property will trigger replacement.
string
The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
ParentResourceType
This property is required.
Changes to this property will trigger replacement.
string
The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ResourceProviderNamespace
This property is required.
Changes to this property will trigger replacement.
string
The namespace of the resource provider.
SerialPort
This property is required.
Changes to this property will trigger replacement.
string
The name of the serial port to connect to.
ParentResource
This property is required.
Changes to this property will trigger replacement.
string
The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
ParentResourceType
This property is required.
Changes to this property will trigger replacement.
string
The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ResourceProviderNamespace
This property is required.
Changes to this property will trigger replacement.
string
The namespace of the resource provider.
SerialPort
This property is required.
Changes to this property will trigger replacement.
string
The name of the serial port to connect to.
parentResource
This property is required.
Changes to this property will trigger replacement.
String
The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
parentResourceType
This property is required.
Changes to this property will trigger replacement.
String
The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
resourceProviderNamespace
This property is required.
Changes to this property will trigger replacement.
String
The namespace of the resource provider.
serialPort
This property is required.
Changes to this property will trigger replacement.
String
The name of the serial port to connect to.
parentResource
This property is required.
Changes to this property will trigger replacement.
string
The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
parentResourceType
This property is required.
Changes to this property will trigger replacement.
string
The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
resourceProviderNamespace
This property is required.
Changes to this property will trigger replacement.
string
The namespace of the resource provider.
serialPort
This property is required.
Changes to this property will trigger replacement.
string
The name of the serial port to connect to.
parent_resource
This property is required.
Changes to this property will trigger replacement.
str
The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
parent_resource_type
This property is required.
Changes to this property will trigger replacement.
str
The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
resource_provider_namespace
This property is required.
Changes to this property will trigger replacement.
str
The namespace of the resource provider.
serial_port
This property is required.
Changes to this property will trigger replacement.
str
The name of the serial port to connect to.
parentResource
This property is required.
Changes to this property will trigger replacement.
String
The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
parentResourceType
This property is required.
Changes to this property will trigger replacement.
String
The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
resourceProviderNamespace
This property is required.
Changes to this property will trigger replacement.
String
The namespace of the resource provider.
serialPort
This property is required.
Changes to this property will trigger replacement.
String
The name of the serial port to connect to.

getSerialPort Result

The following output properties are available:

Id string
Resource Id
Name string
Resource name
Type string
Resource type
State string
Specifies whether the port is enabled for a serial console connection.
Id string
Resource Id
Name string
Resource name
Type string
Resource type
State string
Specifies whether the port is enabled for a serial console connection.
id String
Resource Id
name String
Resource name
type String
Resource type
state String
Specifies whether the port is enabled for a serial console connection.
id string
Resource Id
name string
Resource name
type string
Resource type
state string
Specifies whether the port is enabled for a serial console connection.
id str
Resource Id
name str
Resource name
type str
Resource type
state str
Specifies whether the port is enabled for a serial console connection.
id String
Resource Id
name String
Resource name
type String
Resource type
state String
Specifies whether the port is enabled for a serial console connection.

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