Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scm Provider
  3. API Docs
  4. getAddressObjectList
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

scm.getAddressObjectList

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

    Retrieves a listing of config items.

    Example Usage

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

const example = scm.getAddressObjectList({
    folder: "Shared",
});

    import pulumi
import pulumi_scm as scm

example = scm.get_address_object_list(folder="Shared")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scm.GetAddressObjectList(ctx, &scm.GetAddressObjectListArgs{
			Folder: pulumi.StringRef("Shared"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Scm.GetAddressObjectList.Invoke(new()
    {
        Folder = "Shared",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetAddressObjectListArgs;
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 = ScmFunctions.getAddressObjectList(GetAddressObjectListArgs.builder()
            .folder("Shared")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: scm:getAddressObjectList
      Arguments:
        folder: Shared

    Using getAddressObjectList

    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 getAddressObjectList(args: GetAddressObjectListArgs, opts?: InvokeOptions): Promise<GetAddressObjectListResult>
function getAddressObjectListOutput(args: GetAddressObjectListOutputArgs, opts?: InvokeOptions): Output<GetAddressObjectListResult>
    def get_address_object_list(device: Optional[str] = None,
                            folder: Optional[str] = None,
                            limit: Optional[int] = None,
                            name: Optional[str] = None,
                            offset: Optional[int] = None,
                            snippet: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAddressObjectListResult
def get_address_object_list_output(device: Optional[pulumi.Input[str]] = None,
                            folder: Optional[pulumi.Input[str]] = None,
                            limit: Optional[pulumi.Input[int]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            offset: Optional[pulumi.Input[int]] = None,
                            snippet: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetAddressObjectListResult]
    func GetAddressObjectList(ctx *Context, args *GetAddressObjectListArgs, opts ...InvokeOption) (*GetAddressObjectListResult, error)
func GetAddressObjectListOutput(ctx *Context, args *GetAddressObjectListOutputArgs, opts ...InvokeOption) GetAddressObjectListResultOutput

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

    public static class GetAddressObjectList 
{
    public static Task<GetAddressObjectListResult> InvokeAsync(GetAddressObjectListArgs args, InvokeOptions? opts = null)
    public static Output<GetAddressObjectListResult> Invoke(GetAddressObjectListInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAddressObjectListResult> getAddressObjectList(GetAddressObjectListArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: scm:index/getAddressObjectList:getAddressObjectList
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Device string
    The Device param.
    Folder string
    The Folder param.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Name string
    The Name param.
    Offset int
    The Offset param. Default: 0.
    Snippet string
    The Snippet param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Name string
    The Name param.
    Offset int
    The Offset param. Default: 0.
    Snippet string
    The Snippet param.
    device String
    The Device param.
    folder String
    The Folder param.
    limit Integer
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name String
    The Name param.
    offset Integer
    The Offset param. Default: 0.
    snippet String
    The Snippet param.
    device string
    The Device param.
    folder string
    The Folder param.
    limit number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name string
    The Name param.
    offset number
    The Offset param. Default: 0.
    snippet string
    The Snippet param.
    device str
    The Device param.
    folder str
    The Folder param.
    limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name str
    The Name param.
    offset int
    The Offset param. Default: 0.
    snippet str
    The Snippet param.
    device String
    The Device param.
    folder String
    The Folder param.
    limit Number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name String
    The Name param.
    offset Number
    The Offset param. Default: 0.
    snippet String
    The Snippet param.

    getAddressObjectList Result

    The following output properties are available:

    Datas List<GetAddressObjectListData>
    The Data param.
    Id string
    The provider-assigned unique ID for this managed resource.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Offset int
    The Offset param. Default: 0.
    Tfid string
    Total int
    The Total param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    Datas []GetAddressObjectListData
    The Data param.
    Id string
    The provider-assigned unique ID for this managed resource.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Offset int
    The Offset param. Default: 0.
    Tfid string
    Total int
    The Total param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    datas List<GetAddressObjectListData>
    The Data param.
    id String
    The provider-assigned unique ID for this managed resource.
    limit Integer
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset Integer
    The Offset param. Default: 0.
    tfid String
    total Integer
    The Total param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param.
    snippet String
    The Snippet param.
    datas GetAddressObjectListData[]
    The Data param.
    id string
    The provider-assigned unique ID for this managed resource.
    limit number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset number
    The Offset param. Default: 0.
    tfid string
    total number
    The Total param.
    device string
    The Device param.
    folder string
    The Folder param.
    name string
    The Name param.
    snippet string
    The Snippet param.
    datas Sequence[GetAddressObjectListData]
    The Data param.
    id str
    The provider-assigned unique ID for this managed resource.
    limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset int
    The Offset param. Default: 0.
    tfid str
    total int
    The Total param.
    device str
    The Device param.
    folder str
    The Folder param.
    name str
    The Name param.
    snippet str
    The Snippet param.
    datas List<Property Map>
    The Data param.
    id String
    The provider-assigned unique ID for this managed resource.
    limit Number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset Number
    The Offset param. Default: 0.
    tfid String
    total Number
    The Total param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param.
    snippet String
    The Snippet param.

    Supporting Types

    GetAddressObjectListData

    Description string
    The Description param. String length must not exceed 1023 characters.
    Fqdn string
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    Id string
    UUID of the resource.
    IpNetmask string
    The IpNetmask param.
    IpRange string
    The IpRange param.
    IpWildcard string
    The IpWildcard param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Tags List<string>
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    Type string
    The Type param.
    Description string
    The Description param. String length must not exceed 1023 characters.
    Fqdn string
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    Id string
    UUID of the resource.
    IpNetmask string
    The IpNetmask param.
    IpRange string
    The IpRange param.
    IpWildcard string
    The IpWildcard param.
    Name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Tags []string
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    Type string
    The Type param.
    description String
    The Description param. String length must not exceed 1023 characters.
    fqdn String
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    id String
    UUID of the resource.
    ipNetmask String
    The IpNetmask param.
    ipRange String
    The IpRange param.
    ipWildcard String
    The IpWildcard param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    tags List<String>
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    type String
    The Type param.
    description string
    The Description param. String length must not exceed 1023 characters.
    fqdn string
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    id string
    UUID of the resource.
    ipNetmask string
    The IpNetmask param.
    ipRange string
    The IpRange param.
    ipWildcard string
    The IpWildcard param.
    name string
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    tags string[]
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    type string
    The Type param.
    description str
    The Description param. String length must not exceed 1023 characters.
    fqdn str
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    id str
    UUID of the resource.
    ip_netmask str
    The IpNetmask param.
    ip_range str
    The IpRange param.
    ip_wildcard str
    The IpWildcard param.
    name str
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    tags Sequence[str]
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    type str
    The Type param.
    description String
    The Description param. String length must not exceed 1023 characters.
    fqdn String
    The Fqdn param. String length must be between 1 and 255 characters. String validation regex: ^a-zA-Z0-9_+[a-zA-Z0-9]$.
    id String
    UUID of the resource.
    ipNetmask String
    The IpNetmask param.
    ipRange String
    The IpRange param.
    ipWildcard String
    The IpWildcard param.
    name String
    Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
    tags List<String>
    Tags for address object. List must contain at most 64 elements. Individual elements in this list are subject to additional validation. String length must not exceed 127 characters.
    type String
    The Type param.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
    pulumi/pulumi-scm