1. Packages
  2. Outscale Provider
  3. API Docs
  4. getNetPeering
outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale

outscale.getNetPeering

Explore with Pulumi AI

Provides information about a Net peering.

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 netPeering01 = outscale.getNetPeering({
    filters: [{
        name: "net_peering_ids",
        values: ["pcx-12345678"],
    }],
});
Copy
import pulumi
import pulumi_outscale as outscale

net_peering01 = outscale.get_net_peering(filters=[{
    "name": "net_peering_ids",
    "values": ["pcx-12345678"],
}])
Copy
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.LookupNetPeering(ctx, &outscale.LookupNetPeeringArgs{
			Filters: []outscale.GetNetPeeringFilter{
				{
					Name: "net_peering_ids",
					Values: []string{
						"pcx-12345678",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;

return await Deployment.RunAsync(() => 
{
    var netPeering01 = Outscale.GetNetPeering.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetNetPeeringFilterInputArgs
            {
                Name = "net_peering_ids",
                Values = new[]
                {
                    "pcx-12345678",
                },
            },
        },
    });

});
Copy
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.GetNetPeeringArgs;
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 netPeering01 = OutscaleFunctions.getNetPeering(GetNetPeeringArgs.builder()
            .filters(GetNetPeeringFilterArgs.builder()
                .name("net_peering_ids")
                .values("pcx-12345678")
                .build())
            .build());

    }
}
Copy
variables:
  netPeering01:
    fn::invoke:
      function: outscale:getNetPeering
      arguments:
        filters:
          - name: net_peering_ids
            values:
              - pcx-12345678
Copy

Using getNetPeering

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 getNetPeering(args: GetNetPeeringArgs, opts?: InvokeOptions): Promise<GetNetPeeringResult>
function getNetPeeringOutput(args: GetNetPeeringOutputArgs, opts?: InvokeOptions): Output<GetNetPeeringResult>
Copy
def get_net_peering(filters: Optional[Sequence[GetNetPeeringFilter]] = None,
                    id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNetPeeringResult
def get_net_peering_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetNetPeeringFilterArgs]]]] = None,
                    id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetNetPeeringResult]
Copy
func LookupNetPeering(ctx *Context, args *LookupNetPeeringArgs, opts ...InvokeOption) (*LookupNetPeeringResult, error)
func LookupNetPeeringOutput(ctx *Context, args *LookupNetPeeringOutputArgs, opts ...InvokeOption) LookupNetPeeringResultOutput
Copy

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

public static class GetNetPeering 
{
    public static Task<GetNetPeeringResult> InvokeAsync(GetNetPeeringArgs args, InvokeOptions? opts = null)
    public static Output<GetNetPeeringResult> Invoke(GetNetPeeringInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNetPeeringResult> getNetPeering(GetNetPeeringArgs args, InvokeOptions options)
public static Output<GetNetPeeringResult> getNetPeering(GetNetPeeringArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: outscale:index/getNetPeering:getNetPeering
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Filters List<GetNetPeeringFilter>
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
Filters []GetNetPeeringFilter
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
filters List<GetNetPeeringFilter>
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
filters GetNetPeeringFilter[]
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
filters Sequence[GetNetPeeringFilter]
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
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

getNetPeering Result

The following output properties are available:

AccepterNets List<GetNetPeeringAccepterNet>
Information about the accepter Net.
Id string
NetPeeringId string
The ID of the Net peering.
RequestId string
SourceNets List<GetNetPeeringSourceNet>
Information about the source Net.
States List<GetNetPeeringState>
Information about the state of the Net peering.
Tags List<GetNetPeeringTag>
One or more tags associated with the Net peering.
Filters List<GetNetPeeringFilter>
AccepterNets []GetNetPeeringAccepterNet
Information about the accepter Net.
Id string
NetPeeringId string
The ID of the Net peering.
RequestId string
SourceNets []GetNetPeeringSourceNet
Information about the source Net.
States []GetNetPeeringState
Information about the state of the Net peering.
Tags []GetNetPeeringTag
One or more tags associated with the Net peering.
Filters []GetNetPeeringFilter
accepterNets List<GetNetPeeringAccepterNet>
Information about the accepter Net.
id String
netPeeringId String
The ID of the Net peering.
requestId String
sourceNets List<GetNetPeeringSourceNet>
Information about the source Net.
states List<GetNetPeeringState>
Information about the state of the Net peering.
tags List<GetNetPeeringTag>
One or more tags associated with the Net peering.
filters List<GetNetPeeringFilter>
accepterNets GetNetPeeringAccepterNet[]
Information about the accepter Net.
id string
netPeeringId string
The ID of the Net peering.
requestId string
sourceNets GetNetPeeringSourceNet[]
Information about the source Net.
states GetNetPeeringState[]
Information about the state of the Net peering.
tags GetNetPeeringTag[]
One or more tags associated with the Net peering.
filters GetNetPeeringFilter[]
accepter_nets Sequence[GetNetPeeringAccepterNet]
Information about the accepter Net.
id str
net_peering_id str
The ID of the Net peering.
request_id str
source_nets Sequence[GetNetPeeringSourceNet]
Information about the source Net.
states Sequence[GetNetPeeringState]
Information about the state of the Net peering.
tags Sequence[GetNetPeeringTag]
One or more tags associated with the Net peering.
filters Sequence[GetNetPeeringFilter]
accepterNets List<Property Map>
Information about the accepter Net.
id String
netPeeringId String
The ID of the Net peering.
requestId String
sourceNets List<Property Map>
Information about the source Net.
states List<Property Map>
Information about the state of the Net peering.
tags List<Property Map>
One or more tags associated with the Net peering.
filters List<Property Map>

Supporting Types

GetNetPeeringAccepterNet

AccountId This property is required. string
The account ID of the owner of the source Net.
IpRange This property is required. string
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
NetId This property is required. string
The ID of the source Net.
AccountId This property is required. string
The account ID of the owner of the source Net.
IpRange This property is required. string
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
NetId This property is required. string
The ID of the source Net.
accountId This property is required. String
The account ID of the owner of the source Net.
ipRange This property is required. String
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
netId This property is required. String
The ID of the source Net.
accountId This property is required. string
The account ID of the owner of the source Net.
ipRange This property is required. string
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
netId This property is required. string
The ID of the source Net.
account_id This property is required. str
The account ID of the owner of the source Net.
ip_range This property is required. str
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
net_id This property is required. str
The ID of the source Net.
accountId This property is required. String
The account ID of the owner of the source Net.
ipRange This property is required. String
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
netId This property is required. String
The ID of the source Net.

GetNetPeeringFilter

Name This property is required. string
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).
Values This property is required. List<string>
Name This property is required. string
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).
Values This property is required. []string
name This property is required. String
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).
values This property is required. List<String>
name This property is required. string
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).
values This property is required. string[]
name This property is required. str
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).
values This property is required. Sequence[str]
name This property is required. String
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).
values This property is required. List<String>

