Equinix v0.21.0, Feb 28 25

Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix

equinix.metal.getPlans

Explore with Pulumi AI

Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix

Using getPlans

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.

TypeScript
Python
Go
C#
Java
YAML

function getPlans(args: GetPlansArgs, opts?: InvokeOptions): Promise<GetPlansResult>
function getPlansOutput(args: GetPlansOutputArgs, opts?: InvokeOptions): Output<GetPlansResult>

def get_plans(filters: Optional[Sequence[GetPlansFilter]] = None,
              sorts: Optional[Sequence[GetPlansSort]] = None,
              opts: Optional[InvokeOptions] = None) -> GetPlansResult
def get_plans_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetPlansFilterArgs]]]] = None,
              sorts: Optional[pulumi.Input[Sequence[pulumi.Input[GetPlansSortArgs]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetPlansResult]

func GetPlans(ctx *Context, args *GetPlansArgs, opts ...InvokeOption) (*GetPlansResult, error)
func GetPlansOutput(ctx *Context, args *GetPlansOutputArgs, opts ...InvokeOption) GetPlansResultOutput

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

public static class GetPlans 
{
    public static Task<GetPlansResult> InvokeAsync(GetPlansArgs args, InvokeOptions? opts = null)
    public static Output<GetPlansResult> Invoke(GetPlansInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPlansResult> getPlans(GetPlansArgs args, InvokeOptions options)
public static Output<GetPlansResult> getPlans(GetPlansArgs args, InvokeOptions options)

fn::invoke:
  function: equinix:metal/getPlans:getPlans
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetPlansFilter>: One or more attribute/values pairs to filter off of
Sorts List<GetPlansSort>: One or more attribute/direction pairs on which to sort results. If multiple sorts are provided, they will be applied in order

Filters []GetPlansFilter: One or more attribute/values pairs to filter off of
Sorts []GetPlansSort: One or more attribute/direction pairs on which to sort results. If multiple sorts are provided, they will be applied in order

filters List<GetPlansFilter>: One or more attribute/values pairs to filter off of
sorts List<GetPlansSort>: One or more attribute/direction pairs on which to sort results. If multiple sorts are provided, they will be applied in order

filters GetPlansFilter[]: One or more attribute/values pairs to filter off of
sorts GetPlansSort[]: One or more attribute/direction pairs on which to sort results. If multiple sorts are provided, they will be applied in order

filters Sequence[GetPlansFilter]: One or more attribute/values pairs to filter off of
sorts Sequence[GetPlansSort]: One or more attribute/direction pairs on which to sort results. If multiple sorts are provided, they will be applied in order

filters List<Property Map>: One or more attribute/values pairs to filter off of
sorts List<Property Map>: One or more attribute/direction pairs on which to sort results. If multiple sorts are provided, they will be applied in order

getPlans Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Plans List<GetPlansPlan>
Filters List<GetPlansFilter>
Sorts List<GetPlansSort>

Id string: The provider-assigned unique ID for this managed resource.
Plans []GetPlansPlan
Filters []GetPlansFilter
Sorts []GetPlansSort

id String: The provider-assigned unique ID for this managed resource.
plans List<GetPlansPlan>
filters List<GetPlansFilter>
sorts List<GetPlansSort>

id string: The provider-assigned unique ID for this managed resource.
plans GetPlansPlan[]
filters GetPlansFilter[]
sorts GetPlansSort[]

id str: The provider-assigned unique ID for this managed resource.
plans Sequence[GetPlansPlan]
filters Sequence[GetPlansFilter]
sorts Sequence[GetPlansSort]

id String: The provider-assigned unique ID for this managed resource.
plans List<Property Map>
filters List<Property Map>
sorts List<Property Map>

Supporting Types

GetPlansFilter

Attribute string

The attribute used to filter. Filter attributes are case-sensitive

Values List<string>

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR by default, and the request returns all results that match any of the specified values

All bool

If is set to true, the values are joined with an AND, and the requests returns only the results that match all specified values. Default is false.

All fields in the plans block defined below can be used as attribute for both sort and filter blocks.

MatchBy string

The type of comparison to apply. One of: in , re, substring, less_than, less_than_or_equal, greater_than, greater_than_or_equal. Default is in.

Attribute string

The attribute used to filter. Filter attributes are case-sensitive

Values []string

All bool

If is set to true, the values are joined with an AND, and the requests returns only the results that match all specified values. Default is false.

All fields in the plans block defined below can be used as attribute for both sort and filter blocks.

MatchBy string

The type of comparison to apply. One of: in , re, substring, less_than, less_than_or_equal, greater_than, greater_than_or_equal. Default is in.

attribute String

The attribute used to filter. Filter attributes are case-sensitive

values List<String>

all Boolean

If is set to true, the values are joined with an AND, and the requests returns only the results that match all specified values. Default is false.

All fields in the plans block defined below can be used as attribute for both sort and filter blocks.

matchBy String

The type of comparison to apply. One of: in , re, substring, less_than, less_than_or_equal, greater_than, greater_than_or_equal. Default is in.

attribute string

The attribute used to filter. Filter attributes are case-sensitive

values string[]

all boolean

If is set to true, the values are joined with an AND, and the requests returns only the results that match all specified values. Default is false.

All fields in the plans block defined below can be used as attribute for both sort and filter blocks.

matchBy string

The type of comparison to apply. One of: in , re, substring, less_than, less_than_or_equal, greater_than, greater_than_or_equal. Default is in.

attribute str

The attribute used to filter. Filter attributes are case-sensitive

values Sequence[str]

all bool

If is set to true, the values are joined with an AND, and the requests returns only the results that match all specified values. Default is false.

All fields in the plans block defined below can be used as attribute for both sort and filter blocks.

match_by str

The type of comparison to apply. One of: in , re, substring, less_than, less_than_or_equal, greater_than, greater_than_or_equal. Default is in.

attribute String

The attribute used to filter. Filter attributes are case-sensitive

values List<String>

all Boolean

If is set to true, the values are joined with an AND, and the requests returns only the results that match all specified values. Default is false.

All fields in the plans block defined below can be used as attribute for both sort and filter blocks.

matchBy String

The type of comparison to apply. One of: in , re, substring, less_than, less_than_or_equal, greater_than, greater_than_or_equal. Default is in.

GetPlansPlan

AvailableInMetros List<string>: list of metros where the plan is available
AvailableIns List<string>: (Deprecated) list of facilities where the plan is available
Deprecated: Use available_in_metros instead. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices
Class string: plan class
DeploymentTypes List<string>: list of deployment types, e.g. on_demand, spot_market
Description string: description of the plan
Id string: id of the plan
Legacy bool: flag showing if it's a legacy plan
Line string: plan line, e.g. baremetal
Name string: name of the plan
PricingHour double: plan hourly price
PricingMonth double: plan monthly price
Slug string: plan slug

AvailableInMetros []string: list of metros where the plan is available
AvailableIns []string: (Deprecated) list of facilities where the plan is available
Deprecated: Use available_in_metros instead. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices
Class string: plan class
DeploymentTypes []string: list of deployment types, e.g. on_demand, spot_market
Description string: description of the plan
Id string: id of the plan
Legacy bool: flag showing if it's a legacy plan
Line string: plan line, e.g. baremetal
Name string: name of the plan
PricingHour float64: plan hourly price
PricingMonth float64: plan monthly price
Slug string: plan slug

availableInMetros List<String>: list of metros where the plan is available
availableIns List<String>: (Deprecated) list of facilities where the plan is available
Deprecated: Use available_in_metros instead. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices
class_ String: plan class
deploymentTypes List<String>: list of deployment types, e.g. on_demand, spot_market
description String: description of the plan
id String: id of the plan
legacy Boolean: flag showing if it's a legacy plan
line String: plan line, e.g. baremetal
name String: name of the plan
pricingHour Double: plan hourly price
pricingMonth Double: plan monthly price
slug String: plan slug

availableInMetros string[]: list of metros where the plan is available
availableIns string[]: (Deprecated) list of facilities where the plan is available
Deprecated: Use available_in_metros instead. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices
class string: plan class
deploymentTypes string[]: list of deployment types, e.g. on_demand, spot_market
description string: description of the plan
id string: id of the plan
legacy boolean: flag showing if it's a legacy plan
line string: plan line, e.g. baremetal
name string: name of the plan
pricingHour number: plan hourly price
pricingMonth number: plan monthly price
slug string: plan slug

available_in_metros Sequence[str]: list of metros where the plan is available
available_ins Sequence[str]: (Deprecated) list of facilities where the plan is available
Deprecated: Use available_in_metros instead. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices
class_ str: plan class
deployment_types Sequence[str]: list of deployment types, e.g. on_demand, spot_market
description str: description of the plan
id str: id of the plan
legacy bool: flag showing if it's a legacy plan
line str: plan line, e.g. baremetal
name str: name of the plan
pricing_hour float: plan hourly price
pricing_month float: plan monthly price
slug str: plan slug

availableInMetros List<String>: list of metros where the plan is available
availableIns List<String>: (Deprecated) list of facilities where the plan is available
Deprecated: Use available_in_metros instead. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices
class String: plan class
deploymentTypes List<String>: list of deployment types, e.g. on_demand, spot_market
description String: description of the plan
id String: id of the plan
legacy Boolean: flag showing if it's a legacy plan
line String: plan line, e.g. baremetal
name String: name of the plan
pricingHour Number: plan hourly price
pricingMonth Number: plan monthly price
slug String: plan slug

GetPlansSort

Attribute string: The attribute used to sort the results. Sort attributes are case-sensitive
Direction string: Sort results in ascending or descending order. Strings are sorted in alphabetical order. One of: asc, desc

Attribute string: The attribute used to sort the results. Sort attributes are case-sensitive
Direction string: Sort results in ascending or descending order. Strings are sorted in alphabetical order. One of: asc, desc

attribute String: The attribute used to sort the results. Sort attributes are case-sensitive
direction String: Sort results in ascending or descending order. Strings are sorted in alphabetical order. One of: asc, desc

attribute string: The attribute used to sort the results. Sort attributes are case-sensitive
direction string: Sort results in ascending or descending order. Strings are sorted in alphabetical order. One of: asc, desc

attribute str: The attribute used to sort the results. Sort attributes are case-sensitive
direction str: Sort results in ascending or descending order. Strings are sorted in alphabetical order. One of: asc, desc

attribute String: The attribute used to sort the results. Sort attributes are case-sensitive
direction String: Sort results in ascending or descending order. Strings are sorted in alphabetical order. One of: asc, desc

Package Details

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

Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix

equinix/pulumi-equinix

equinix.metal.getPlans

On this page

On this page

Using getPlans

getPlans Result

Supporting Types

GetPlansFilter

GetPlansPlan

GetPlansSort

Package Details

On this page

On this page