Cisco Meraki v0.3.2, Sep 24 24

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

meraki.organizations.getPolicyObjectsGroups

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.getPolicyObjectsGroups({
    endingBefore: "string",
    organizationId: "string",
    perPage: 1,
    startingAfter: "string",
});
export const merakiOrganizationsPolicyObjectsGroupsExample = example.then(example => example.item);

import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.get_policy_objects_groups(ending_before="string",
    organization_id="string",
    per_page=1,
    starting_after="string")
pulumi.export("merakiOrganizationsPolicyObjectsGroupsExample", 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.LookupPolicyObjectsGroups(ctx, &organizations.LookupPolicyObjectsGroupsArgs{
			EndingBefore:   pulumi.StringRef("string"),
			OrganizationId: pulumi.StringRef("string"),
			PerPage:        pulumi.IntRef(1),
			StartingAfter:  pulumi.StringRef("string"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsPolicyObjectsGroupsExample", 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.GetPolicyObjectsGroups.Invoke(new()
    {
        EndingBefore = "string",
        OrganizationId = "string",
        PerPage = 1,
        StartingAfter = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsPolicyObjectsGroupsExample"] = example.Apply(getPolicyObjectsGroupsResult => getPolicyObjectsGroupsResult.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.GetPolicyObjectsGroupsArgs;
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.getPolicyObjectsGroups(GetPolicyObjectsGroupsArgs.builder()
            .endingBefore("string")
            .organizationId("string")
            .perPage(1)
            .startingAfter("string")
            .build());

        ctx.export("merakiOrganizationsPolicyObjectsGroupsExample", example.applyValue(getPolicyObjectsGroupsResult -> getPolicyObjectsGroupsResult.item()));
    }
}

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

Using getPolicyObjectsGroups

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 getPolicyObjectsGroups(args: GetPolicyObjectsGroupsArgs, opts?: InvokeOptions): Promise<GetPolicyObjectsGroupsResult>
function getPolicyObjectsGroupsOutput(args: GetPolicyObjectsGroupsOutputArgs, opts?: InvokeOptions): Output<GetPolicyObjectsGroupsResult>

def get_policy_objects_groups(ending_before: Optional[str] = None,
                              organization_id: Optional[str] = None,
                              per_page: Optional[int] = None,
                              policy_object_group_id: Optional[str] = None,
                              starting_after: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetPolicyObjectsGroupsResult
def get_policy_objects_groups_output(ending_before: Optional[pulumi.Input[str]] = None,
                              organization_id: Optional[pulumi.Input[str]] = None,
                              per_page: Optional[pulumi.Input[int]] = None,
                              policy_object_group_id: Optional[pulumi.Input[str]] = None,
                              starting_after: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetPolicyObjectsGroupsResult]

func LookupPolicyObjectsGroups(ctx *Context, args *LookupPolicyObjectsGroupsArgs, opts ...InvokeOption) (*LookupPolicyObjectsGroupsResult, error)
func LookupPolicyObjectsGroupsOutput(ctx *Context, args *LookupPolicyObjectsGroupsOutputArgs, opts ...InvokeOption) LookupPolicyObjectsGroupsResultOutput

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

public static class GetPolicyObjectsGroups 
{
    public static Task<GetPolicyObjectsGroupsResult> InvokeAsync(GetPolicyObjectsGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyObjectsGroupsResult> Invoke(GetPolicyObjectsGroupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPolicyObjectsGroupsResult> getPolicyObjectsGroups(GetPolicyObjectsGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: meraki:organizations/getPolicyObjectsGroups:getPolicyObjectsGroups
  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 1000. Default is 1000.
PolicyObjectGroupId string: policyObjectGroupId path parameter. Policy object group 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 1000. Default is 1000.
PolicyObjectGroupId string: policyObjectGroupId path parameter. Policy object group 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 1000. Default is 1000.
policyObjectGroupId String: policyObjectGroupId path parameter. Policy object group 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 1000. Default is 1000.
policyObjectGroupId string: policyObjectGroupId path parameter. Policy object group 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 1000. Default is 1000.
policy_object_group_id str: policyObjectGroupId path parameter. Policy object group 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 1000. Default is 1000.
policyObjectGroupId String: policyObjectGroupId path parameter. Policy object group 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.

getPolicyObjectsGroups Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Item GetPolicyObjectsGroupsItem
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 1000. Default is 1000.
PolicyObjectGroupId string: policyObjectGroupId path parameter. Policy object group 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 GetPolicyObjectsGroupsItem
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 1000. Default is 1000.
PolicyObjectGroupId string: policyObjectGroupId path parameter. Policy object group 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 GetPolicyObjectsGroupsItem
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 1000. Default is 1000.
policyObjectGroupId String: policyObjectGroupId path parameter. Policy object group 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 GetPolicyObjectsGroupsItem
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 1000. Default is 1000.
policyObjectGroupId string: policyObjectGroupId path parameter. Policy object group 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 GetPolicyObjectsGroupsItem
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 1000. Default is 1000.
policy_object_group_id str: policyObjectGroupId path parameter. Policy object group 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 1000. Default is 1000.
policyObjectGroupId String: policyObjectGroupId path parameter. Policy object group 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

GetPolicyObjectsGroupsItem

Category string: Type of object groups. (NetworkObjectGroup, GeoLocationGroup, PortObjectGroup, ApplicationGroup)
CreatedAt string: Time Stamp of policy object creation.
Id string: Policy object ID
Name string: Name of the Policy object group.
NetworkIds List<string>: Network ID's associated with the policy objects.
ObjectIds List<string>: Policy objects associated with Network Object Group or Port Object Group
UpdatedAt string: Time Stamp of policy object updation.

Category string: Type of object groups. (NetworkObjectGroup, GeoLocationGroup, PortObjectGroup, ApplicationGroup)
CreatedAt string: Time Stamp of policy object creation.
Id string: Policy object ID
Name string: Name of the Policy object group.
NetworkIds []string: Network ID's associated with the policy objects.
ObjectIds []string: Policy objects associated with Network Object Group or Port Object Group
UpdatedAt string: Time Stamp of policy object updation.

category String: Type of object groups. (NetworkObjectGroup, GeoLocationGroup, PortObjectGroup, ApplicationGroup)
createdAt String: Time Stamp of policy object creation.
id String: Policy object ID
name String: Name of the Policy object group.
networkIds List<String>: Network ID's associated with the policy objects.
objectIds List<String>: Policy objects associated with Network Object Group or Port Object Group
updatedAt String: Time Stamp of policy object updation.

category string: Type of object groups. (NetworkObjectGroup, GeoLocationGroup, PortObjectGroup, ApplicationGroup)
createdAt string: Time Stamp of policy object creation.
id string: Policy object ID
name string: Name of the Policy object group.
networkIds string[]: Network ID's associated with the policy objects.
objectIds string[]: Policy objects associated with Network Object Group or Port Object Group
updatedAt string: Time Stamp of policy object updation.

category str: Type of object groups. (NetworkObjectGroup, GeoLocationGroup, PortObjectGroup, ApplicationGroup)
created_at str: Time Stamp of policy object creation.
id str: Policy object ID
name str: Name of the Policy object group.
network_ids Sequence[str]: Network ID's associated with the policy objects.
object_ids Sequence[str]: Policy objects associated with Network Object Group or Port Object Group
updated_at str: Time Stamp of policy object updation.

category String: Type of object groups. (NetworkObjectGroup, GeoLocationGroup, PortObjectGroup, ApplicationGroup)
createdAt String: Time Stamp of policy object creation.
id String: Policy object ID
name String: Name of the Policy object group.
networkIds List<String>: Network ID's associated with the policy objects.
objectIds List<String>: Policy objects associated with Network Object Group or Port Object Group
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.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-meraki

meraki.organizations.getPolicyObjectsGroups

On this page

On this page

Example Usage

Using getPolicyObjectsGroups

getPolicyObjectsGroups Result

Supporting Types

GetPolicyObjectsGroupsItem

Package Details

On this page

On this page