meraki.organizations.getSummaryTopNetworksByStatus

Explore with Pulumi AI

Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";

const example = meraki.organizations.getSummaryTopNetworksByStatus({
    endingBefore: "string",
    organizationId: "string",
    perPage: 1,
    startingAfter: "string",
});
export const merakiOrganizationsSummaryTopNetworksByStatusExample = example.then(example => example.items);

import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.get_summary_top_networks_by_status(ending_before="string",
    organization_id="string",
    per_page=1,
    starting_after="string")
pulumi.export("merakiOrganizationsSummaryTopNetworksByStatusExample", example.items)

package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := organizations.GetSummaryTopNetworksByStatus(ctx, &organizations.GetSummaryTopNetworksByStatusArgs{
			EndingBefore:   pulumi.StringRef("string"),
			OrganizationId: "string",
			PerPage:        pulumi.IntRef(1),
			StartingAfter:  pulumi.StringRef("string"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsSummaryTopNetworksByStatusExample", example.Items)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Organizations.GetSummaryTopNetworksByStatus.Invoke(new()
    {
        EndingBefore = "string",
        OrganizationId = "string",
        PerPage = 1,
        StartingAfter = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsSummaryTopNetworksByStatusExample"] = example.Apply(getSummaryTopNetworksByStatusResult => getSummaryTopNetworksByStatusResult.Items),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.organizations.OrganizationsFunctions;
import com.pulumi.meraki.organizations.inputs.GetSummaryTopNetworksByStatusArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = OrganizationsFunctions.getSummaryTopNetworksByStatus(GetSummaryTopNetworksByStatusArgs.builder()
            .endingBefore("string")
            .organizationId("string")
            .perPage(1)
            .startingAfter("string")
            .build());

        ctx.export("merakiOrganizationsSummaryTopNetworksByStatusExample", example.applyValue(getSummaryTopNetworksByStatusResult -> getSummaryTopNetworksByStatusResult.items()));
    }
}

variables:
  example:
    fn::invoke:
      Function: meraki:organizations:getSummaryTopNetworksByStatus
      Arguments:
        endingBefore: string
        organizationId: string
        perPage: 1
        startingAfter: string
outputs:
  merakiOrganizationsSummaryTopNetworksByStatusExample: ${example.items}

Using getSummaryTopNetworksByStatus

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 getSummaryTopNetworksByStatus(args: GetSummaryTopNetworksByStatusArgs, opts?: InvokeOptions): Promise<GetSummaryTopNetworksByStatusResult>
function getSummaryTopNetworksByStatusOutput(args: GetSummaryTopNetworksByStatusOutputArgs, opts?: InvokeOptions): Output<GetSummaryTopNetworksByStatusResult>

def get_summary_top_networks_by_status(ending_before: Optional[str] = None,
                                       organization_id: Optional[str] = None,
                                       per_page: Optional[int] = None,
                                       starting_after: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetSummaryTopNetworksByStatusResult
def get_summary_top_networks_by_status_output(ending_before: 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,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetSummaryTopNetworksByStatusResult]

func GetSummaryTopNetworksByStatus(ctx *Context, args *GetSummaryTopNetworksByStatusArgs, opts ...InvokeOption) (*GetSummaryTopNetworksByStatusResult, error)
func GetSummaryTopNetworksByStatusOutput(ctx *Context, args *GetSummaryTopNetworksByStatusOutputArgs, opts ...InvokeOption) GetSummaryTopNetworksByStatusResultOutput

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

public static class GetSummaryTopNetworksByStatus 
{
    public static Task<GetSummaryTopNetworksByStatusResult> InvokeAsync(GetSummaryTopNetworksByStatusArgs args, InvokeOptions? opts = null)
    public static Output<GetSummaryTopNetworksByStatusResult> Invoke(GetSummaryTopNetworksByStatusInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSummaryTopNetworksByStatusResult> getSummaryTopNetworksByStatus(GetSummaryTopNetworksByStatusArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: meraki:organizations/getSummaryTopNetworksByStatus:getSummaryTopNetworksByStatus
  arguments:
    # arguments dictionary

The following arguments are supported:

OrganizationId string: organizationId path parameter. Organization ID
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.
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.

OrganizationId string: organizationId path parameter. Organization ID
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.
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.

organizationId String: organizationId path parameter. Organization ID
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.
perPage Integer: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.

organizationId string: organizationId path parameter. Organization ID
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.
perPage number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.

organization_id str: organizationId path parameter. Organization ID
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.
per_page int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.

organizationId String: organizationId path parameter. Organization ID
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.
perPage Number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.

getSummaryTopNetworksByStatus Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Items List<GetSummaryTopNetworksByStatusItem>: Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
OrganizationId string: organizationId path parameter. Organization ID
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.
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.

Id string: The provider-assigned unique ID for this managed resource.
Items []GetSummaryTopNetworksByStatusItem: Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
OrganizationId string: organizationId path parameter. Organization ID
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.
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.

id String: The provider-assigned unique ID for this managed resource.
items List<GetSummaryTopNetworksByStatusItem>: Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
organizationId String: organizationId path parameter. Organization ID
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.
perPage Integer: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.

id string: The provider-assigned unique ID for this managed resource.
items GetSummaryTopNetworksByStatusItem[]: Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
organizationId string: organizationId path parameter. Organization ID
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.
perPage number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.

id str: The provider-assigned unique ID for this managed resource.
items Sequence[GetSummaryTopNetworksByStatusItem]: Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
organization_id str: organizationId path parameter. Organization ID
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.
per_page int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.

id String: The provider-assigned unique ID for this managed resource.
items List<Property Map>: Array of ResponseOrganizationsGetOrganizationSummaryTopNetworksByStatus
organizationId String: organizationId path parameter. Organization ID
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.
perPage Number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 5000.
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.