Docs Packages
  1. Packages
  2. Equinix Metal (Deprecated)
  3. API Docs
  4. getMetro

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal

equinix-metal.getMetro

Explore with Pulumi AI

equinix-metal logo

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal

    Provides an Equinix Metal metro datasource.

    Using getMetro

    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 getMetro(args: GetMetroArgs, opts?: InvokeOptions): Promise<GetMetroResult>
function getMetroOutput(args: GetMetroOutputArgs, opts?: InvokeOptions): Output<GetMetroResult>
    def get_metro(capacities: Optional[Sequence[GetMetroCapacity]] = None,
              code: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetMetroResult
def get_metro_output(capacities: Optional[pulumi.Input[Sequence[pulumi.Input[GetMetroCapacityArgs]]]] = None,
              code: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetMetroResult]
    func GetMetro(ctx *Context, args *GetMetroArgs, opts ...InvokeOption) (*GetMetroResult, error)
func GetMetroOutput(ctx *Context, args *GetMetroOutputArgs, opts ...InvokeOption) GetMetroResultOutput

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

    public static class GetMetro 
{
    public static Task<GetMetroResult> InvokeAsync(GetMetroArgs args, InvokeOptions? opts = null)
    public static Output<GetMetroResult> Invoke(GetMetroInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMetroResult> getMetro(GetMetroArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: equinix-metal:index/getMetro:getMetro
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Code string
    The metro code
    Capacities List<Pulumi.EquinixMetal.Inputs.GetMetroCapacity>
    (Optional) Ensure that queried metro has capacity for specified number of given plans
    Code string
    The metro code
    Capacities []GetMetroCapacity
    (Optional) Ensure that queried metro has capacity for specified number of given plans
    code String
    The metro code
    capacities List<GetMetroCapacity>
    (Optional) Ensure that queried metro has capacity for specified number of given plans
    code string
    The metro code
    capacities GetMetroCapacity[]
    (Optional) Ensure that queried metro has capacity for specified number of given plans
    code str
    The metro code
    capacities Sequence[GetMetroCapacity]
    (Optional) Ensure that queried metro has capacity for specified number of given plans
    code String
    The metro code
    capacities List<Property Map>
    (Optional) Ensure that queried metro has capacity for specified number of given plans

    getMetro Result

    The following output properties are available:

    Code string
    The code of the metro
    Country string
    The country of the metro
    Id string
    The ID of the metro
    Name string
    The name of the metro
    Capacities List<Pulumi.EquinixMetal.Outputs.GetMetroCapacity>
    (Optional) Ensure that queried metro has capacity for specified number of given plans
    Code string
    The code of the metro
    Country string
    The country of the metro
    Id string
    The ID of the metro
    Name string
    The name of the metro
    Capacities []GetMetroCapacity
    (Optional) Ensure that queried metro has capacity for specified number of given plans
    code String
    The code of the metro
    country String
    The country of the metro
    id String
    The ID of the metro
    name String
    The name of the metro
    capacities List<GetMetroCapacity>
    (Optional) Ensure that queried metro has capacity for specified number of given plans
    code string
    The code of the metro
    country string
    The country of the metro
    id string
    The ID of the metro
    name string
    The name of the metro
    capacities GetMetroCapacity[]
    (Optional) Ensure that queried metro has capacity for specified number of given plans
    code str
    The code of the metro
    country str
    The country of the metro
    id str
    The ID of the metro
    name str
    The name of the metro
    capacities Sequence[GetMetroCapacity]
    (Optional) Ensure that queried metro has capacity for specified number of given plans
    code String
    The code of the metro
    country String
    The country of the metro
    id String
    The ID of the metro
    name String
    The name of the metro
    capacities List<Property Map>
    (Optional) Ensure that queried metro has capacity for specified number of given plans

    Supporting Types

    GetMetroCapacity

    Plan string
    device plan to check
    Quantity int
    number of device to check
    Plan string
    device plan to check
    Quantity int
    number of device to check
    plan String
    device plan to check
    quantity Integer
    number of device to check
    plan string
    device plan to check
    quantity number
    number of device to check
    plan str
    device plan to check
    quantity int
    number of device to check
    plan String
    device plan to check
    quantity Number
    number of device to check

    Package Details

    Repository
    Equinix Metal pulumi/pulumi-equinix-metal
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the metal Terraform Provider.
    equinix-metal logo

    This package is deprecated. We recommend using the new Equinix package.

    Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
    pulumi/pulumi-equinix-metal