1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. vpc
  5. getIpamIpams
Alibaba Cloud v3.88.1 published on Saturday, Nov 8, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

alicloud.vpc.getIpamIpams

alicloud logo
Alibaba Cloud v3.88.1 published on Saturday, Nov 8, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

    This data source provides Vpc Ipam Ipam available to the user.What is Ipam

    NOTE: Available since v1.241.0.

    Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = alicloud.resourcemanager.getResourceGroups({});
const defaultIpamIpam = new alicloud.vpc.IpamIpam("default", {
    ipamDescription: "This is my first Ipam.",
    ipamName: name,
    operatingRegionLists: ["cn-hangzhou"],
});
const defaultGetIpamIpams = pulumi.all([defaultIpamIpam.id, defaultIpamIpam.ipamName]).apply(([id, ipamName]) => alicloud.vpc.getIpamIpamsOutput({
    ids: [id],
    nameRegex: ipamName,
    ipamName: name,
}));
export const alicloudVpcIpamIpamExampleId = defaultGetIpamIpams.apply(defaultGetIpamIpams => defaultGetIpamIpams.ipams?.[0]?.id);

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.resourcemanager.get_resource_groups()
default_ipam_ipam = alicloud.vpc.IpamIpam("default",
    ipam_description="This is my first Ipam.",
    ipam_name=name,
    operating_region_lists=["cn-hangzhou"])
default_get_ipam_ipams = pulumi.Output.all(
    id=default_ipam_ipam.id,
    ipam_name=default_ipam_ipam.ipam_name
).apply(lambda resolved_outputs: alicloud.vpc.get_ipam_ipams_output(ids=[resolved_outputs['id']],
    name_regex=resolved_outputs['ipam_name'],
    ipam_name=name))

pulumi.export("alicloudVpcIpamIpamExampleId", default_get_ipam_ipams.ipams[0].id)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{}, nil)
		if err != nil {
			return err
		}
		defaultIpamIpam, err := vpc.NewIpamIpam(ctx, "default", &vpc.IpamIpamArgs{
			IpamDescription: pulumi.String("This is my first Ipam."),
			IpamName:        pulumi.String(name),
			OperatingRegionLists: pulumi.StringArray{
				pulumi.String("cn-hangzhou"),
			},
		})
		if err != nil {
			return err
		}
		defaultGetIpamIpams := pulumi.All(defaultIpamIpam.ID(), defaultIpamIpam.IpamName).ApplyT(func(_args []interface{}) (vpc.GetIpamIpamsResult, error) {
			id := _args[0].(string)
			ipamName := _args[1].(*string)
			return vpc.GetIpamIpamsResult(interface{}(vpc.GetIpamIpamsOutput(ctx, vpc.GetIpamIpamsOutputArgs{
				Ids: []string{
					id,
				},
				NameRegex: ipamName,
				IpamName:  name,
			}, nil))), nil
		}).(vpc.GetIpamIpamsResultOutput)
		ctx.Export("alicloudVpcIpamIpamExampleId", defaultGetIpamIpams.ApplyT(func(defaultGetIpamIpams vpc.GetIpamIpamsResult) (*string, error) {
			return &defaultGetIpamIpams.Ipams[0].Id, nil
		}).(pulumi.StringPtrOutput))
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();

    var defaultIpamIpam = new AliCloud.Vpc.IpamIpam("default", new()
    {
        IpamDescription = "This is my first Ipam.",
        IpamName = name,
        OperatingRegionLists = new[]
        {
            "cn-hangzhou",
        },
    });

    var defaultGetIpamIpams = AliCloud.Vpc.GetIpamIpams.Invoke(new()
    {
        Ids = new[]
        {
            defaultIpamIpam.Id,
        },
        NameRegex = defaultIpamIpam.IpamName,
        IpamName = name,
    });

    return new Dictionary<string, object?>
    {
        ["alicloudVpcIpamIpamExampleId"] = defaultGetIpamIpams.Apply(getIpamIpamsResult => getIpamIpamsResult.Ipams[0]?.Id),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.vpc.IpamIpam;
import com.pulumi.alicloud.vpc.IpamIpamArgs;
import com.pulumi.alicloud.vpc.VpcFunctions;
import com.pulumi.alicloud.vpc.inputs.GetIpamIpamsArgs;
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 config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        final var default = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
            .build());

        var defaultIpamIpam = new IpamIpam("defaultIpamIpam", IpamIpamArgs.builder()
            .ipamDescription("This is my first Ipam.")
            .ipamName(name)
            .operatingRegionLists("cn-hangzhou")
            .build());

        final var defaultGetIpamIpams = Output.tuple(defaultIpamIpam.id(), defaultIpamIpam.ipamName()).applyValue(values -> {
            var id = values.t1;
            var ipamName = values.t2;
            return VpcFunctions.getIpamIpams(GetIpamIpamsArgs.builder()
                .ids(id)
                .nameRegex(ipamName)
                .ipamName(name)
                .build());
        });

        ctx.export("alicloudVpcIpamIpamExampleId", defaultGetIpamIpams.applyValue(_defaultGetIpamIpams -> _defaultGetIpamIpams.ipams()[0].id()));
    }
}

    configuration:
  name:
    type: string
    default: terraform-example
