meraki.getNetworks

Explore with Pulumi AI

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

pulumi/pulumi-meraki

Example Usage

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(config_template_id: Optional[str] = None,
                 ending_before: Optional[str] = None,
                 is_bound_to_config_template: Optional[bool] = None,
                 network_id: Optional[str] = None,
                 organization_id: Optional[str] = None,
                 per_page: Optional[int] = None,
                 starting_after: Optional[str] = None,
                 tags: Optional[Sequence[str]] = None,
                 tags_filter_type: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetNetworksResult
def get_networks_output(config_template_id: Optional[pulumi.Input[str]] = None,
                 ending_before: Optional[pulumi.Input[str]] = None,
                 is_bound_to_config_template: Optional[pulumi.Input[bool]] = None,
                 network_id: Optional[pulumi.Input[str]] = None,
                 organization_id: Optional[pulumi.Input[str]] = None,
                 per_page: Optional[pulumi.Input[int]] = None,
                 starting_after: Optional[pulumi.Input[str]] = None,
                 tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 tags_filter_type: Optional[pulumi.Input[str]] = 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: meraki:index/getNetworks:getNetworks
  arguments:
    # arguments dictionary

The following arguments are supported:

ConfigTemplateId string: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
IsBoundToConfigTemplate bool: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
NetworkId string: networkId path parameter. Network ID
OrganizationId string: organizationId path parameter. Organization ID
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
Tags List<string>: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
TagsFilterType string: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

ConfigTemplateId string: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
IsBoundToConfigTemplate bool: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
NetworkId string: networkId path parameter. Network ID
OrganizationId string: organizationId path parameter. Organization ID
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
Tags []string: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
TagsFilterType string: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

configTemplateId String: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
isBoundToConfigTemplate Boolean: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
networkId String: networkId path parameter. Network ID
organizationId String: organizationId path parameter. Organization ID
perPage Integer: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
tags List<String>: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
tagsFilterType String: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

configTemplateId string: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
endingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
isBoundToConfigTemplate boolean: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
networkId string: networkId path parameter. Network ID
organizationId string: organizationId path parameter. Organization ID
perPage number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
startingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
tags string[]: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
tagsFilterType string: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

config_template_id str: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
ending_before str: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
is_bound_to_config_template bool: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
network_id str: networkId path parameter. Network ID
organization_id str: organizationId path parameter. Organization ID
per_page int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
starting_after str: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
tags Sequence[str]: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
tags_filter_type str: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

configTemplateId String: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
isBoundToConfigTemplate Boolean: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
networkId String: networkId path parameter. Network ID
organizationId String: organizationId path parameter. Organization ID
perPage Number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
tags List<String>: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
tagsFilterType String: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

getNetworks Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Item GetNetworksItem
Items List<GetNetworksItem>: Array of ResponseOrganizationsGetOrganizationNetworks
ConfigTemplateId string: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
IsBoundToConfigTemplate bool: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
NetworkId string: networkId path parameter. Network ID
OrganizationId string: organizationId path parameter. Organization ID
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
Tags List<string>: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
TagsFilterType string: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

Id string: The provider-assigned unique ID for this managed resource.
Item GetNetworksItem
Items []GetNetworksItem: Array of ResponseOrganizationsGetOrganizationNetworks
ConfigTemplateId string: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
IsBoundToConfigTemplate bool: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
NetworkId string: networkId path parameter. Network ID
OrganizationId string: organizationId path parameter. Organization ID
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
Tags []string: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
TagsFilterType string: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

id String: The provider-assigned unique ID for this managed resource.
item GetNetworksItem
items List<GetNetworksItem>: Array of ResponseOrganizationsGetOrganizationNetworks
configTemplateId String: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
isBoundToConfigTemplate Boolean: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
networkId String: networkId path parameter. Network ID
organizationId String: organizationId path parameter. Organization ID
perPage Integer: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
tags List<String>: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
tagsFilterType String: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

id string: The provider-assigned unique ID for this managed resource.
item GetNetworksItem
items GetNetworksItem[]: Array of ResponseOrganizationsGetOrganizationNetworks
configTemplateId string: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
endingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
isBoundToConfigTemplate boolean: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
networkId string: networkId path parameter. Network ID
organizationId string: organizationId path parameter. Organization ID
perPage number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
startingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
tags string[]: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
tagsFilterType string: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

id str: The provider-assigned unique ID for this managed resource.
item GetNetworksItem
items Sequence[GetNetworksItem]: Array of ResponseOrganizationsGetOrganizationNetworks
config_template_id str: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
ending_before str: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
is_bound_to_config_template bool: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
network_id str: networkId path parameter. Network ID
organization_id str: organizationId path parameter. Organization ID
per_page int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
starting_after str: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
tags Sequence[str]: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
tags_filter_type str: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

id String: The provider-assigned unique ID for this managed resource.
item Property Map
items List<Property Map>: Array of ResponseOrganizationsGetOrganizationNetworks
configTemplateId String: configTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all networks bound to that template.
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
isBoundToConfigTemplate Boolean: isBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false.
networkId String: networkId path parameter. Network ID
organizationId String: organizationId path parameter. Organization ID
perPage Number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 100000. Default is 1000.
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
tags List<String>: tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).
tagsFilterType String: tagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

Supporting Types

GetNetworksItem

EnrollmentString string: Enrollment string for the network
Id string: Network ID
IsBoundToConfigTemplate bool: If the network is bound to a config template
Name string: Network name
Notes string: Notes for the network
OrganizationId string: Organization ID
ProductTypes List<string>: List of the product types that the network supports
Tags List<string>: Network tags
TimeZone string: Timezone of the network
Url string: URL to the network Dashboard UI

EnrollmentString string: Enrollment string for the network
Id string: Network ID
IsBoundToConfigTemplate bool: If the network is bound to a config template
Name string: Network name
Notes string: Notes for the network
OrganizationId string: Organization ID
ProductTypes []string: List of the product types that the network supports
Tags []string: Network tags
TimeZone string: Timezone of the network
Url string: URL to the network Dashboard UI

enrollmentString String: Enrollment string for the network
id String: Network ID
isBoundToConfigTemplate Boolean: If the network is bound to a config template
name String: Network name
notes String: Notes for the network
organizationId String: Organization ID
productTypes List<String>: List of the product types that the network supports
tags List<String>: Network tags
timeZone String: Timezone of the network
url String: URL to the network Dashboard UI

enrollmentString string: Enrollment string for the network
id string: Network ID
isBoundToConfigTemplate boolean: If the network is bound to a config template
name string: Network name
notes string: Notes for the network
organizationId string: Organization ID
productTypes string[]: List of the product types that the network supports
tags string[]: Network tags
timeZone string: Timezone of the network
url string: URL to the network Dashboard UI

enrollment_string str: Enrollment string for the network
id str: Network ID
is_bound_to_config_template bool: If the network is bound to a config template
name str: Network name
notes str: Notes for the network
organization_id str: Organization ID
product_types Sequence[str]: List of the product types that the network supports
tags Sequence[str]: Network tags
time_zone str: Timezone of the network
url str: URL to the network Dashboard UI

enrollmentString String: Enrollment string for the network
id String: Network ID
isBoundToConfigTemplate Boolean: If the network is bound to a config template
name String: Network name
notes String: Notes for the network
organizationId String: Organization ID
productTypes List<String>: List of the product types that the network supports
tags List<String>: Network tags
timeZone String: Timezone of the network
url String: URL to the network Dashboard UI

Package Details

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

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

pulumi/pulumi-meraki

meraki.getNetworks

On this page

On this page

Example Usage

Using getNetworks

getNetworks Result

Supporting Types

GetNetworksItem

Package Details

On this page

On this page