1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getAddressGroupList
Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi

scm.getAddressGroupList

Explore with Pulumi AI

Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi

Retrieves a listing of config items.

Example Usage

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

const example = scm.getAddressGroupList({
    folder: "Shared",
});
Copy
import pulumi
import pulumi_scm as scm

example = scm.get_address_group_list(folder="Shared")
Copy
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.GetAddressGroupList(ctx, &scm.GetAddressGroupListArgs{
			Folder: pulumi.StringRef("Shared"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

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

});
Copy
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.GetAddressGroupListArgs;
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.getAddressGroupList(GetAddressGroupListArgs.builder()
            .folder("Shared")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: scm:getAddressGroupList
      arguments:
        folder: Shared
Copy

Using getAddressGroupList

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 getAddressGroupList(args: GetAddressGroupListArgs, opts?: InvokeOptions): Promise<GetAddressGroupListResult>
function getAddressGroupListOutput(args: GetAddressGroupListOutputArgs, opts?: InvokeOptions): Output<GetAddressGroupListResult>
Copy
def get_address_group_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) -> GetAddressGroupListResult
def get_address_group_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[GetAddressGroupListResult]
Copy
func GetAddressGroupList(ctx *Context, args *GetAddressGroupListArgs, opts ...InvokeOption) (*GetAddressGroupListResult, error)
func GetAddressGroupListOutput(ctx *Context, args *GetAddressGroupListOutputArgs, opts ...InvokeOption) GetAddressGroupListResultOutput
Copy

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

public static class GetAddressGroupList 
{
    public static Task<GetAddressGroupListResult> InvokeAsync(GetAddressGroupListArgs args, InvokeOptions? opts = null)
    public static Output<GetAddressGroupListResult> Invoke(GetAddressGroupListInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAddressGroupListResult> getAddressGroupList(GetAddressGroupListArgs args, InvokeOptions options)
public static Output<GetAddressGroupListResult> getAddressGroupList(GetAddressGroupListArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: scm:index/getAddressGroupList:getAddressGroupList
  arguments:
    # arguments dictionary
Copy

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.

getAddressGroupList Result

The following output properties are available:

Datas List<GetAddressGroupListData>
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 []GetAddressGroupListData
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<GetAddressGroupListData>
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 GetAddressGroupListData[]
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[GetAddressGroupListData]
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

GetAddressGroupListData

Description This property is required. string
The Description param. String length must not exceed 1023 characters.
DynamicValue This property is required. GetAddressGroupListDataDynamicValue
The DynamicValue param.
Id This property is required. string
UUID of the resource.
Name This property is required. string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
StaticLists This property is required. List<string>
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters.
Tags This property is required. List<string>
Tags for address group 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.
Description This property is required. string
The Description param. String length must not exceed 1023 characters.
DynamicValue This property is required. GetAddressGroupListDataDynamicValue
The DynamicValue param.
Id This property is required. string
UUID of the resource.
Name This property is required. string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
StaticLists This property is required. []string
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters.
Tags This property is required. []string
Tags for address group 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.
description This property is required. String
The Description param. String length must not exceed 1023 characters.
dynamicValue This property is required. GetAddressGroupListDataDynamicValue
The DynamicValue param.
id This property is required. String
UUID of the resource.
name This property is required. String
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
staticLists This property is required. List<String>
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters.
tags This property is required. List<String>
Tags for address group 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.
description This property is required. string
The Description param. String length must not exceed 1023 characters.
dynamicValue This property is required. GetAddressGroupListDataDynamicValue
The DynamicValue param.
id This property is required. string
UUID of the resource.
name This property is required. string
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
staticLists This property is required. string[]
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters.
tags This property is required. string[]
Tags for address group 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.
description This property is required. str
The Description param. String length must not exceed 1023 characters.
dynamic_value This property is required. GetAddressGroupListDataDynamicValue
The DynamicValue param.
id This property is required. str
UUID of the resource.
name This property is required. str
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
static_lists This property is required. Sequence[str]
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters.
tags This property is required. Sequence[str]
Tags for address group 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.
description This property is required. String
The Description param. String length must not exceed 1023 characters.
dynamicValue This property is required. Property Map
The DynamicValue param.
id This property is required. String
UUID of the resource.
name This property is required. String
Alphanumeric string [ 0-9a-zA-Z._-]. String length must not exceed 63 characters.
staticLists This property is required. List<String>
The StaticList param. Individual elements in this list are subject to additional validation. String length must not exceed 63 characters.
tags This property is required. List<String>
Tags for address group 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.

GetAddressGroupListDataDynamicValue

Filter This property is required. string
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.
Filter This property is required. string
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.
filter This property is required. String
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.
filter This property is required. string
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.
filter This property is required. str
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.
filter This property is required. String
Tag based filter defining group membership e.g. tag1 AND tag2 OR tag3. String length must not exceed 2047 characters.

Package Details

Repository
scm pulumi/pulumi-scm
License
Apache-2.0
Notes
This Pulumi package is based on the scm Terraform Provider.
Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi