Cisco Meraki v0.2.4, Jun 14 24

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

meraki.organizations.getPolicyObjects

Explore with Pulumi AI

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

Example Usage

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

const example = meraki.organizations.getPolicyObjects({
    endingBefore: "string",
    organizationId: "string",
    perPage: 1,
    startingAfter: "string",
});
export const merakiOrganizationsPolicyObjectsExample = example.then(example => example.item);

import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.get_policy_objects(ending_before="string",
    organization_id="string",
    per_page=1,
    starting_after="string")
pulumi.export("merakiOrganizationsPolicyObjectsExample", example.item)

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.LookupPolicyObjects(ctx, &organizations.LookupPolicyObjectsArgs{
			EndingBefore:   pulumi.StringRef("string"),
			OrganizationId: pulumi.StringRef("string"),
			PerPage:        pulumi.IntRef(1),
			StartingAfter:  pulumi.StringRef("string"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsPolicyObjectsExample", example.Item)
		return nil
	})
}

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

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

    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsPolicyObjectsExample"] = example.Apply(getPolicyObjectsResult => getPolicyObjectsResult.Item),
    };
});

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.GetPolicyObjectsArgs;
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.getPolicyObjects(GetPolicyObjectsArgs.builder()
            .endingBefore("string")
            .organizationId("string")
            .perPage(1)
            .startingAfter("string")
            .build());

        ctx.export("merakiOrganizationsPolicyObjectsExample", example.applyValue(getPolicyObjectsResult -> getPolicyObjectsResult.item()));
    }
}

variables:
  example:
    fn::invoke:
      Function: meraki:organizations:getPolicyObjects
      Arguments:
        endingBefore: string
        organizationId: string
        perPage: 1
        startingAfter: string
outputs:
  merakiOrganizationsPolicyObjectsExample: ${example.item}

Using getPolicyObjects

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 getPolicyObjects(args: GetPolicyObjectsArgs, opts?: InvokeOptions): Promise<GetPolicyObjectsResult>
function getPolicyObjectsOutput(args: GetPolicyObjectsOutputArgs, opts?: InvokeOptions): Output<GetPolicyObjectsResult>

def get_policy_objects(ending_before: Optional[str] = None,
                       organization_id: Optional[str] = None,
                       per_page: Optional[int] = None,
                       policy_object_id: Optional[str] = None,
                       starting_after: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPolicyObjectsResult
def get_policy_objects_output(ending_before: Optional[pulumi.Input[str]] = None,
                       organization_id: Optional[pulumi.Input[str]] = None,
                       per_page: Optional[pulumi.Input[int]] = None,
                       policy_object_id: Optional[pulumi.Input[str]] = None,
                       starting_after: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPolicyObjectsResult]

func LookupPolicyObjects(ctx *Context, args *LookupPolicyObjectsArgs, opts ...InvokeOption) (*LookupPolicyObjectsResult, error)
func LookupPolicyObjectsOutput(ctx *Context, args *LookupPolicyObjectsOutputArgs, opts ...InvokeOption) LookupPolicyObjectsResultOutput

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

public static class GetPolicyObjects 
{
    public static Task<GetPolicyObjectsResult> InvokeAsync(GetPolicyObjectsArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyObjectsResult> Invoke(GetPolicyObjectsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPolicyObjectsResult> getPolicyObjects(GetPolicyObjectsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

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

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

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

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

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

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

getPolicyObjects Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Item GetPolicyObjectsItem
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.
OrganizationId string: organizationId path parameter. Organization ID
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 10 5000. Default is 5000.
PolicyObjectId string: policyObjectId path parameter. Policy object ID
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.
Item GetPolicyObjectsItem
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.
OrganizationId string: organizationId path parameter. Organization ID
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 10 5000. Default is 5000.
PolicyObjectId string: policyObjectId path parameter. Policy object ID
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.
item GetPolicyObjectsItem
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.
organizationId String: organizationId path parameter. Organization ID
perPage Integer: perPage query parameter. The number of entries per page returned. Acceptable range is 10 5000. Default is 5000.
policyObjectId String: policyObjectId path parameter. Policy object ID
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.
item GetPolicyObjectsItem
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.
organizationId string: organizationId path parameter. Organization ID
perPage number: perPage query parameter. The number of entries per page returned. Acceptable range is 10 5000. Default is 5000.
policyObjectId string: policyObjectId path parameter. Policy object ID
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.
item GetPolicyObjectsItem
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.
organization_id str: organizationId path parameter. Organization ID
per_page int: perPage query parameter. The number of entries per page returned. Acceptable range is 10 5000. Default is 5000.
policy_object_id str: policyObjectId path parameter. Policy object ID
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.
item Property Map
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.
organizationId String: organizationId path parameter. Organization ID
perPage Number: perPage query parameter. The number of entries per page returned. Acceptable range is 10 5000. Default is 5000.
policyObjectId String: policyObjectId path parameter. Policy object ID
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.

Supporting Types

GetPolicyObjectsItem

Category string: Category of a policy object (one of: adaptivePolicy, network)
Cidr string: CIDR Value of a policy object
CreatedAt string: Time Stamp of policy object creation.
GroupIds List<string>: The IDs of policy object groups the policy object belongs to.
Id string: Policy object ID
Name string: Name of policy object (alphanumeric, space, dash, or underscore characters only).
NetworkIds List<string>: The IDs of the networks that use the policy object.
Type string: Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
UpdatedAt string: Time Stamp of policy object updation.

Category string: Category of a policy object (one of: adaptivePolicy, network)
Cidr string: CIDR Value of a policy object
CreatedAt string: Time Stamp of policy object creation.
GroupIds []string: The IDs of policy object groups the policy object belongs to.
Id string: Policy object ID
Name string: Name of policy object (alphanumeric, space, dash, or underscore characters only).
NetworkIds []string: The IDs of the networks that use the policy object.
Type string: Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
UpdatedAt string: Time Stamp of policy object updation.

category String: Category of a policy object (one of: adaptivePolicy, network)
cidr String: CIDR Value of a policy object
createdAt String: Time Stamp of policy object creation.
groupIds List<String>: The IDs of policy object groups the policy object belongs to.
id String: Policy object ID
name String: Name of policy object (alphanumeric, space, dash, or underscore characters only).
networkIds List<String>: The IDs of the networks that use the policy object.
type String: Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
updatedAt String: Time Stamp of policy object updation.

category string: Category of a policy object (one of: adaptivePolicy, network)
cidr string: CIDR Value of a policy object
createdAt string: Time Stamp of policy object creation.
groupIds string[]: The IDs of policy object groups the policy object belongs to.
id string: Policy object ID
name string: Name of policy object (alphanumeric, space, dash, or underscore characters only).
networkIds string[]: The IDs of the networks that use the policy object.
type string: Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
updatedAt string: Time Stamp of policy object updation.

category str: Category of a policy object (one of: adaptivePolicy, network)
cidr str: CIDR Value of a policy object
created_at str: Time Stamp of policy object creation.
group_ids Sequence[str]: The IDs of policy object groups the policy object belongs to.
id str: Policy object ID
name str: Name of policy object (alphanumeric, space, dash, or underscore characters only).
network_ids Sequence[str]: The IDs of the networks that use the policy object.
type str: Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
updated_at str: Time Stamp of policy object updation.

category String: Category of a policy object (one of: adaptivePolicy, network)
cidr String: CIDR Value of a policy object
createdAt String: Time Stamp of policy object creation.
groupIds List<String>: The IDs of policy object groups the policy object belongs to.
id String: Policy object ID
name String: Name of policy object (alphanumeric, space, dash, or underscore characters only).
networkIds List<String>: The IDs of the networks that use the policy object.
type String: Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask)
updatedAt String: Time Stamp of policy object updation.

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.organizations.getPolicyObjects

On this page

On this page

Example Usage

Using getPolicyObjects

getPolicyObjects Result

Supporting Types

GetPolicyObjectsItem

Package Details

On this page

On this page