outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale.getVirtualGateways
Explore with Pulumi AI
Provides information about virtual gateways.
For more information on this resource, see the User Guide.
For more information on this resource actions, see the API documentation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as outscale from "@pulumi/outscale";
const virtualGateways01 = outscale.getVirtualGateways({
    filters: [
        {
            name: "states",
            values: ["available"],
        },
        {
            name: "link_states",
            values: [
                "attached",
                "detached",
            ],
        },
    ],
});
import pulumi
import pulumi_outscale as outscale
virtual_gateways01 = outscale.get_virtual_gateways(filters=[
    {
        "name": "states",
        "values": ["available"],
    },
    {
        "name": "link_states",
        "values": [
            "attached",
            "detached",
        ],
    },
])
package main
import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.GetVirtualGateways(ctx, &outscale.GetVirtualGatewaysArgs{
			Filters: []outscale.GetVirtualGatewaysFilter{
				{
					Name: "states",
					Values: []string{
						"available",
					},
				},
				{
					Name: "link_states",
					Values: []string{
						"attached",
						"detached",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;
return await Deployment.RunAsync(() => 
{
    var virtualGateways01 = Outscale.GetVirtualGateways.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetVirtualGatewaysFilterInputArgs
            {
                Name = "states",
                Values = new[]
                {
                    "available",
                },
            },
            new Outscale.Inputs.GetVirtualGatewaysFilterInputArgs
            {
                Name = "link_states",
                Values = new[]
                {
                    "attached",
                    "detached",
                },
            },
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.OutscaleFunctions;
import com.pulumi.outscale.inputs.GetVirtualGatewaysArgs;
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 virtualGateways01 = OutscaleFunctions.getVirtualGateways(GetVirtualGatewaysArgs.builder()
            .filters(            
                GetVirtualGatewaysFilterArgs.builder()
                    .name("states")
                    .values("available")
                    .build(),
                GetVirtualGatewaysFilterArgs.builder()
                    .name("link_states")
                    .values(                    
                        "attached",
                        "detached")
                    .build())
            .build());
    }
}
variables:
  virtualGateways01:
    fn::invoke:
      function: outscale:getVirtualGateways
      arguments:
        filters:
          - name: states
            values:
              - available
          - name: link_states
            values:
              - attached
              - detached
Using getVirtualGateways
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 getVirtualGateways(args: GetVirtualGatewaysArgs, opts?: InvokeOptions): Promise<GetVirtualGatewaysResult>
function getVirtualGatewaysOutput(args: GetVirtualGatewaysOutputArgs, opts?: InvokeOptions): Output<GetVirtualGatewaysResult>def get_virtual_gateways(filters: Optional[Sequence[GetVirtualGatewaysFilter]] = None,
                         id: Optional[str] = None,
                         virtual_gateway_ids: Optional[Sequence[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> GetVirtualGatewaysResult
def get_virtual_gateways_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVirtualGatewaysFilterArgs]]]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         virtual_gateway_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetVirtualGatewaysResult]func GetVirtualGateways(ctx *Context, args *GetVirtualGatewaysArgs, opts ...InvokeOption) (*GetVirtualGatewaysResult, error)
func GetVirtualGatewaysOutput(ctx *Context, args *GetVirtualGatewaysOutputArgs, opts ...InvokeOption) GetVirtualGatewaysResultOutput> Note: This function is named GetVirtualGateways in the Go SDK.
public static class GetVirtualGateways 
{
    public static Task<GetVirtualGatewaysResult> InvokeAsync(GetVirtualGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualGatewaysResult> Invoke(GetVirtualGatewaysInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetVirtualGatewaysResult> getVirtualGateways(GetVirtualGatewaysArgs args, InvokeOptions options)
public static Output<GetVirtualGatewaysResult> getVirtualGateways(GetVirtualGatewaysArgs args, InvokeOptions options)
fn::invoke:
  function: outscale:index/getVirtualGateways:getVirtualGateways
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Filters
List<GetVirtual Gateways Filter> 
- A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- Id string
- VirtualGateway List<string>Ids 
- The ID of the virtual gateway.
- Filters
[]GetVirtual Gateways Filter 
- A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- Id string
- VirtualGateway []stringIds 
- The ID of the virtual gateway.
- filters
List<GetVirtual Gateways Filter> 
- A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- id String
- virtualGateway List<String>Ids 
- The ID of the virtual gateway.
- filters
GetVirtual Gateways Filter[] 
- A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- id string
- virtualGateway string[]Ids 
- The ID of the virtual gateway.
- filters
Sequence[GetVirtual Gateways Filter] 
- A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- id str
- virtual_gateway_ Sequence[str]ids 
- The ID of the virtual gateway.
- filters List<Property Map>
- A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
- id String
- virtualGateway List<String>Ids 
- The ID of the virtual gateway.
getVirtualGateways Result
The following output properties are available:
- Id string
- RequestId string
- VirtualGateway List<string>Ids 
- The ID of the virtual gateway.
- VirtualGateways List<GetVirtual Gateways Virtual Gateway> 
- Information about one or more virtual gateways.
- Filters
List<GetVirtual Gateways Filter> 
- Id string
- RequestId string
- VirtualGateway []stringIds 
- The ID of the virtual gateway.
- VirtualGateways []GetVirtual Gateways Virtual Gateway 
- Information about one or more virtual gateways.
- Filters
[]GetVirtual Gateways Filter 
- id String
- requestId String
- virtualGateway List<String>Ids 
- The ID of the virtual gateway.
- virtualGateways List<GetVirtual Gateways Virtual Gateway> 
- Information about one or more virtual gateways.
- filters
List<GetVirtual Gateways Filter> 
- id string
- requestId string
- virtualGateway string[]Ids 
- The ID of the virtual gateway.
- virtualGateways GetVirtual Gateways Virtual Gateway[] 
- Information about one or more virtual gateways.
- filters
GetVirtual Gateways Filter[] 
- id str
- request_id str
- virtual_gateway_ Sequence[str]ids 
- The ID of the virtual gateway.
- virtual_gateways Sequence[GetVirtual Gateways Virtual Gateway] 
- Information about one or more virtual gateways.
- filters
Sequence[GetVirtual Gateways Filter] 
- id String
- requestId String
- virtualGateway List<String>Ids 
- The ID of the virtual gateway.
- virtualGateways List<Property Map>
- Information about one or more virtual gateways.
- filters List<Property Map>
Supporting Types
GetVirtualGatewaysFilter   
GetVirtualGatewaysVirtualGateway    
- ConnectionType string
- The type of VPN connection supported by the virtual gateway (always ipsec.1).
- NetTo List<GetVirtual Gateway Links Virtual Gateways Virtual Gateway Net To Virtual Gateway Link> 
- The Net to which the virtual gateway is attached.
- State string
- The state of the virtual gateway (pending|available|deleting|deleted).
- 
List<GetVirtual Gateways Virtual Gateway Tag> 
- One or more tags associated with the virtual gateway.
- VirtualGateway stringId 
- The ID of the virtual gateway.
- ConnectionType string
- The type of VPN connection supported by the virtual gateway (always ipsec.1).
- NetTo []GetVirtual Gateway Links Virtual Gateways Virtual Gateway Net To Virtual Gateway Link 
- The Net to which the virtual gateway is attached.
- State string
- The state of the virtual gateway (pending|available|deleting|deleted).
- 
[]GetVirtual Gateways Virtual Gateway Tag 
- One or more tags associated with the virtual gateway.
- VirtualGateway stringId 
- The ID of the virtual gateway.
- connectionType String
- The type of VPN connection supported by the virtual gateway (always ipsec.1).
- netTo List<GetVirtual Gateway Links Virtual Gateways Virtual Gateway Net To Virtual Gateway Link> 
- The Net to which the virtual gateway is attached.
- state String
- The state of the virtual gateway (pending|available|deleting|deleted).
- 
List<GetVirtual Gateways Virtual Gateway Tag> 
- One or more tags associated with the virtual gateway.
- virtualGateway StringId 
- The ID of the virtual gateway.
- connectionType string
- The type of VPN connection supported by the virtual gateway (always ipsec.1).
- netTo GetVirtual Gateway Links Virtual Gateways Virtual Gateway Net To Virtual Gateway Link[] 
- The Net to which the virtual gateway is attached.
- state string
- The state of the virtual gateway (pending|available|deleting|deleted).
- 
GetVirtual Gateways Virtual Gateway Tag[] 
- One or more tags associated with the virtual gateway.
- virtualGateway stringId 
- The ID of the virtual gateway.
- connection_type str
- The type of VPN connection supported by the virtual gateway (always ipsec.1).
- net_to_ Sequence[Getvirtual_ gateway_ links Virtual Gateways Virtual Gateway Net To Virtual Gateway Link] 
- The Net to which the virtual gateway is attached.
- state str
- The state of the virtual gateway (pending|available|deleting|deleted).
- 
Sequence[GetVirtual Gateways Virtual Gateway Tag] 
- One or more tags associated with the virtual gateway.
- virtual_gateway_ strid 
- The ID of the virtual gateway.
- connectionType String
- The type of VPN connection supported by the virtual gateway (always ipsec.1).
- netTo List<Property Map>Virtual Gateway Links 
- The Net to which the virtual gateway is attached.
- state String
- The state of the virtual gateway (pending|available|deleting|deleted).
- List<Property Map>
- One or more tags associated with the virtual gateway.
- virtualGateway StringId 
- The ID of the virtual gateway.
GetVirtualGatewaysVirtualGatewayNetToVirtualGatewayLink         
GetVirtualGatewaysVirtualGatewayTag     
Package Details
- Repository
- outscale outscale/terraform-provider-outscale
- License
- Notes
- This Pulumi package is based on the outscaleTerraform Provider.