GetNetPeeringSourceNet

AccountId This property is required. string
The account ID of the owner of the source Net.
IpRange This property is required. string
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
NetId This property is required. string
The ID of the source Net.
AccountId This property is required. string
The account ID of the owner of the source Net.
IpRange This property is required. string
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
NetId This property is required. string
The ID of the source Net.
accountId This property is required. String
The account ID of the owner of the source Net.
ipRange This property is required. String
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
netId This property is required. String
The ID of the source Net.
accountId This property is required. string
The account ID of the owner of the source Net.
ipRange This property is required. string
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
netId This property is required. string
The ID of the source Net.
account_id This property is required. str
The account ID of the owner of the source Net.
ip_range This property is required. str
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
net_id This property is required. str
The ID of the source Net.
accountId This property is required. String
The account ID of the owner of the source Net.
ipRange This property is required. String
The IP range for the source Net, in CIDR notation (for example, 10.0.0.0/16).
netId This property is required. String
The ID of the source Net.

GetNetPeeringState

Message This property is required. string
Additional information about the state of the Net peering.
Name This property is required. string
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).
Message This property is required. string
Additional information about the state of the Net peering.
Name This property is required. string
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).
message This property is required. String
Additional information about the state of the Net peering.
name This property is required. String
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).
message This property is required. string
Additional information about the state of the Net peering.
name This property is required. string
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).
message This property is required. str
Additional information about the state of the Net peering.
name This property is required. str
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).
message This property is required. String
Additional information about the state of the Net peering.
name This property is required. String
The state of the Net peering (pending-acceptance | active | rejected | failed | expired | deleted).

GetNetPeeringTag

Key This property is required. string
The key of the tag, with a minimum of 1 character.
Value This property is required. string
The value of the tag, between 0 and 255 characters.
Key This property is required. string
The key of the tag, with a minimum of 1 character.
Value This property is required. string
The value of the tag, between 0 and 255 characters.
key This property is required. String
The key of the tag, with a minimum of 1 character.
value This property is required. String
The value of the tag, between 0 and 255 characters.
key This property is required. string
The key of the tag, with a minimum of 1 character.
value This property is required. string
The value of the tag, between 0 and 255 characters.
key This property is required. str
The key of the tag, with a minimum of 1 character.
value This property is required. str
The value of the tag, between 0 and 255 characters.
key This property is required. String
The key of the tag, with a minimum of 1 character.
value This property is required. String
The value of the tag, between 0 and 255 characters.

Package Details

Repository
outscale outscale/terraform-provider-outscale
License
Notes
This Pulumi package is based on the outscale Terraform Provider.