Equinix v0.19.0 published on Thursday, Oct 24, 2024 by Equinix
equinix.fabric.getNetworks
Explore with Pulumi AI
Fabric V4 API compatible data resource that allow user to fetch Fabric Network for a given UUID
Additional documentation:
- Getting Started: https://docs.equinix.com/en-us/Content/Interconnection/Fabric/IMPLEMENTATION/fabric-networks-implement.htm
 - API: https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#fabric-networks
 
Using getNetworks
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 getNetworks(args: GetNetworksArgs, opts?: InvokeOptions): Promise<GetNetworksResult>
function getNetworksOutput(args: GetNetworksOutputArgs, opts?: InvokeOptions): Output<GetNetworksResult>def get_networks(filters: Optional[Sequence[GetNetworksFilter]] = None,
                 outer_operator: Optional[str] = None,
                 pagination: Optional[GetNetworksPagination] = None,
                 sorts: Optional[Sequence[GetNetworksSort]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetNetworksResult
def get_networks_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetNetworksFilterArgs]]]] = None,
                 outer_operator: Optional[pulumi.Input[str]] = None,
                 pagination: Optional[pulumi.Input[GetNetworksPaginationArgs]] = None,
                 sorts: Optional[pulumi.Input[Sequence[pulumi.Input[GetNetworksSortArgs]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetNetworksResult]func GetNetworks(ctx *Context, args *GetNetworksArgs, opts ...InvokeOption) (*GetNetworksResult, error)
func GetNetworksOutput(ctx *Context, args *GetNetworksOutputArgs, opts ...InvokeOption) GetNetworksResultOutput> Note: This function is named GetNetworks in the Go SDK.
public static class GetNetworks 
{
    public static Task<GetNetworksResult> InvokeAsync(GetNetworksArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworksResult> Invoke(GetNetworksInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetNetworksResult> getNetworks(GetNetworksArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: equinix:fabric/getNetworks:getNetworks
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Filters
List<Get
Networks Filter>  - Filters for the Data Source Search Request
 - Outer
Operator string - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - Pagination
Get
Networks Pagination  - Pagination details for the Data Source Search Request
 - Sorts
List<Get
Networks Sort>  - Filters for the Data Source Search Request
 
- Filters
[]Get
Networks Filter  - Filters for the Data Source Search Request
 - Outer
Operator string - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - Pagination
Get
Networks Pagination  - Pagination details for the Data Source Search Request
 - Sorts
[]Get
Networks Sort  - Filters for the Data Source Search Request
 
- filters
List<Get
Networks Filter>  - Filters for the Data Source Search Request
 - outer
Operator String - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - pagination
Get
Networks Pagination  - Pagination details for the Data Source Search Request
 - sorts
List<Get
Networks Sort>  - Filters for the Data Source Search Request
 
- filters
Get
Networks Filter[]  - Filters for the Data Source Search Request
 - outer
Operator string - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - pagination
Get
Networks Pagination  - Pagination details for the Data Source Search Request
 - sorts
Get
Networks Sort[]  - Filters for the Data Source Search Request
 
- filters
Sequence[Get
Networks Filter]  - Filters for the Data Source Search Request
 - outer_
operator str - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - pagination
Get
Networks Pagination  - Pagination details for the Data Source Search Request
 - sorts
Sequence[Get
Networks Sort]  - Filters for the Data Source Search Request
 
- filters List<Property Map>
 - Filters for the Data Source Search Request
 - outer
Operator String - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - pagination Property Map
 - Pagination details for the Data Source Search Request
 - sorts List<Property Map>
 - Filters for the Data Source Search Request
 
getNetworks Result
The following output properties are available:
- Datas
List<Get
Networks Data>  - List of Cloud Routers
 - Filters
List<Get
Networks Filter>  - Filters for the Data Source Search Request
 - Id string
 - The provider-assigned unique ID for this managed resource.
 - Outer
Operator string - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - Pagination
Get
Networks Pagination  - Pagination details for the Data Source Search Request
 - Sorts
List<Get
Networks Sort>  - Filters for the Data Source Search Request
 
- Datas
[]Get
Networks Data  - List of Cloud Routers
 - Filters
[]Get
Networks Filter  - Filters for the Data Source Search Request
 - Id string
 - The provider-assigned unique ID for this managed resource.
 - Outer
Operator string - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - Pagination
Get
Networks Pagination  - Pagination details for the Data Source Search Request
 - Sorts
[]Get
Networks Sort  - Filters for the Data Source Search Request
 
- datas
List<Get
Networks Data>  - List of Cloud Routers
 - filters
List<Get
Networks Filter>  - Filters for the Data Source Search Request
 - id String
 - The provider-assigned unique ID for this managed resource.
 - outer
Operator String - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - pagination
Get
Networks Pagination  - Pagination details for the Data Source Search Request
 - sorts
List<Get
Networks Sort>  - Filters for the Data Source Search Request
 
- datas
Get
Networks Data[]  - List of Cloud Routers
 - filters
Get
Networks Filter[]  - Filters for the Data Source Search Request
 - id string
 - The provider-assigned unique ID for this managed resource.
 - outer
Operator string - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - pagination
Get
Networks Pagination  - Pagination details for the Data Source Search Request
 - sorts
Get
Networks Sort[]  - Filters for the Data Source Search Request
 
- datas
Sequence[Get
Networks Data]  - List of Cloud Routers
 - filters
Sequence[Get
Networks Filter]  - Filters for the Data Source Search Request
 - id str
 - The provider-assigned unique ID for this managed resource.
 - outer_
operator str - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - pagination
Get
Networks Pagination  - Pagination details for the Data Source Search Request
 - sorts
Sequence[Get
Networks Sort]  - Filters for the Data Source Search Request
 
- datas List<Property Map>
 - List of Cloud Routers
 - filters List<Property Map>
 - Filters for the Data Source Search Request
 - id String
 - The provider-assigned unique ID for this managed resource.
 - outer
Operator String - Determines if the filter list will be grouped by AND or by OR. One of [AND, OR]
 - pagination Property Map
 - Pagination details for the Data Source Search Request
 - sorts List<Property Map>
 - Filters for the Data Source Search Request
 
Supporting Types
GetNetworksData  
- Change
Logs List<GetNetworks Data Change Log>  - A permanent record of asset creation, modification, or deletion
 - Changes
List<Get
Networks Data Change>  - Information on asset change operation
 - Connections
Count int - Number of connections associated with this network
 - Href string
 - Fabric Network URI information
 - Locations
List<Get
Networks Data Location>  - Fabric Network location
 - Name string
 - Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
 - Notifications
List<Get
Networks Data Notification>  - Preferences for notifications on Fabric Network configuration or status changes
 - Operations
List<Get
Networks Data Operation>  - Network operation information that is associated with this Fabric Network
 - Projects
List<Get
Networks Data Project>  - Fabric Network project
 - Scope string
 - Fabric Network scope
 - State string
 - Fabric Network overall state
 - Type string
 - Supported Network types - EVPLAN, EPLAN, IPWAN
 - Uuid string
 - Equinix-assigned network identifier
 
- Change
Logs []GetNetworks Data Change Log  - A permanent record of asset creation, modification, or deletion
 - Changes
[]Get
Networks Data Change  - Information on asset change operation
 - Connections
Count int - Number of connections associated with this network
 - Href string
 - Fabric Network URI information
 - Locations
[]Get
Networks Data Location  - Fabric Network location
 - Name string
 - Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
 - Notifications
[]Get
Networks Data Notification  - Preferences for notifications on Fabric Network configuration or status changes
 - Operations
[]Get
Networks Data Operation  - Network operation information that is associated with this Fabric Network
 - Projects
[]Get
Networks Data Project  - Fabric Network project
 - Scope string
 - Fabric Network scope
 - State string
 - Fabric Network overall state
 - Type string
 - Supported Network types - EVPLAN, EPLAN, IPWAN
 - Uuid string
 - Equinix-assigned network identifier
 
- change
Logs List<GetNetworks Data Change Log>  - A permanent record of asset creation, modification, or deletion
 - changes
List<Get
Networks Data Change>  - Information on asset change operation
 - connections
Count Integer - Number of connections associated with this network
 - href String
 - Fabric Network URI information
 - locations
List<Get
Networks Data Location>  - Fabric Network location
 - name String
 - Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
 - notifications
List<Get
Networks Data Notification>  - Preferences for notifications on Fabric Network configuration or status changes
 - operations
List<Get
Networks Data Operation>  - Network operation information that is associated with this Fabric Network
 - projects
List<Get
Networks Data Project>  - Fabric Network project
 - scope String
 - Fabric Network scope
 - state String
 - Fabric Network overall state
 - type String
 - Supported Network types - EVPLAN, EPLAN, IPWAN
 - uuid String
 - Equinix-assigned network identifier
 
- change
Logs GetNetworks Data Change Log[]  - A permanent record of asset creation, modification, or deletion
 - changes
Get
Networks Data Change[]  - Information on asset change operation
 - connections
Count number - Number of connections associated with this network
 - href string
 - Fabric Network URI information
 - locations
Get
Networks Data Location[]  - Fabric Network location
 - name string
 - Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
 - notifications
Get
Networks Data Notification[]  - Preferences for notifications on Fabric Network configuration or status changes
 - operations
Get
Networks Data Operation[]  - Network operation information that is associated with this Fabric Network
 - projects
Get
Networks Data Project[]  - Fabric Network project
 - scope string
 - Fabric Network scope
 - state string
 - Fabric Network overall state
 - type string
 - Supported Network types - EVPLAN, EPLAN, IPWAN
 - uuid string
 - Equinix-assigned network identifier
 
- change_
logs Sequence[GetNetworks Data Change Log]  - A permanent record of asset creation, modification, or deletion
 - changes
Sequence[Get
Networks Data Change]  - Information on asset change operation
 - connections_
count int - Number of connections associated with this network
 - href str
 - Fabric Network URI information
 - locations
Sequence[Get
Networks Data Location]  - Fabric Network location
 - name str
 - Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
 - notifications
Sequence[Get
Networks Data Notification]  - Preferences for notifications on Fabric Network configuration or status changes
 - operations
Sequence[Get
Networks Data Operation]  - Network operation information that is associated with this Fabric Network
 - projects
Sequence[Get
Networks Data Project]  - Fabric Network project
 - scope str
 - Fabric Network scope
 - state str
 - Fabric Network overall state
 - type str
 - Supported Network types - EVPLAN, EPLAN, IPWAN
 - uuid str
 - Equinix-assigned network identifier
 
- change
Logs List<Property Map> - A permanent record of asset creation, modification, or deletion
 - changes List<Property Map>
 - Information on asset change operation
 - connections
Count Number - Number of connections associated with this network
 - href String
 - Fabric Network URI information
 - locations List<Property Map>
 - Fabric Network location
 - name String
 - Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
 - notifications List<Property Map>
 - Preferences for notifications on Fabric Network configuration or status changes
 - operations List<Property Map>
 - Network operation information that is associated with this Fabric Network
 - projects List<Property Map>
 - Fabric Network project
 - scope String
 - Fabric Network scope
 - state String
 - Fabric Network overall state
 - type String
 - Supported Network types - EVPLAN, EPLAN, IPWAN
 - uuid String
 - Equinix-assigned network identifier
 
GetNetworksDataChange   
GetNetworksDataChangeLog    
- Created
By string - Created by User Key
 - Created
By stringEmail  - Created by User Email Address
 - Created
By stringFull Name  - Created by User Full Name
 - Created
Date stringTime  - Created by Date and Time
 - Deleted
By string - Deleted by User Key
 - Deleted
By stringEmail  - Deleted by User Email Address
 - Deleted
By stringFull Name  - Deleted by User Full Name
 - Deleted
Date stringTime  - Deleted by Date and Time
 - Updated
By string - Updated by User Key
 - Updated
By stringEmail  - Updated by User Email Address
 - Updated
By stringFull Name  - Updated by User Full Name
 - Updated
Date stringTime  - Updated by Date and Time
 
- Created
By string - Created by User Key
 - Created
By stringEmail  - Created by User Email Address
 - Created
By stringFull Name  - Created by User Full Name
 - Created
Date stringTime  - Created by Date and Time
 - Deleted
By string - Deleted by User Key
 - Deleted
By stringEmail  - Deleted by User Email Address
 - Deleted
By stringFull Name  - Deleted by User Full Name
 - Deleted
Date stringTime  - Deleted by Date and Time
 - Updated
By string - Updated by User Key
 - Updated
By stringEmail  - Updated by User Email Address
 - Updated
By stringFull Name  - Updated by User Full Name
 - Updated
Date stringTime  - Updated by Date and Time
 
- created
By String - Created by User Key
 - created
By StringEmail  - Created by User Email Address
 - created
By StringFull Name  - Created by User Full Name
 - created
Date StringTime  - Created by Date and Time
 - deleted
By String - Deleted by User Key
 - deleted
By StringEmail  - Deleted by User Email Address
 - deleted
By StringFull Name  - Deleted by User Full Name
 - deleted
Date StringTime  - Deleted by Date and Time
 - updated
By String - Updated by User Key
 - updated
By StringEmail  - Updated by User Email Address
 - updated
By StringFull Name  - Updated by User Full Name
 - updated
Date StringTime  - Updated by Date and Time
 
- created
By string - Created by User Key
 - created
By stringEmail  - Created by User Email Address
 - created
By stringFull Name  - Created by User Full Name
 - created
Date stringTime  - Created by Date and Time
 - deleted
By string - Deleted by User Key
 - deleted
By stringEmail  - Deleted by User Email Address
 - deleted
By stringFull Name  - Deleted by User Full Name
 - deleted
Date stringTime  - Deleted by Date and Time
 - updated
By string - Updated by User Key
 - updated
By stringEmail  - Updated by User Email Address
 - updated
By stringFull Name  - Updated by User Full Name
 - updated
Date stringTime  - Updated by Date and Time
 
- created_
by str - Created by User Key
 - created_
by_ stremail  - Created by User Email Address
 - created_
by_ strfull_ name  - Created by User Full Name
 - created_
date_ strtime  - Created by Date and Time
 - deleted_
by str - Deleted by User Key
 - deleted_
by_ stremail  - Deleted by User Email Address
 - deleted_
by_ strfull_ name  - Deleted by User Full Name
 - deleted_
date_ strtime  - Deleted by Date and Time
 - updated_
by str - Updated by User Key
 - updated_
by_ stremail  - Updated by User Email Address
 - updated_
by_ strfull_ name  - Updated by User Full Name
 - updated_
date_ strtime  - Updated by Date and Time
 
- created
By String - Created by User Key
 - created
By StringEmail  - Created by User Email Address
 - created
By StringFull Name  - Created by User Full Name
 - created
Date StringTime  - Created by Date and Time
 - deleted
By String - Deleted by User Key
 - deleted
By StringEmail  - Deleted by User Email Address
 - deleted
By StringFull Name  - Deleted by User Full Name
 - deleted
Date StringTime  - Deleted by Date and Time
 - updated
By String - Updated by User Key
 - updated
By StringEmail  - Updated by User Email Address
 - updated
By StringFull Name  - Updated by User Full Name
 - updated
Date StringTime  - Updated by Date and Time
 
GetNetworksDataLocation   
- ibx str
 - IBX Code
 - metro_
code str - Access point metro code
 - metro_
name str - Access point metro name
 - region str
 - Access point region
 
GetNetworksDataNotification   
- Emails List<string>
 - Array of contact emails
 - Type string
 - Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
 - Send
Interval string - Send interval
 
- Emails []string
 - Array of contact emails
 - Type string
 - Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
 - Send
Interval string - Send interval
 
- emails List<String>
 - Array of contact emails
 - type String
 - Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
 - send
Interval String - Send interval
 
- emails string[]
 - Array of contact emails
 - type string
 - Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
 - send
Interval string - Send interval
 
- emails Sequence[str]
 - Array of contact emails
 - type str
 - Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
 - send_
interval str - Send interval
 
- emails List<String>
 - Array of contact emails
 - type String
 - Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
 - send
Interval String - Send interval
 
GetNetworksDataOperation   
- Equinix
Status string - Progress towards provisioning a given asset.
 
- Equinix
Status string - Progress towards provisioning a given asset.
 
- equinix
Status String - Progress towards provisioning a given asset.
 
- equinix
Status string - Progress towards provisioning a given asset.
 
- equinix_
status str - Progress towards provisioning a given asset.
 
- equinix
Status String - Progress towards provisioning a given asset.
 
GetNetworksDataProject   
- Project
Id string - Customer project identifier
 
- Project
Id string - Customer project identifier
 
- project
Id String - Customer project identifier
 
- project
Id string - Customer project identifier
 
- project_
id str - Customer project identifier
 
- project
Id String - Customer project identifier
 
GetNetworksFilter  
- Operator string
 - Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, ILIKE, NOT ILIKE, IN, NOT IN]
 - Property string
 - Possible field names to use on filters. One of [/name /uuid /scope /type /operation/equinixStatus /location/region /project/projectId /account/globalCustId /account/orgId /deletedDate /_*]
 - Values List<string>
 - The values that you want to apply the property+operator combination to in order to filter your data search
 - Group string
 - Optional custom id parameter to assign this filter to an inner AND or OR group. Group id must be prefixed with AND_ or OR_. Ensure intended grouped elements have the same given id. Ungrouped filters will be placed in the filter list group by themselves.
 
- Operator string
 - Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, ILIKE, NOT ILIKE, IN, NOT IN]
 - Property string
 - Possible field names to use on filters. One of [/name /uuid /scope /type /operation/equinixStatus /location/region /project/projectId /account/globalCustId /account/orgId /deletedDate /_*]
 - Values []string
 - The values that you want to apply the property+operator combination to in order to filter your data search
 - Group string
 - Optional custom id parameter to assign this filter to an inner AND or OR group. Group id must be prefixed with AND_ or OR_. Ensure intended grouped elements have the same given id. Ungrouped filters will be placed in the filter list group by themselves.
 
- operator String
 - Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, ILIKE, NOT ILIKE, IN, NOT IN]
 - property String
 - Possible field names to use on filters. One of [/name /uuid /scope /type /operation/equinixStatus /location/region /project/projectId /account/globalCustId /account/orgId /deletedDate /_*]
 - values List<String>
 - The values that you want to apply the property+operator combination to in order to filter your data search
 - group String
 - Optional custom id parameter to assign this filter to an inner AND or OR group. Group id must be prefixed with AND_ or OR_. Ensure intended grouped elements have the same given id. Ungrouped filters will be placed in the filter list group by themselves.
 
- operator string
 - Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, ILIKE, NOT ILIKE, IN, NOT IN]
 - property string
 - Possible field names to use on filters. One of [/name /uuid /scope /type /operation/equinixStatus /location/region /project/projectId /account/globalCustId /account/orgId /deletedDate /_*]
 - values string[]
 - The values that you want to apply the property+operator combination to in order to filter your data search
 - group string
 - Optional custom id parameter to assign this filter to an inner AND or OR group. Group id must be prefixed with AND_ or OR_. Ensure intended grouped elements have the same given id. Ungrouped filters will be placed in the filter list group by themselves.
 
- operator str
 - Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, ILIKE, NOT ILIKE, IN, NOT IN]
 - property str
 - Possible field names to use on filters. One of [/name /uuid /scope /type /operation/equinixStatus /location/region /project/projectId /account/globalCustId /account/orgId /deletedDate /_*]
 - values Sequence[str]
 - The values that you want to apply the property+operator combination to in order to filter your data search
 - group str
 - Optional custom id parameter to assign this filter to an inner AND or OR group. Group id must be prefixed with AND_ or OR_. Ensure intended grouped elements have the same given id. Ungrouped filters will be placed in the filter list group by themselves.
 
- operator String
 - Operators to use on your filtered field with the values given. One of [ =, !=, >, >=, <, <=, BETWEEN, NOT BETWEEN, LIKE, NOT LIKE, ILIKE, NOT ILIKE, IN, NOT IN]
 - property String
 - Possible field names to use on filters. One of [/name /uuid /scope /type /operation/equinixStatus /location/region /project/projectId /account/globalCustId /account/orgId /deletedDate /_*]
 - values List<String>
 - The values that you want to apply the property+operator combination to in order to filter your data search
 - group String
 - Optional custom id parameter to assign this filter to an inner AND or OR group. Group id must be prefixed with AND_ or OR_. Ensure intended grouped elements have the same given id. Ungrouped filters will be placed in the filter list group by themselves.
 
GetNetworksPagination  
GetNetworksSort  
Package Details
- Repository
 - equinix equinix/pulumi-equinix
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
equinixTerraform Provider.