1. Packages
  2. Prismacloud Provider
  3. API Docs
  4. getCollection
prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks

prismacloud.getCollection

Explore with Pulumi AI

prismacloud logo
prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks

    Retrieves information about a specific collection.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as prismacloud from "@pulumi/prismacloud";
    
    const example = prismacloud.getCollection({
        id: "collection_id",
    });
    
    import pulumi
    import pulumi_prismacloud as prismacloud
    
    example = prismacloud.get_collection(id="collection_id")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/prismacloud/prismacloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := prismacloud.LookupCollection(ctx, &prismacloud.LookupCollectionArgs{
    			Id: "collection_id",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Prismacloud = Pulumi.Prismacloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Prismacloud.GetCollection.Invoke(new()
        {
            Id = "collection_id",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.prismacloud.PrismacloudFunctions;
    import com.pulumi.prismacloud.inputs.GetCollectionArgs;
    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 = PrismacloudFunctions.getCollection(GetCollectionArgs.builder()
                .id("collection_id")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: prismacloud:getCollection
          arguments:
            id: collection_id
    

    Using getCollection

    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 getCollection(args: GetCollectionArgs, opts?: InvokeOptions): Promise<GetCollectionResult>
    function getCollectionOutput(args: GetCollectionOutputArgs, opts?: InvokeOptions): Output<GetCollectionResult>
    def get_collection(id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCollectionResult
    def get_collection_output(id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCollectionResult]
    func LookupCollection(ctx *Context, args *LookupCollectionArgs, opts ...InvokeOption) (*LookupCollectionResult, error)
    func LookupCollectionOutput(ctx *Context, args *LookupCollectionOutputArgs, opts ...InvokeOption) LookupCollectionResultOutput

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

    public static class GetCollection 
    {
        public static Task<GetCollectionResult> InvokeAsync(GetCollectionArgs args, InvokeOptions? opts = null)
        public static Output<GetCollectionResult> Invoke(GetCollectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCollectionResult> getCollection(GetCollectionArgs args, InvokeOptions options)
    public static Output<GetCollectionResult> getCollection(GetCollectionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: prismacloud:index/getCollection:getCollection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    ID of the collection.
    Id string
    ID of the collection.
    id String
    ID of the collection.
    id string
    ID of the collection.
    id str
    ID of the collection.
    id String
    ID of the collection.

    getCollection Result

    The following output properties are available:

    AssetGroups List<GetCollectionAssetGroup>
    List of asset groups contained within the collection as defined below
    CreatedBy string
    Created by.
    CreatedTs double
    The timestamp when the collection was created.
    Description string
    Description.
    Id string
    LastModifiedBy string
    Last modified by.
    LastModifiedTs double
    (int) Last modified timestamp.
    Name string
    The name of the collection.
    AssetGroups []GetCollectionAssetGroup
    List of asset groups contained within the collection as defined below
    CreatedBy string
    Created by.
    CreatedTs float64
    The timestamp when the collection was created.
    Description string
    Description.
    Id string
    LastModifiedBy string
    Last modified by.
    LastModifiedTs float64
    (int) Last modified timestamp.
    Name string
    The name of the collection.
    assetGroups List<GetCollectionAssetGroup>
    List of asset groups contained within the collection as defined below
    createdBy String
    Created by.
    createdTs Double
    The timestamp when the collection was created.
    description String
    Description.
    id String
    lastModifiedBy String
    Last modified by.
    lastModifiedTs Double
    (int) Last modified timestamp.
    name String
    The name of the collection.
    assetGroups GetCollectionAssetGroup[]
    List of asset groups contained within the collection as defined below
    createdBy string
    Created by.
    createdTs number
    The timestamp when the collection was created.
    description string
    Description.
    id string
    lastModifiedBy string
    Last modified by.
    lastModifiedTs number
    (int) Last modified timestamp.
    name string
    The name of the collection.
    asset_groups Sequence[GetCollectionAssetGroup]
    List of asset groups contained within the collection as defined below
    created_by str
    Created by.
    created_ts float
    The timestamp when the collection was created.
    description str
    Description.
    id str
    last_modified_by str
    Last modified by.
    last_modified_ts float
    (int) Last modified timestamp.
    name str
    The name of the collection.
    assetGroups List<Property Map>
    List of asset groups contained within the collection as defined below
    createdBy String
    Created by.
    createdTs Number
    The timestamp when the collection was created.
    description String
    Description.
    id String
    lastModifiedBy String
    Last modified by.
    lastModifiedTs Number
    (int) Last modified timestamp.
    name String
    The name of the collection.

    Supporting Types

    GetCollectionAssetGroup

    AccountGroupIds List<string>
    A list of account group IDs associated with the collection.
    AccountIds List<string>
    A list of cloud account IDs associated with the collection.
    RepositoryIds List<string>
    A list of repository IDs associated with the collection.
    AccountGroupIds []string
    A list of account group IDs associated with the collection.
    AccountIds []string
    A list of cloud account IDs associated with the collection.
    RepositoryIds []string
    A list of repository IDs associated with the collection.
    accountGroupIds List<String>
    A list of account group IDs associated with the collection.
    accountIds List<String>
    A list of cloud account IDs associated with the collection.
    repositoryIds List<String>
    A list of repository IDs associated with the collection.
    accountGroupIds string[]
    A list of account group IDs associated with the collection.
    accountIds string[]
    A list of cloud account IDs associated with the collection.
    repositoryIds string[]
    A list of repository IDs associated with the collection.
    account_group_ids Sequence[str]
    A list of account group IDs associated with the collection.
    account_ids Sequence[str]
    A list of cloud account IDs associated with the collection.
    repository_ids Sequence[str]
    A list of repository IDs associated with the collection.
    accountGroupIds List<String>
    A list of account group IDs associated with the collection.
    accountIds List<String>
    A list of cloud account IDs associated with the collection.
    repositoryIds List<String>
    A list of repository IDs associated with the collection.

    Package Details

    Repository
    prismacloud paloaltonetworks/terraform-provider-prismacloud
    License
    Notes
    This Pulumi package is based on the prismacloud Terraform Provider.
    prismacloud logo
    prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks