Cisco Meraki v0.3.2, Sep 24 24

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

meraki.networks.getPoliciesByClient

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.networks.getPoliciesByClient({
    endingBefore: "string",
    networkId: "string",
    perPage: 1,
    startingAfter: "string",
    t0: "string",
    timespan: 1,
});
export const merakiNetworksPoliciesByClientExample = example.then(example => example.items);

import pulumi
import pulumi_meraki as meraki

example = meraki.networks.get_policies_by_client(ending_before="string",
    network_id="string",
    per_page=1,
    starting_after="string",
    t0="string",
    timespan=1)
pulumi.export("merakiNetworksPoliciesByClientExample", example.items)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networks.GetPoliciesByClient(ctx, &networks.GetPoliciesByClientArgs{
			EndingBefore:  pulumi.StringRef("string"),
			NetworkId:     "string",
			PerPage:       pulumi.IntRef(1),
			StartingAfter: pulumi.StringRef("string"),
			T0:            pulumi.StringRef("string"),
			Timespan:      pulumi.Float64Ref(1),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksPoliciesByClientExample", example.Items)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Networks.GetPoliciesByClient.Invoke(new()
    {
        EndingBefore = "string",
        NetworkId = "string",
        PerPage = 1,
        StartingAfter = "string",
        T0 = "string",
        Timespan = 1,
    });

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

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.NetworksFunctions;
import com.pulumi.meraki.networks.inputs.GetPoliciesByClientArgs;
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 = NetworksFunctions.getPoliciesByClient(GetPoliciesByClientArgs.builder()
            .endingBefore("string")
            .networkId("string")
            .perPage(1)
            .startingAfter("string")
            .t0("string")
            .timespan(1)
            .build());

        ctx.export("merakiNetworksPoliciesByClientExample", example.applyValue(getPoliciesByClientResult -> getPoliciesByClientResult.items()));
    }
}

variables:
  example:
    fn::invoke:
      Function: meraki:networks:getPoliciesByClient
      Arguments:
        endingBefore: string
        networkId: string
        perPage: 1
        startingAfter: string
        t0: string
        timespan: 1
outputs:
  merakiNetworksPoliciesByClientExample: ${example.items}

Using getPoliciesByClient

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 getPoliciesByClient(args: GetPoliciesByClientArgs, opts?: InvokeOptions): Promise<GetPoliciesByClientResult>
function getPoliciesByClientOutput(args: GetPoliciesByClientOutputArgs, opts?: InvokeOptions): Output<GetPoliciesByClientResult>

