1. Packages
  2. OVH
  3. API Docs
  4. CloudProject
  5. getGatewayInterface
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud

ovh.CloudProject.getGatewayInterface

Explore with Pulumi AI

ovh logo
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud

    Use this datasource to get a public cloud project Gateway Interface.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@pulumi/ovh";
    
    const interface = ovh.CloudProject.getGatewayInterface({
        id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        interfaceId: "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy",
        region: "GRA11",
        serviceName: "XXXXXX",
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    interface = ovh.CloudProject.get_gateway_interface(id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        interface_id="yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy",
        region="GRA11",
        service_name="XXXXXX")
    
    package main
    
    import (
    	"github.com/ovh/pulumi-ovh/sdk/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{
    			Id:          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
    			InterfaceId: "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy",
    			Region:      "GRA11",
    			ServiceName: "XXXXXX",
    		}, 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()
        {
            Id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
            InterfaceId = "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy",
            Region = "GRA11",
            ServiceName = "XXXXXX",
        });
    
    });
    
    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()
                .id("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx")
                .interfaceId("yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy")
                .region("GRA11")
                .serviceName("XXXXXX")
                .build());
    
        }
    }
    
    variables:
      interface:
        fn::invoke:
          Function: ovh:CloudProject:getGatewayInterface
          Arguments:
            id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
            interfaceId: yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy
            region: GRA11
            serviceName: XXXXXX
    

    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 GetGatewayInterface(ctx *Context, args *GetGatewayInterfaceArgs, opts ...InvokeOption) (*GetGatewayInterfaceResult, error)
    func GetGatewayInterfaceOutput(ctx *Context, args *GetGatewayInterfaceOutputArgs, opts ...InvokeOption) GetGatewayInterfaceResultOutput

    > Note: This function is named GetGatewayInterface 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)
    // Output-based functions aren't available in Java yet
    
    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.
    ovh logo
    OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud