ovh.CloudProject.getGatewayInterface

OVHCloud v2.12.0, Mar 12 26

Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const _interface = ovh.CloudProject.getGatewayInterface({
    serviceName: "XXXXXX",
    region: "GRA11",
    id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
    interfaceId: "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy",
});

import pulumi
import pulumi_ovh as ovh

interface = ovh.CloudProject.get_gateway_interface(service_name="XXXXXX",
    region="GRA11",
    id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
    interface_id="yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy")

package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh/cloudproject"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudproject.GetGatewayInterface(ctx, &cloudproject.GetGatewayInterfaceArgs{
			ServiceName: "XXXXXX",
			Region:      "GRA11",
			Id:          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
			InterfaceId: "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @interface = Ovh.CloudProject.GetGatewayInterface.Invoke(new()
    {
        ServiceName = "XXXXXX",
        Region = "GRA11",
        Id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        InterfaceId = "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.CloudProject.CloudProjectFunctions;
import com.pulumi.ovh.CloudProject.inputs.GetGatewayInterfaceArgs;
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) {
        final var interface = CloudProjectFunctions.getGatewayInterface(GetGatewayInterfaceArgs.builder()
            .serviceName("XXXXXX")
            .region("GRA11")
            .id("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx")
            .interfaceId("yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy")
            .build());

    }
}

variables:
  interface:
    fn::invoke:
      function: ovh:CloudProject:getGatewayInterface
      arguments:
        serviceName: XXXXXX
        region: GRA11
        id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
        interfaceId: yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy

Using getGatewayInterface

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 getGatewayInterface(args: GetGatewayInterfaceArgs, opts?: InvokeOptions): Promise<GetGatewayInterfaceResult>
function getGatewayInterfaceOutput(args: GetGatewayInterfaceOutputArgs, opts?: InvokeOptions): Output<GetGatewayInterfaceResult>

def get_gateway_interface(id: Optional[str] = None,
                          interface_id: Optional[str] = None,
                          region: Optional[str] = None,
                          service_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetGatewayInterfaceResult
def get_gateway_interface_output(id: Optional[pulumi.Input[str]] = None,
                          interface_id: Optional[pulumi.Input[str]] = None,
                          region: Optional[pulumi.Input[str]] = None,
                          service_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetGatewayInterfaceResult]

func LookupGatewayInterface(ctx *Context, args *LookupGatewayInterfaceArgs, opts ...InvokeOption) (*LookupGatewayInterfaceResult, error)
func LookupGatewayInterfaceOutput(ctx *Context, args *LookupGatewayInterfaceOutputArgs, opts ...InvokeOption) LookupGatewayInterfaceResultOutput

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

public static class GetGatewayInterface 
{
    public static Task<GetGatewayInterfaceResult> InvokeAsync(GetGatewayInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayInterfaceResult> Invoke(GetGatewayInterfaceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayInterfaceResult> getGatewayInterface(GetGatewayInterfaceArgs args, InvokeOptions options)
public static Output<GetGatewayInterfaceResult> getGatewayInterface(GetGatewayInterfaceArgs args, InvokeOptions options)

fn::invoke:
  function: ovh:CloudProject/getGatewayInterface:getGatewayInterface
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: ID of the gateway
InterfaceId string: ID of the interface
Region string: Region of the gateway
ServiceName string: ID of the cloud project

Id string: ID of the gateway
InterfaceId string: ID of the interface
Region string: Region of the gateway
ServiceName string: ID of the cloud project

id String: ID of the gateway
interfaceId String: ID of the interface
region String: Region of the gateway
serviceName String: ID of the cloud project

id string: ID of the gateway
interfaceId string: ID of the interface
region string: Region of the gateway
serviceName string: ID of the cloud project

id str: ID of the gateway
interface_id str: ID of the interface
region str: Region of the gateway
service_name str: ID of the cloud project

id String: ID of the gateway
interfaceId String: ID of the interface
region String: Region of the gateway
serviceName String: ID of the cloud project

getGatewayInterface Result

The following output properties are available:

Id string: ID of the gateway
InterfaceId string: ID of the interface
Ip string: IP of the interface
NetworkId string: Network ID of the interface
Region string: Region of the gateway
ServiceName string: ID of the cloud project
SubnetId string: ID of the subnet to add

Id string: ID of the gateway
InterfaceId string: ID of the interface
Ip string: IP of the interface
NetworkId string: Network ID of the interface
Region string: Region of the gateway
ServiceName string: ID of the cloud project
SubnetId string: ID of the subnet to add

id String: ID of the gateway
interfaceId String: ID of the interface
ip String: IP of the interface
networkId String: Network ID of the interface
region String: Region of the gateway
serviceName String: ID of the cloud project
subnetId String: ID of the subnet to add

id string: ID of the gateway
interfaceId string: ID of the interface
ip string: IP of the interface
networkId string: Network ID of the interface
region string: Region of the gateway
serviceName string: ID of the cloud project
subnetId string: ID of the subnet to add

id str: ID of the gateway
interface_id str: ID of the interface
ip str: IP of the interface
network_id str: Network ID of the interface
region str: Region of the gateway
service_name str: ID of the cloud project
subnet_id str: ID of the subnet to add

id String: ID of the gateway
interfaceId String: ID of the interface
ip String: IP of the interface
networkId String: Network ID of the interface
region String: Region of the gateway
serviceName String: ID of the cloud project
subnetId String: ID of the subnet to add

Package Details

Repository: ovh ovh/pulumi-ovh
License: Apache-2.0
Notes: This Pulumi package is based on the ovh Terraform Provider.

Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

ovh.CloudProject.getGatewayInterface

On this page

On this page

Example Usage

Using getGatewayInterface

getGatewayInterface Result

Package Details

On this page

On this page