resources:
  defaultIpamIpam:
    type: alicloud:vpc:IpamIpam
    name: default
    properties:
      ipamDescription: This is my first Ipam.
      ipamName: ${name}
      operatingRegionLists:
        - cn-hangzhou
variables:
  default:
    fn::invoke:
      function: alicloud:resourcemanager:getResourceGroups
      arguments: {}
  defaultGetIpamIpams:
    fn::invoke:
      function: alicloud:vpc:getIpamIpams
      arguments:
        ids:
          - ${defaultIpamIpam.id}
        nameRegex: ${defaultIpamIpam.ipamName}
        ipamName: ${name}
outputs:
  alicloudVpcIpamIpamExampleId: ${defaultGetIpamIpams.ipams[0].id}

    Using getIpamIpams

    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 getIpamIpams(args: GetIpamIpamsArgs, opts?: InvokeOptions): Promise<GetIpamIpamsResult>
function getIpamIpamsOutput(args: GetIpamIpamsOutputArgs, opts?: InvokeOptions): Output<GetIpamIpamsResult>
    def get_ipam_ipams(ids: Optional[Sequence[str]] = None,
                   ipam_id: Optional[str] = None,
                   ipam_name: Optional[str] = None,
                   name_regex: Optional[str] = None,
                   output_file: Optional[str] = None,
                   resource_group_id: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetIpamIpamsResult
def get_ipam_ipams_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   ipam_id: Optional[pulumi.Input[str]] = None,
                   ipam_name: Optional[pulumi.Input[str]] = None,
                   name_regex: Optional[pulumi.Input[str]] = None,
                   output_file: Optional[pulumi.Input[str]] = None,
                   resource_group_id: Optional[pulumi.Input[str]] = None,
                   tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetIpamIpamsResult]
    func GetIpamIpams(ctx *Context, args *GetIpamIpamsArgs, opts ...InvokeOption) (*GetIpamIpamsResult, error)
func GetIpamIpamsOutput(ctx *Context, args *GetIpamIpamsOutputArgs, opts ...InvokeOption) GetIpamIpamsResultOutput

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

    public static class GetIpamIpams 
{
    public static Task<GetIpamIpamsResult> InvokeAsync(GetIpamIpamsArgs args, InvokeOptions? opts = null)
    public static Output<GetIpamIpamsResult> Invoke(GetIpamIpamsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIpamIpamsResult> getIpamIpams(GetIpamIpamsArgs args, InvokeOptions options)
public static Output<GetIpamIpamsResult> getIpamIpams(GetIpamIpamsArgs args, InvokeOptions options)

    fn::invoke:
  function: alicloud:vpc/getIpamIpams:getIpamIpams
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of Ipam IDs.
    IpamId string
    The first ID of the resource.
    IpamName string
    The name of the resource.
    NameRegex string
    A regex string to filter results by Group Metric Rule name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    ResourceGroupId string
    The ID of the resource group.
    Tags Dictionary<string, string>
    The tag of the resource.
    Ids []string
    A list of Ipam IDs.
    IpamId string
    The first ID of the resource.
    IpamName string
    The name of the resource.
    NameRegex string
    A regex string to filter results by Group Metric Rule name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    ResourceGroupId string
    The ID of the resource group.
    Tags map[string]string
    The tag of the resource.
    ids List<String>
    A list of Ipam IDs.
    ipamId String
    The first ID of the resource.
    ipamName String
    The name of the resource.
    nameRegex String
    A regex string to filter results by Group Metric Rule name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    resourceGroupId String
    The ID of the resource group.
    tags Map<String,String>
    The tag of the resource.
    ids string[]
    A list of Ipam IDs.
    ipamId string
    The first ID of the resource.
    ipamName string
    The name of the resource.
    nameRegex string
    A regex string to filter results by Group Metric Rule name.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    resourceGroupId string
    The ID of the resource group.
    tags {[key: string]: string}
    The tag of the resource.
    ids Sequence[str]
    A list of Ipam IDs.
    ipam_id str
    The first ID of the resource.
    ipam_name str
    The name of the resource.
    name_regex str
    A regex string to filter results by Group Metric Rule name.
    output_file str
    File name where to save data source results (after running pulumi preview).
    resource_group_id str
    The ID of the resource group.
    tags Mapping[str, str]
    The tag of the resource.
    ids List<String>
    A list of Ipam IDs.
    ipamId String
    The first ID of the resource.
    ipamName String
    The name of the resource.
    nameRegex String
    A regex string to filter results by Group Metric Rule name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    resourceGroupId String
    The ID of the resource group.
    tags Map<String>
    The tag of the resource.

    getIpamIpams Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    A list of Ipam IDs.
    Ipams List<Pulumi.AliCloud.Vpc.Outputs.GetIpamIpamsIpam>
    A list of Ipam Entries. Each element contains the following attributes:
    Names List<string>
    A list of name of Ipams.
    IpamId string
    The first ID of the resource.
    IpamName string
    The name of the resource.
    NameRegex string
    OutputFile string
    ResourceGroupId string
    The ID of the resource group.
    Tags Dictionary<string, string>
    The tag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    A list of Ipam IDs.
    Ipams []GetIpamIpamsIpam
    A list of Ipam Entries. Each element contains the following attributes:
    Names []string
    A list of name of Ipams.
    IpamId string
    The first ID of the resource.
    IpamName string
    The name of the resource.
    NameRegex string
    OutputFile string
    ResourceGroupId string
    The ID of the resource group.
    Tags map[string]string
    The tag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of Ipam IDs.
    ipams List<GetIpamIpamsIpam>
    A list of Ipam Entries. Each element contains the following attributes:
    names List<String>
    A list of name of Ipams.
    ipamId String
    The first ID of the resource.
    ipamName String
    The name of the resource.
    nameRegex String
    outputFile String
    resourceGroupId String
    The ID of the resource group.
    tags Map<String,String>
    The tag of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    A list of Ipam IDs.
    ipams GetIpamIpamsIpam[]
    A list of Ipam Entries. Each element contains the following attributes:
    names string[]
    A list of name of Ipams.
    ipamId string
    The first ID of the resource.
    ipamName string
    The name of the resource.
    nameRegex string
    outputFile string
    resourceGroupId string
    The ID of the resource group.
    tags {[key: string]: string}
    The tag of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    A list of Ipam IDs.
    ipams Sequence[GetIpamIpamsIpam]
    A list of Ipam Entries. Each element contains the following attributes:
    names Sequence[str]
    A list of name of Ipams.
    ipam_id str
    The first ID of the resource.
    ipam_name str
    The name of the resource.
    name_regex str
    output_file str
    resource_group_id str
    The ID of the resource group.
    tags Mapping[str, str]
    The tag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of Ipam IDs.
    ipams List<Property Map>
    A list of Ipam Entries. Each element contains the following attributes:
    names List<String>
    A list of name of Ipams.
    ipamId String
    The first ID of the resource.
    ipamName String
    The name of the resource.
    nameRegex String
    outputFile String
    resourceGroupId String
    The ID of the resource group.
    tags Map<String>
    The tag of the resource.

    Supporting Types

    GetIpamIpamsIpam

    CreateTime string
    The creation time of the resource.
    DefaultResourceDiscoveryAssociationId string
    After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.
    DefaultResourceDiscoveryId string
    After IPAM is created, the system creates resource discovery by default.
    Id string
    The ID of the resource supplied above.
    IpamDescription string
    The description of IPAM.It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
    IpamId string
    The first ID of the resource.
    IpamName string
    The name of the resource.
    PrivateDefaultScopeId string
    After an IPAM is created, the scope of the private network IPAM created by the system by default.
    PublicDefaultScopeId string
    After an IPAM is created, the public network IPAM is created by default.
    RegionId string
    The region ID of the resource.
    ResourceDiscoveryAssociationCount int
    The number of resource discovery objects associated with IPAM.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    The status of the resource.
    Tags Dictionary<string, string>
    The tag of the resource.
    CreateTime string
    The creation time of the resource.
    DefaultResourceDiscoveryAssociationId string
    After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.
    DefaultResourceDiscoveryId string
    After IPAM is created, the system creates resource discovery by default.
    Id string
    The ID of the resource supplied above.
    IpamDescription string
    The description of IPAM.It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
    IpamId string
    The first ID of the resource.
    IpamName string
    The name of the resource.
    PrivateDefaultScopeId string
    After an IPAM is created, the scope of the private network IPAM created by the system by default.
    PublicDefaultScopeId string
    After an IPAM is created, the public network IPAM is created by default.
    RegionId string
    The region ID of the resource.
    ResourceDiscoveryAssociationCount int
    The number of resource discovery objects associated with IPAM.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    The status of the resource.
    Tags map[string]string
    The tag of the resource.
    createTime String
    The creation time of the resource.
    defaultResourceDiscoveryAssociationId String
    After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.
    defaultResourceDiscoveryId String
    After IPAM is created, the system creates resource discovery by default.
    id String
    The ID of the resource supplied above.
    ipamDescription String
    The description of IPAM.It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
    ipamId String
    The first ID of the resource.
    ipamName String
    The name of the resource.
    privateDefaultScopeId String
    After an IPAM is created, the scope of the private network IPAM created by the system by default.
    publicDefaultScopeId String
    After an IPAM is created, the public network IPAM is created by default.
    regionId String
    The region ID of the resource.
    resourceDiscoveryAssociationCount Integer
    The number of resource discovery objects associated with IPAM.
    resourceGroupId String
    The ID of the resource group.
    status String
    The status of the resource.
    tags Map<String,String>
    The tag of the resource.
    createTime string
    The creation time of the resource.
    defaultResourceDiscoveryAssociationId string
    After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.
    defaultResourceDiscoveryId string
    After IPAM is created, the system creates resource discovery by default.
    id string
    The ID of the resource supplied above.
    ipamDescription string
    The description of IPAM.It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
    ipamId string
    The first ID of the resource.
    ipamName string
    The name of the resource.
    privateDefaultScopeId string
    After an IPAM is created, the scope of the private network IPAM created by the system by default.
    publicDefaultScopeId string
    After an IPAM is created, the public network IPAM is created by default.
    regionId string
    The region ID of the resource.
    resourceDiscoveryAssociationCount number
    The number of resource discovery objects associated with IPAM.
    resourceGroupId string
    The ID of the resource group.
    status string
    The status of the resource.
    tags {[key: string]: string}
    The tag of the resource.
    create_time str
    The creation time of the resource.
    default_resource_discovery_association_id str
    After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.
    default_resource_discovery_id str
    After IPAM is created, the system creates resource discovery by default.
    id str
    The ID of the resource supplied above.
    ipam_description str
    The description of IPAM.It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
    ipam_id str
    The first ID of the resource.
    ipam_name str
    The name of the resource.
    private_default_scope_id str
    After an IPAM is created, the scope of the private network IPAM created by the system by default.
    public_default_scope_id str
    After an IPAM is created, the public network IPAM is created by default.
    region_id str
    The region ID of the resource.
    resource_discovery_association_count int
    The number of resource discovery objects associated with IPAM.
    resource_group_id str
    The ID of the resource group.
    status str
    The status of the resource.
    tags Mapping[str, str]
    The tag of the resource.
    createTime String
    The creation time of the resource.
    defaultResourceDiscoveryAssociationId String
    After an IPAM is created, the association between the resource discovery created by the system by default and the IPAM.
    defaultResourceDiscoveryId String
    After IPAM is created, the system creates resource discovery by default.
    id String
    The ID of the resource supplied above.
    ipamDescription String
    The description of IPAM.It must be 2 to 256 characters in length and must start with an uppercase letter or a Chinese character, but cannot start with 'http: // 'or 'https. If the description is not filled in, it is blank. The default value is blank.
    ipamId String
    The first ID of the resource.
    ipamName String
    The name of the resource.
    privateDefaultScopeId String
    After an IPAM is created, the scope of the private network IPAM created by the system by default.
    publicDefaultScopeId String
    After an IPAM is created, the public network IPAM is created by default.
    regionId String
    The region ID of the resource.
    resourceDiscoveryAssociationCount Number
    The number of resource discovery objects associated with IPAM.
    resourceGroupId String
    The ID of the resource group.
    status String
    The status of the resource.
    tags Map<String>
    The tag of the resource.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.88.1 published on Saturday, Nov 8, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-alicloud
      Meet Neo: Your AI Platform Teammate