getMcrs

megaport 1.6.0, Apr 3 26

Viewing docs for megaport 1.6.0
published on Friday, Apr 3, 2026 by megaport

Using getMcrs

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 getMcrs(args: GetMcrsArgs, opts?: InvokeOptions): Promise<GetMcrsResult>
function getMcrsOutput(args: GetMcrsOutputArgs, opts?: InvokeOptions): Output<GetMcrsResult>

def get_mcrs(product_uid: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetMcrsResult
def get_mcrs_output(product_uid: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetMcrsResult]

func GetMcrs(ctx *Context, args *GetMcrsArgs, opts ...InvokeOption) (*GetMcrsResult, error)
func GetMcrsOutput(ctx *Context, args *GetMcrsOutputArgs, opts ...InvokeOption) GetMcrsResultOutput

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

public static class GetMcrs 
{
    public static Task<GetMcrsResult> InvokeAsync(GetMcrsArgs args, InvokeOptions? opts = null)
    public static Output<GetMcrsResult> Invoke(GetMcrsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMcrsResult> getMcrs(GetMcrsArgs args, InvokeOptions options)
public static Output<GetMcrsResult> getMcrs(GetMcrsArgs args, InvokeOptions options)

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

The following arguments are supported:

ProductUid string: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

ProductUid string: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

productUid String: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

productUid string: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

product_uid str: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

productUid String: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

getMcrs Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Mcrs List<GetMcrsMcr>: List of MCRs with detailed information.
ProductUid string: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

Id string: The provider-assigned unique ID for this managed resource.
Mcrs []GetMcrsMcr: List of MCRs with detailed information.
ProductUid string: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

id String: The provider-assigned unique ID for this managed resource.
mcrs List<GetMcrsMcr>: List of MCRs with detailed information.
productUid String: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

id string: The provider-assigned unique ID for this managed resource.
mcrs GetMcrsMcr[]: List of MCRs with detailed information.
productUid string: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

id str: The provider-assigned unique ID for this managed resource.
mcrs Sequence[GetMcrsMcr]: List of MCRs with detailed information.
product_uid str: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

id String: The provider-assigned unique ID for this managed resource.
mcrs List<Property Map>: List of MCRs with detailed information.
productUid String: The unique identifier of a specific MCR to look up. If not provided, all active MCRs are returned.

Supporting Types

GetMcrsMcr

AdminLocked bool: Whether the MCR is admin locked.
Asn double: The Autonomous System Number (ASN) of the MCR.
AttributeTags Dictionary<string, string>: The attribute tags of the MCR.
Cancelable bool: Whether the MCR can be cancelled.
CompanyName string: The name of the company that owns the MCR.
CompanyUid string: The Megaport Company UID of the MCR owner.
ContractEndDate string: The contract end date of the MCR.
ContractStartDate string: The contract start date of the MCR.
ContractTermMonths double: The contract term of the MCR in months.
CostCentre string: The cost centre of the MCR for billing purposes.
CreateDate string: The date the MCR was created.
CreatedBy string: The user who created the MCR.
DiversityZone string: The diversity zone of the MCR.
LiveDate string: The date the MCR went live.
LocationId double: The numeric location ID of the MCR.
Locked bool: Whether the MCR is locked.
Market string: The market the MCR is in.
MarketplaceVisibility bool: Whether the MCR is visible in the Marketplace.
PortSpeed double: The bandwidth speed of the MCR in Mbps.
ProductName string: The name of the MCR.
ProductUid string: The unique identifier of the MCR.
ProvisioningStatus string: The provisioning status of the MCR.
ResourceTags Dictionary<string, string>: The resource tags associated with the MCR.
SecondaryName string: The secondary name of the MCR.
TerminateDate string: The date the MCR will be terminated.
VxcAutoApproval bool: Whether VXC connections are auto-approved on this MCR.
VxcPermitted bool: Whether VXC connections are permitted on this MCR.

AdminLocked bool: Whether the MCR is admin locked.
Asn float64: The Autonomous System Number (ASN) of the MCR.
AttributeTags map[string]string: The attribute tags of the MCR.
Cancelable bool: Whether the MCR can be cancelled.
CompanyName string: The name of the company that owns the MCR.
CompanyUid string: The Megaport Company UID of the MCR owner.
ContractEndDate string: The contract end date of the MCR.
ContractStartDate string: The contract start date of the MCR.
ContractTermMonths float64: The contract term of the MCR in months.
CostCentre string: The cost centre of the MCR for billing purposes.
CreateDate string: The date the MCR was created.
CreatedBy string: The user who created the MCR.
DiversityZone string: The diversity zone of the MCR.
LiveDate string: The date the MCR went live.
LocationId float64: The numeric location ID of the MCR.
Locked bool: Whether the MCR is locked.
Market string: The market the MCR is in.
MarketplaceVisibility bool: Whether the MCR is visible in the Marketplace.
PortSpeed float64: The bandwidth speed of the MCR in Mbps.
ProductName string: The name of the MCR.
ProductUid string: The unique identifier of the MCR.
ProvisioningStatus string: The provisioning status of the MCR.
ResourceTags map[string]string: The resource tags associated with the MCR.
SecondaryName string: The secondary name of the MCR.
TerminateDate string: The date the MCR will be terminated.
VxcAutoApproval bool: Whether VXC connections are auto-approved on this MCR.
VxcPermitted bool: Whether VXC connections are permitted on this MCR.

adminLocked Boolean: Whether the MCR is admin locked.
asn Double: The Autonomous System Number (ASN) of the MCR.
attributeTags Map<String,String>: The attribute tags of the MCR.
cancelable Boolean: Whether the MCR can be cancelled.
companyName String: The name of the company that owns the MCR.
companyUid String: The Megaport Company UID of the MCR owner.
contractEndDate String: The contract end date of the MCR.
contractStartDate String: The contract start date of the MCR.
contractTermMonths Double: The contract term of the MCR in months.
costCentre String: The cost centre of the MCR for billing purposes.
createDate String: The date the MCR was created.
createdBy String: The user who created the MCR.
diversityZone String: The diversity zone of the MCR.
liveDate String: The date the MCR went live.
locationId Double: The numeric location ID of the MCR.
locked Boolean: Whether the MCR is locked.
market String: The market the MCR is in.
marketplaceVisibility Boolean: Whether the MCR is visible in the Marketplace.
portSpeed Double: The bandwidth speed of the MCR in Mbps.
productName String: The name of the MCR.
productUid String: The unique identifier of the MCR.
provisioningStatus String: The provisioning status of the MCR.
resourceTags Map<String,String>: The resource tags associated with the MCR.
secondaryName String: The secondary name of the MCR.
terminateDate String: The date the MCR will be terminated.
vxcAutoApproval Boolean: Whether VXC connections are auto-approved on this MCR.
vxcPermitted Boolean: Whether VXC connections are permitted on this MCR.

adminLocked boolean: Whether the MCR is admin locked.
asn number: The Autonomous System Number (ASN) of the MCR.
attributeTags {[key: string]: string}: The attribute tags of the MCR.
cancelable boolean: Whether the MCR can be cancelled.
companyName string: The name of the company that owns the MCR.
companyUid string: The Megaport Company UID of the MCR owner.
contractEndDate string: The contract end date of the MCR.
contractStartDate string: The contract start date of the MCR.
contractTermMonths number: The contract term of the MCR in months.
costCentre string: The cost centre of the MCR for billing purposes.
createDate string: The date the MCR was created.
createdBy string: The user who created the MCR.
diversityZone string: The diversity zone of the MCR.
liveDate string: The date the MCR went live.
locationId number: The numeric location ID of the MCR.
locked boolean: Whether the MCR is locked.
market string: The market the MCR is in.
marketplaceVisibility boolean: Whether the MCR is visible in the Marketplace.
portSpeed number: The bandwidth speed of the MCR in Mbps.
productName string: The name of the MCR.
productUid string: The unique identifier of the MCR.
provisioningStatus string: The provisioning status of the MCR.
resourceTags {[key: string]: string}: The resource tags associated with the MCR.
secondaryName string: The secondary name of the MCR.
terminateDate string: The date the MCR will be terminated.
vxcAutoApproval boolean: Whether VXC connections are auto-approved on this MCR.
vxcPermitted boolean: Whether VXC connections are permitted on this MCR.

admin_locked bool: Whether the MCR is admin locked.
asn float: The Autonomous System Number (ASN) of the MCR.
attribute_tags Mapping[str, str]: The attribute tags of the MCR.
cancelable bool: Whether the MCR can be cancelled.
company_name str: The name of the company that owns the MCR.
company_uid str: The Megaport Company UID of the MCR owner.
contract_end_date str: The contract end date of the MCR.
contract_start_date str: The contract start date of the MCR.
contract_term_months float: The contract term of the MCR in months.
cost_centre str: The cost centre of the MCR for billing purposes.
create_date str: The date the MCR was created.
created_by str: The user who created the MCR.
diversity_zone str: The diversity zone of the MCR.
live_date str: The date the MCR went live.
location_id float: The numeric location ID of the MCR.
locked bool: Whether the MCR is locked.
market str: The market the MCR is in.
marketplace_visibility bool: Whether the MCR is visible in the Marketplace.
port_speed float: The bandwidth speed of the MCR in Mbps.
product_name str: The name of the MCR.
product_uid str: The unique identifier of the MCR.
provisioning_status str: The provisioning status of the MCR.
resource_tags Mapping[str, str]: The resource tags associated with the MCR.
secondary_name str: The secondary name of the MCR.
terminate_date str: The date the MCR will be terminated.
vxc_auto_approval bool: Whether VXC connections are auto-approved on this MCR.
vxc_permitted bool: Whether VXC connections are permitted on this MCR.

adminLocked Boolean: Whether the MCR is admin locked.
asn Number: The Autonomous System Number (ASN) of the MCR.
attributeTags Map<String>: The attribute tags of the MCR.
cancelable Boolean: Whether the MCR can be cancelled.
companyName String: The name of the company that owns the MCR.
companyUid String: The Megaport Company UID of the MCR owner.
contractEndDate String: The contract end date of the MCR.
contractStartDate String: The contract start date of the MCR.
contractTermMonths Number: The contract term of the MCR in months.
costCentre String: The cost centre of the MCR for billing purposes.
createDate String: The date the MCR was created.
createdBy String: The user who created the MCR.
diversityZone String: The diversity zone of the MCR.
liveDate String: The date the MCR went live.
locationId Number: The numeric location ID of the MCR.
locked Boolean: Whether the MCR is locked.
market String: The market the MCR is in.
marketplaceVisibility Boolean: Whether the MCR is visible in the Marketplace.
portSpeed Number: The bandwidth speed of the MCR in Mbps.
productName String: The name of the MCR.
productUid String: The unique identifier of the MCR.
provisioningStatus String: The provisioning status of the MCR.
resourceTags Map<String>: The resource tags associated with the MCR.
secondaryName String: The secondary name of the MCR.
terminateDate String: The date the MCR will be terminated.
vxcAutoApproval Boolean: Whether VXC connections are auto-approved on this MCR.
vxcPermitted Boolean: Whether VXC connections are permitted on this MCR.