def get_policies_by_client(ending_before: Optional[str] = None,
                           network_id: Optional[str] = None,
                           per_page: Optional[int] = None,
                           starting_after: Optional[str] = None,
                           t0: Optional[str] = None,
                           timespan: Optional[float] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPoliciesByClientResult
def get_policies_by_client_output(ending_before: Optional[pulumi.Input[str]] = None,
                           network_id: Optional[pulumi.Input[str]] = None,
                           per_page: Optional[pulumi.Input[int]] = None,
                           starting_after: Optional[pulumi.Input[str]] = None,
                           t0: Optional[pulumi.Input[str]] = None,
                           timespan: Optional[pulumi.Input[float]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPoliciesByClientResult]

func GetPoliciesByClient(ctx *Context, args *GetPoliciesByClientArgs, opts ...InvokeOption) (*GetPoliciesByClientResult, error)
func GetPoliciesByClientOutput(ctx *Context, args *GetPoliciesByClientOutputArgs, opts ...InvokeOption) GetPoliciesByClientResultOutput

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

public static class GetPoliciesByClient 
{
    public static Task<GetPoliciesByClientResult> InvokeAsync(GetPoliciesByClientArgs args, InvokeOptions? opts = null)
    public static Output<GetPoliciesByClientResult> Invoke(GetPoliciesByClientInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPoliciesByClientResult> getPoliciesByClient(GetPoliciesByClientArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: meraki:networks/getPoliciesByClient:getPoliciesByClient
  arguments:
    # arguments dictionary

The following arguments are supported:

NetworkId string: networkId path parameter. Network 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 1000. Default is 50.
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.
T0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
Timespan double: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

NetworkId string: networkId path parameter. Network 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 1000. Default is 50.
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.
T0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
Timespan float64: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

networkId String: networkId path parameter. Network 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 1000. Default is 50.
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.
t0 String: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
timespan Double: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

networkId string: networkId path parameter. Network 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 1000. Default is 50.
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.
t0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
timespan number: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

network_id str: networkId path parameter. Network 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 1000. Default is 50.
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.
t0 str: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
timespan float: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

networkId String: networkId path parameter. Network 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 1000. Default is 50.
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.
t0 String: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
timespan Number: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

getPoliciesByClient Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Items List<GetPoliciesByClientItem>: Array of ResponseNetworksGetNetworkPoliciesByClient
NetworkId string: networkId path parameter. Network 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 1000. Default is 50.
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.
T0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
Timespan double: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

Id string: The provider-assigned unique ID for this managed resource.
Items []GetPoliciesByClientItem: Array of ResponseNetworksGetNetworkPoliciesByClient
NetworkId string: networkId path parameter. Network 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 1000. Default is 50.
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.
T0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
Timespan float64: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

id String: The provider-assigned unique ID for this managed resource.
items List<GetPoliciesByClientItem>: Array of ResponseNetworksGetNetworkPoliciesByClient
networkId String: networkId path parameter. Network 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 1000. Default is 50.
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.
t0 String: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
timespan Double: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

id string: The provider-assigned unique ID for this managed resource.
items GetPoliciesByClientItem[]: Array of ResponseNetworksGetNetworkPoliciesByClient
networkId string: networkId path parameter. Network 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 1000. Default is 50.
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.
t0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
timespan number: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

id str: The provider-assigned unique ID for this managed resource.
items Sequence[GetPoliciesByClientItem]: Array of ResponseNetworksGetNetworkPoliciesByClient
network_id str: networkId path parameter. Network 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 1000. Default is 50.
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.
t0 str: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
timespan float: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

id String: The provider-assigned unique ID for this managed resource.
items List<Property Map>: Array of ResponseNetworksGetNetworkPoliciesByClient
networkId String: networkId path parameter. Network 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 1000. Default is 50.
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.
t0 String: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
timespan Number: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

Supporting Types

GetPoliciesByClientItem

Assigneds List<GetPoliciesByClientItemAssigned>: Assigned policies
ClientId string: ID of client
Name string: Name of client

Assigneds []GetPoliciesByClientItemAssigned: Assigned policies
ClientId string: ID of client
Name string: Name of client

assigneds List<GetPoliciesByClientItemAssigned>: Assigned policies
clientId String: ID of client
name String: Name of client

assigneds GetPoliciesByClientItemAssigned[]: Assigned policies
clientId string: ID of client
name string: Name of client

assigneds Sequence[GetPoliciesByClientItemAssigned]: Assigned policies
client_id str: ID of client
name str: Name of client

assigneds List<Property Map>: Assigned policies
clientId String: ID of client
name String: Name of client

GetPoliciesByClientItemAssigned

GroupPolicyId string: id of policy
Name string: name of policy
Ssids List<GetPoliciesByClientItemAssignedSsid>: ssid
Type string: type of policy

GroupPolicyId string: id of policy
Name string: name of policy
Ssids []GetPoliciesByClientItemAssignedSsid: ssid
Type string: type of policy

groupPolicyId String: id of policy
name String: name of policy
ssids List<GetPoliciesByClientItemAssignedSsid>: ssid
type String: type of policy

groupPolicyId string: id of policy
name string: name of policy
ssids GetPoliciesByClientItemAssignedSsid[]: ssid
type string: type of policy

group_policy_id str: id of policy
name str: name of policy
ssids Sequence[GetPoliciesByClientItemAssignedSsid]: ssid
type str: type of policy

groupPolicyId String: id of policy
name String: name of policy
ssids List<Property Map>: ssid
type String: type of policy

GetPoliciesByClientItemAssignedSsid

SsidNumber int: number of ssid

SsidNumber int: number of ssid

ssidNumber Integer: number of ssid

ssidNumber number: number of ssid

ssid_number int: number of ssid

ssidNumber Number: number of ssid

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.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-meraki

meraki.networks.getPoliciesByClient

On this page

On this page

Example Usage

Using getPoliciesByClient

getPoliciesByClient Result

Supporting Types

GetPoliciesByClientItem

GetPoliciesByClientItemAssigned

GetPoliciesByClientItemAssignedSsid

Package Details

On this page

On this page