getVxcs

megaport 1.7.0, Apr 30 26

Viewing docs for megaport 1.7.0
published on Thursday, Apr 30, 2026 by megaport

Using getVxcs

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 getVxcs(args: GetVxcsArgs, opts?: InvokeOptions): Promise<GetVxcsResult>
function getVxcsOutput(args: GetVxcsOutputArgs, opts?: InvokeOptions): Output<GetVxcsResult>

def get_vxcs(include_resource_tags: Optional[bool] = None,
             product_uid: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetVxcsResult
def get_vxcs_output(include_resource_tags: Optional[pulumi.Input[bool]] = None,
             product_uid: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetVxcsResult]

func GetVxcs(ctx *Context, args *GetVxcsArgs, opts ...InvokeOption) (*GetVxcsResult, error)
func GetVxcsOutput(ctx *Context, args *GetVxcsOutputArgs, opts ...InvokeOption) GetVxcsResultOutput

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

public static class GetVxcs 
{
    public static Task<GetVxcsResult> InvokeAsync(GetVxcsArgs args, InvokeOptions? opts = null)
    public static Output<GetVxcsResult> Invoke(GetVxcsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVxcsResult> getVxcs(GetVxcsArgs args, InvokeOptions options)
public static Output<GetVxcsResult> getVxcs(GetVxcsArgs args, InvokeOptions options)

fn::invoke:
  function: megaport:index/getVxcs:getVxcs
  arguments:
    # arguments dictionary

The following arguments are supported:

IncludeResourceTags bool: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
ProductUid string: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

IncludeResourceTags bool: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
ProductUid string: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

includeResourceTags Boolean: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
productUid String: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

includeResourceTags boolean: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
productUid string: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

include_resource_tags bool: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
product_uid str: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

includeResourceTags Boolean: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
productUid String: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

getVxcs Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Vxcs List<GetVxcsVxc>: List of VXCs with detailed information.
IncludeResourceTags bool: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
ProductUid string: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

Id string: The provider-assigned unique ID for this managed resource.
Vxcs []GetVxcsVxc: List of VXCs with detailed information.
IncludeResourceTags bool: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
ProductUid string: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

id String: The provider-assigned unique ID for this managed resource.
vxcs List<GetVxcsVxc>: List of VXCs with detailed information.
includeResourceTags Boolean: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
productUid String: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

id string: The provider-assigned unique ID for this managed resource.
vxcs GetVxcsVxc[]: List of VXCs with detailed information.
includeResourceTags boolean: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
productUid string: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

id str: The provider-assigned unique ID for this managed resource.
vxcs Sequence[GetVxcsVxc]: List of VXCs with detailed information.
include_resource_tags bool: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
product_uid str: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

id String: The provider-assigned unique ID for this managed resource.
vxcs List<Property Map>: List of VXCs with detailed information.
includeResourceTags Boolean: Whether to fetch resource tags for each VXC. Enabling this causes an additional API call per VXC, which may be slow for accounts with many VXCs.
productUid String: The unique identifier of a specific VXC to look up. If not provided, all active VXCs are returned.

Supporting Types

GetVxcsVxc

AEndLocationId double: The location ID of the A-End of the VXC.
AEndName string: The product name of the A-End of the VXC.
AEndUid string: The product UID of the A-End of the VXC.
AEndVlan double: The VLAN of the A-End of the VXC.
AdminLocked bool: Whether the VXC is admin locked.
AttributeTags Dictionary<string, string>: The attribute tags of the VXC.
BEndLocationId double: The location ID of the B-End of the VXC.
BEndName string: The product name of the B-End of the VXC.
BEndUid string: The product UID of the B-End of the VXC.
BEndVlan double: The VLAN of the B-End of the VXC.
Cancelable bool: Whether the VXC can be cancelled.
CompanyName string: The name of the company that owns the VXC.
CompanyUid string: The Megaport Company UID of the VXC owner.
ContractEndDate string: The contract end date of the VXC.
ContractStartDate string: The contract start date of the VXC.
ContractTermMonths double: The contract term of the VXC in months.
CostCentre string: The cost centre of the VXC for billing purposes.
CreateDate string: The date the VXC was created.
CreatedBy string: The user who created the VXC.
DistanceBand string: The distance band of the VXC.
LiveDate string: The date the VXC went live.
Locked bool: Whether the VXC is locked.
ProductName string: The name of the VXC.
ProductUid string: The unique identifier of the VXC.
ProvisioningStatus string: The provisioning status of the VXC.
RateLimit double: The rate limit of the VXC in Mbps.
ResourceTags Dictionary<string, string>: The resource tags associated with the VXC. Only populated when includeresourcetags is enabled; otherwise null.
SecondaryName string: The secondary name of the VXC.
Shutdown bool: Whether the VXC is shut down.

AEndLocationId float64: The location ID of the A-End of the VXC.
AEndName string: The product name of the A-End of the VXC.
AEndUid string: The product UID of the A-End of the VXC.
AEndVlan float64: The VLAN of the A-End of the VXC.
AdminLocked bool: Whether the VXC is admin locked.
AttributeTags map[string]string: The attribute tags of the VXC.
BEndLocationId float64: The location ID of the B-End of the VXC.
BEndName string: The product name of the B-End of the VXC.
BEndUid string: The product UID of the B-End of the VXC.
BEndVlan float64: The VLAN of the B-End of the VXC.
Cancelable bool: Whether the VXC can be cancelled.
CompanyName string: The name of the company that owns the VXC.
CompanyUid string: The Megaport Company UID of the VXC owner.
ContractEndDate string: The contract end date of the VXC.
ContractStartDate string: The contract start date of the VXC.
ContractTermMonths float64: The contract term of the VXC in months.
CostCentre string: The cost centre of the VXC for billing purposes.
CreateDate string: The date the VXC was created.
CreatedBy string: The user who created the VXC.
DistanceBand string: The distance band of the VXC.
LiveDate string: The date the VXC went live.
Locked bool: Whether the VXC is locked.
ProductName string: The name of the VXC.
ProductUid string: The unique identifier of the VXC.
ProvisioningStatus string: The provisioning status of the VXC.
RateLimit float64: The rate limit of the VXC in Mbps.
ResourceTags map[string]string: The resource tags associated with the VXC. Only populated when includeresourcetags is enabled; otherwise null.
SecondaryName string: The secondary name of the VXC.
Shutdown bool: Whether the VXC is shut down.

aEndLocationId Double: The location ID of the A-End of the VXC.
aEndName String: The product name of the A-End of the VXC.
aEndUid String: The product UID of the A-End of the VXC.
aEndVlan Double: The VLAN of the A-End of the VXC.
adminLocked Boolean: Whether the VXC is admin locked.
attributeTags Map<String,String>: The attribute tags of the VXC.
bEndLocationId Double: The location ID of the B-End of the VXC.
bEndName String: The product name of the B-End of the VXC.
bEndUid String: The product UID of the B-End of the VXC.
bEndVlan Double: The VLAN of the B-End of the VXC.
cancelable Boolean: Whether the VXC can be cancelled.
companyName String: The name of the company that owns the VXC.
companyUid String: The Megaport Company UID of the VXC owner.
contractEndDate String: The contract end date of the VXC.
contractStartDate String: The contract start date of the VXC.
contractTermMonths Double: The contract term of the VXC in months.
costCentre String: The cost centre of the VXC for billing purposes.
createDate String: The date the VXC was created.
createdBy String: The user who created the VXC.
distanceBand String: The distance band of the VXC.
liveDate String: The date the VXC went live.
locked Boolean: Whether the VXC is locked.
productName String: The name of the VXC.
productUid String: The unique identifier of the VXC.
provisioningStatus String: The provisioning status of the VXC.
rateLimit Double: The rate limit of the VXC in Mbps.
resourceTags Map<String,String>: The resource tags associated with the VXC. Only populated when includeresourcetags is enabled; otherwise null.
secondaryName String: The secondary name of the VXC.
shutdown Boolean: Whether the VXC is shut down.

aEndLocationId number: The location ID of the A-End of the VXC.
aEndName string: The product name of the A-End of the VXC.
aEndUid string: The product UID of the A-End of the VXC.
aEndVlan number: The VLAN of the A-End of the VXC.
adminLocked boolean: Whether the VXC is admin locked.
attributeTags {[key: string]: string}: The attribute tags of the VXC.
bEndLocationId number: The location ID of the B-End of the VXC.
bEndName string: The product name of the B-End of the VXC.
bEndUid string: The product UID of the B-End of the VXC.
bEndVlan number: The VLAN of the B-End of the VXC.
cancelable boolean: Whether the VXC can be cancelled.
companyName string: The name of the company that owns the VXC.
companyUid string: The Megaport Company UID of the VXC owner.
contractEndDate string: The contract end date of the VXC.
contractStartDate string: The contract start date of the VXC.
contractTermMonths number: The contract term of the VXC in months.
costCentre string: The cost centre of the VXC for billing purposes.
createDate string: The date the VXC was created.
createdBy string: The user who created the VXC.
distanceBand string: The distance band of the VXC.
liveDate string: The date the VXC went live.
locked boolean: Whether the VXC is locked.
productName string: The name of the VXC.
productUid string: The unique identifier of the VXC.
provisioningStatus string: The provisioning status of the VXC.
rateLimit number: The rate limit of the VXC in Mbps.
resourceTags {[key: string]: string}: The resource tags associated with the VXC. Only populated when includeresourcetags is enabled; otherwise null.
secondaryName string: The secondary name of the VXC.
shutdown boolean: Whether the VXC is shut down.

a_end_location_id float: The location ID of the A-End of the VXC.
a_end_name str: The product name of the A-End of the VXC.
a_end_uid str: The product UID of the A-End of the VXC.
a_end_vlan float: The VLAN of the A-End of the VXC.
admin_locked bool: Whether the VXC is admin locked.
attribute_tags Mapping[str, str]: The attribute tags of the VXC.
b_end_location_id float: The location ID of the B-End of the VXC.
b_end_name str: The product name of the B-End of the VXC.
b_end_uid str: The product UID of the B-End of the VXC.
b_end_vlan float: The VLAN of the B-End of the VXC.
cancelable bool: Whether the VXC can be cancelled.
company_name str: The name of the company that owns the VXC.
company_uid str: The Megaport Company UID of the VXC owner.
contract_end_date str: The contract end date of the VXC.
contract_start_date str: The contract start date of the VXC.
contract_term_months float: The contract term of the VXC in months.
cost_centre str: The cost centre of the VXC for billing purposes.
create_date str: The date the VXC was created.
created_by str: The user who created the VXC.
distance_band str: The distance band of the VXC.
live_date str: The date the VXC went live.
locked bool: Whether the VXC is locked.
product_name str: The name of the VXC.
product_uid str: The unique identifier of the VXC.
provisioning_status str: The provisioning status of the VXC.
rate_limit float: The rate limit of the VXC in Mbps.
resource_tags Mapping[str, str]: The resource tags associated with the VXC. Only populated when includeresourcetags is enabled; otherwise null.
secondary_name str: The secondary name of the VXC.
shutdown bool: Whether the VXC is shut down.

aEndLocationId Number: The location ID of the A-End of the VXC.
aEndName String: The product name of the A-End of the VXC.
aEndUid String: The product UID of the A-End of the VXC.
aEndVlan Number: The VLAN of the A-End of the VXC.
adminLocked Boolean: Whether the VXC is admin locked.
attributeTags Map<String>: The attribute tags of the VXC.
bEndLocationId Number: The location ID of the B-End of the VXC.
bEndName String: The product name of the B-End of the VXC.
bEndUid String: The product UID of the B-End of the VXC.
bEndVlan Number: The VLAN of the B-End of the VXC.
cancelable Boolean: Whether the VXC can be cancelled.
companyName String: The name of the company that owns the VXC.
companyUid String: The Megaport Company UID of the VXC owner.
contractEndDate String: The contract end date of the VXC.
contractStartDate String: The contract start date of the VXC.
contractTermMonths Number: The contract term of the VXC in months.
costCentre String: The cost centre of the VXC for billing purposes.
createDate String: The date the VXC was created.
createdBy String: The user who created the VXC.
distanceBand String: The distance band of the VXC.
liveDate String: The date the VXC went live.
locked Boolean: Whether the VXC is locked.
productName String: The name of the VXC.
productUid String: The unique identifier of the VXC.
provisioningStatus String: The provisioning status of the VXC.
rateLimit Number: The rate limit of the VXC in Mbps.
resourceTags Map<String>: The resource tags associated with the VXC. Only populated when includeresourcetags is enabled; otherwise null.
secondaryName String: The secondary name of the VXC.
shutdown Boolean: Whether the VXC is shut down.