1. Packages
  2. Azure Native
  3. API Docs
  4. serialconsole
  5. getSerialPort
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

azure-native.serialconsole.getSerialPort

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

    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>
    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]
    func LookupSerialPort(ctx *Context, args *LookupSerialPortArgs, opts ...InvokeOption) (*LookupSerialPortResult, error)
    func LookupSerialPortOutput(ctx *Context, args *LookupSerialPortOutputArgs, opts ...InvokeOption) LookupSerialPortResultOutput

    > 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)
    }
    public static CompletableFuture<GetSerialPortResult> getSerialPort(GetSerialPortArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:serialconsole:getSerialPort
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ParentResource string
    The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
    ParentResourceType string
    The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
    ResourceGroupName string
    The name of the resource group.
    ResourceProviderNamespace string
    The namespace of the resource provider.
    SerialPort string
    The name of the serial port to connect to.
    ParentResource string
    The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
    ParentResourceType string
    The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
    ResourceGroupName string
    The name of the resource group.
    ResourceProviderNamespace string
    The namespace of the resource provider.
    SerialPort string
    The name of the serial port to connect to.
    parentResource String
    The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
    parentResourceType String
    The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
    resourceGroupName String
    The name of the resource group.
    resourceProviderNamespace String
    The namespace of the resource provider.
    serialPort String
    The name of the serial port to connect to.
    parentResource string
    The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
    parentResourceType string
    The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
    resourceGroupName string
    The name of the resource group.
    resourceProviderNamespace string
    The namespace of the resource provider.
    serialPort string
    The name of the serial port to connect to.
    parent_resource 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 str
    The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
    resource_group_name str
    The name of the resource group.
    resource_provider_namespace str
    The namespace of the resource provider.
    serial_port str
    The name of the serial port to connect to.
    parentResource String
    The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine.
    parentResourceType String
    The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets'
    resourceGroupName String
    The name of the resource group.
    resourceProviderNamespace String
    The namespace of the resource provider.
    serialPort 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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi