1. Packages
  2. Nutanix
  3. API Docs
  4. getAddressGroups
Nutanix v0.6.0 published on Friday, Dec 13, 2024 by Piers Karsenbarg

nutanix.getAddressGroups

Explore with Pulumi AI

nutanix logo
Nutanix v0.6.0 published on Friday, Dec 13, 2024 by Piers Karsenbarg

    Provides a datasource to retrieve list of address groups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pulumi/nutanix";
    
    const addrGroups = nutanix.getAddressGroups({});
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    addr_groups = nutanix.get_address_groups()
    
    package main
    
    import (
    	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nutanix.GetAddressGroups(ctx, &nutanix.GetAddressGroupsArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nutanix = Pulumi.Nutanix;
    
    return await Deployment.RunAsync(() => 
    {
        var addrGroups = Nutanix.GetAddressGroups.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nutanix.NutanixFunctions;
    import com.pulumi.nutanix.inputs.GetAddressGroupsArgs;
    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 addrGroups = NutanixFunctions.getAddressGroups();
    
        }
    }
    
    variables:
      addrGroups:
        fn::invoke:
          function: nutanix:getAddressGroups
          arguments: {}
    

    Using getAddressGroups

    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 getAddressGroups(args: GetAddressGroupsArgs, opts?: InvokeOptions): Promise<GetAddressGroupsResult>
    function getAddressGroupsOutput(args: GetAddressGroupsOutputArgs, opts?: InvokeOptions): Output<GetAddressGroupsResult>
    def get_address_groups(metadatas: Optional[Sequence[GetAddressGroupsMetadata]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetAddressGroupsResult
    def get_address_groups_output(metadatas: Optional[pulumi.Input[Sequence[pulumi.Input[GetAddressGroupsMetadataArgs]]]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetAddressGroupsResult]
    func GetAddressGroups(ctx *Context, args *GetAddressGroupsArgs, opts ...InvokeOption) (*GetAddressGroupsResult, error)
    func GetAddressGroupsOutput(ctx *Context, args *GetAddressGroupsOutputArgs, opts ...InvokeOption) GetAddressGroupsResultOutput

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

    public static class GetAddressGroups 
    {
        public static Task<GetAddressGroupsResult> InvokeAsync(GetAddressGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetAddressGroupsResult> Invoke(GetAddressGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAddressGroupsResult> getAddressGroups(GetAddressGroupsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: nutanix:index/getAddressGroups:getAddressGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Metadatas []GetAddressGroupsMetadata
    • (Optional) Use metadata to specify filters
    metadatas List<GetAddressGroupsMetadata>
    • (Optional) Use metadata to specify filters
    metadatas GetAddressGroupsMetadata[]
    • (Optional) Use metadata to specify filters
    metadatas Sequence[GetAddressGroupsMetadata]
    • (Optional) Use metadata to specify filters
    metadatas List<Property Map>
    • (Optional) Use metadata to specify filters

    getAddressGroups Result

    The following output properties are available:

    Entities List<PiersKarsenbarg.Nutanix.Outputs.GetAddressGroupsEntity>
    • (ReadOnly) List of address groups
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadatas List<PiersKarsenbarg.Nutanix.Outputs.GetAddressGroupsMetadata>
    • (Optional) Use metadata to specify filters
    Entities []GetAddressGroupsEntity
    • (ReadOnly) List of address groups
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadatas []GetAddressGroupsMetadata
    • (Optional) Use metadata to specify filters
    entities List<GetAddressGroupsEntity>
    • (ReadOnly) List of address groups
    id String
    The provider-assigned unique ID for this managed resource.
    metadatas List<GetAddressGroupsMetadata>
    • (Optional) Use metadata to specify filters
    entities GetAddressGroupsEntity[]
    • (ReadOnly) List of address groups
    id string
    The provider-assigned unique ID for this managed resource.
    metadatas GetAddressGroupsMetadata[]
    • (Optional) Use metadata to specify filters
    entities Sequence[GetAddressGroupsEntity]
    • (ReadOnly) List of address groups
    id str
    The provider-assigned unique ID for this managed resource.
    metadatas Sequence[GetAddressGroupsMetadata]
    • (Optional) Use metadata to specify filters
    entities List<Property Map>
    • (ReadOnly) List of address groups
    id String
    The provider-assigned unique ID for this managed resource.
    metadatas List<Property Map>
    • (Optional) Use metadata to specify filters

    Supporting Types

    GetAddressGroupsEntity

    AddressGroups []GetAddressGroupsEntityAddressGroup
    Information about address_group
    AssociatedPoliciesLists []GetAddressGroupsEntityAssociatedPoliciesList
    List of associated policies to address group
    Uuid string
    • (ReadOnly) UUID of associated policy
    addressGroups List<GetAddressGroupsEntityAddressGroup>
    Information about address_group
    associatedPoliciesLists List<GetAddressGroupsEntityAssociatedPoliciesList>
    List of associated policies to address group
    uuid String
    • (ReadOnly) UUID of associated policy
    addressGroups GetAddressGroupsEntityAddressGroup[]
    Information about address_group
    associatedPoliciesLists GetAddressGroupsEntityAssociatedPoliciesList[]
    List of associated policies to address group
    uuid string
    • (ReadOnly) UUID of associated policy
    address_groups Sequence[GetAddressGroupsEntityAddressGroup]
    Information about address_group
    associated_policies_lists Sequence[GetAddressGroupsEntityAssociatedPoliciesList]
    List of associated policies to address group
    uuid str
    • (ReadOnly) UUID of associated policy
    addressGroups List<Property Map>
    Information about address_group
    associatedPoliciesLists List<Property Map>
    List of associated policies to address group
    uuid String
    • (ReadOnly) UUID of associated policy

    GetAddressGroupsEntityAddressGroup

    AddressGroupString string
    • (ReadOnly) Address Group string
    Description string
    • (ReadOnly) Description of the address group
    IpAddressBlockLists List<PiersKarsenbarg.Nutanix.Inputs.GetAddressGroupsEntityAddressGroupIpAddressBlockList>
    • (ReadOnly) list of IP address blocks with their prefix length
    Name string
    • (ReadOnly) Name of associated policy
    AddressGroupString string
    • (ReadOnly) Address Group string
    Description string
    • (ReadOnly) Description of the address group
    IpAddressBlockLists []GetAddressGroupsEntityAddressGroupIpAddressBlockList
    • (ReadOnly) list of IP address blocks with their prefix length
    Name string
    • (ReadOnly) Name of associated policy
    addressGroupString String
    • (ReadOnly) Address Group string
    description String
    • (ReadOnly) Description of the address group
    ipAddressBlockLists List<GetAddressGroupsEntityAddressGroupIpAddressBlockList>
    • (ReadOnly) list of IP address blocks with their prefix length
    name String
    • (ReadOnly) Name of associated policy
    addressGroupString string
    • (ReadOnly) Address Group string
    description string
    • (ReadOnly) Description of the address group
    ipAddressBlockLists GetAddressGroupsEntityAddressGroupIpAddressBlockList[]
    • (ReadOnly) list of IP address blocks with their prefix length
    name string
    • (ReadOnly) Name of associated policy
    address_group_string str
    • (ReadOnly) Address Group string
    description str
    • (ReadOnly) Description of the address group
    ip_address_block_lists Sequence[GetAddressGroupsEntityAddressGroupIpAddressBlockList]
    • (ReadOnly) list of IP address blocks with their prefix length
    name str
    • (ReadOnly) Name of associated policy
    addressGroupString String
    • (ReadOnly) Address Group string
    description String
    • (ReadOnly) Description of the address group
    ipAddressBlockLists List<Property Map>
    • (ReadOnly) list of IP address blocks with their prefix length
    name String
    • (ReadOnly) Name of associated policy

    GetAddressGroupsEntityAddressGroupIpAddressBlockList

    Ip string
    • (ReadOnly) IP of the address block
    PrefixLength int
    • (ReadOnly) Prefix length of address block in int
    Ip string
    • (ReadOnly) IP of the address block
    PrefixLength int
    • (ReadOnly) Prefix length of address block in int
    ip String
    • (ReadOnly) IP of the address block
    prefixLength Integer
    • (ReadOnly) Prefix length of address block in int
    ip string
    • (ReadOnly) IP of the address block
    prefixLength number
    • (ReadOnly) Prefix length of address block in int
    ip str
    • (ReadOnly) IP of the address block
    prefix_length int
    • (ReadOnly) Prefix length of address block in int
    ip String
    • (ReadOnly) IP of the address block
    prefixLength Number
    • (ReadOnly) Prefix length of address block in int

    GetAddressGroupsEntityAssociatedPoliciesList

    Kind string
    Name string
    • (ReadOnly) Name of associated policy
    Uuid string
    • (ReadOnly) UUID of associated policy
    Kind string
    Name string
    • (ReadOnly) Name of associated policy
    Uuid string
    • (ReadOnly) UUID of associated policy
    kind String
    name String
    • (ReadOnly) Name of associated policy
    uuid String
    • (ReadOnly) UUID of associated policy
    kind string
    name string
    • (ReadOnly) Name of associated policy
    uuid string
    • (ReadOnly) UUID of associated policy
    kind str
    name str
    • (ReadOnly) Name of associated policy
    uuid str
    • (ReadOnly) UUID of associated policy
    kind String
    name String
    • (ReadOnly) Name of associated policy
    uuid String
    • (ReadOnly) UUID of associated policy

    GetAddressGroupsMetadata

    Filter string
    (Optional) Filter in FIQL Syntax
    Kind string
    Length int
    (Optional) Integer
    Offset int
    (Optional) Integer
    SortAttribute string
    (Optional) attribute to sort
    SortOrder string
    (Optional) order of sorting
    Filter string
    (Optional) Filter in FIQL Syntax
    Kind string
    Length int
    (Optional) Integer
    Offset int
    (Optional) Integer
    SortAttribute string
    (Optional) attribute to sort
    SortOrder string
    (Optional) order of sorting
    filter String
    (Optional) Filter in FIQL Syntax
    kind String
    length Integer
    (Optional) Integer
    offset Integer
    (Optional) Integer
    sortAttribute String
    (Optional) attribute to sort
    sortOrder String
    (Optional) order of sorting
    filter string
    (Optional) Filter in FIQL Syntax
    kind string
    length number
    (Optional) Integer
    offset number
    (Optional) Integer
    sortAttribute string
    (Optional) attribute to sort
    sortOrder string
    (Optional) order of sorting
    filter str
    (Optional) Filter in FIQL Syntax
    kind str
    length int
    (Optional) Integer
    offset int
    (Optional) Integer
    sort_attribute str
    (Optional) attribute to sort
    sort_order str
    (Optional) order of sorting
    filter String
    (Optional) Filter in FIQL Syntax
    kind String
    length Number
    (Optional) Integer
    offset Number
    (Optional) Integer
    sortAttribute String
    (Optional) attribute to sort
    sortOrder String
    (Optional) order of sorting

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.6.0 published on Friday, Dec 13, 2024 by Piers Karsenbarg