Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. network
  6. getIpamPoolUsage
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.25.0
published on Wednesday, Aug 5, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.network.getIpamPoolUsage

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.25.0
published on Wednesday, Aug 5, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    IpamPool usage information.

    Uses Azure REST API version 2024-05-01.

    Other available API versions: 2024-01-01-preview, 2024-07-01, 2024-10-01, 2025-01-01, 2025-03-01, 2025-05-01, 2025-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

    Using getIpamPoolUsage

    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 getIpamPoolUsage(args: GetIpamPoolUsageArgs, opts?: InvokeOptions): Promise<GetIpamPoolUsageResult>
function getIpamPoolUsageOutput(args: GetIpamPoolUsageOutputArgs, opts?: InvokeOptions): Output<GetIpamPoolUsageResult>
    def get_ipam_pool_usage(network_manager_name: Optional[str] = None,
                        pool_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetIpamPoolUsageResult
def get_ipam_pool_usage_output(network_manager_name: pulumi.Input[Optional[str]] = None,
                        pool_name: pulumi.Input[Optional[str]] = None,
                        resource_group_name: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetIpamPoolUsageResult]
    func GetIpamPoolUsage(ctx *Context, args *GetIpamPoolUsageArgs, opts ...InvokeOption) (*GetIpamPoolUsageResult, error)
func GetIpamPoolUsageOutput(ctx *Context, args *GetIpamPoolUsageOutputArgs, opts ...InvokeOption) GetIpamPoolUsageResultOutput

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

    public static class GetIpamPoolUsage 
{
    public static Task<GetIpamPoolUsageResult> InvokeAsync(GetIpamPoolUsageArgs args, InvokeOptions? opts = null)
    public static Output<GetIpamPoolUsageResult> Invoke(GetIpamPoolUsageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIpamPoolUsageResult> getIpamPoolUsage(GetIpamPoolUsageArgs args, InvokeOptions options)
public static Output<GetIpamPoolUsageResult> getIpamPoolUsage(GetIpamPoolUsageArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:network:getIpamPoolUsage
  arguments:
    # arguments dictionary
    data "azure-native_network_get_ipam_pool_usage" "name" {
    # arguments
}

    The following arguments are supported:

    NetworkManagerName string
    The name of the network manager.
    PoolName string
    Pool resource name.
    ResourceGroupName string
    The name of the resource group.
    NetworkManagerName string
    The name of the network manager.
    PoolName string
    Pool resource name.
    ResourceGroupName string
    The name of the resource group.
    network_manager_name string
    The name of the network manager.
    pool_name string
    Pool resource name.
    resource_group_name string
    The name of the resource group.
    networkManagerName String
    The name of the network manager.
    poolName String
    Pool resource name.
    resourceGroupName String
    The name of the resource group.
    networkManagerName string
    The name of the network manager.
    poolName string
    Pool resource name.
    resourceGroupName string
    The name of the resource group.
    network_manager_name str
    The name of the network manager.
    pool_name str
    Pool resource name.
    resource_group_name str
    The name of the resource group.
    networkManagerName String
    The name of the network manager.
    poolName String
    Pool resource name.
    resourceGroupName String
    The name of the resource group.

    getIpamPoolUsage Result

    The following output properties are available:

    AddressPrefixes List<string>
    List of IP address prefixes of the resource.
    AllocatedAddressPrefixes List<string>
    List of assigned IP address prefixes.
    AvailableAddressPrefixes List<string>
    List of available IP address prefixes.
    ChildPools List<Pulumi.AzureNative.Network.Outputs.ResourceBasicsResponse>
    List of IpamPool that are children of this IpamPool.
    NumberOfAllocatedIPAddresses string
    Total number of assigned IP addresses in the IpamPool.
    NumberOfAvailableIPAddresses string
    Total number of available IP addresses in the IpamPool.
    NumberOfReservedIPAddresses string
    Total number of reserved IP addresses in the IpamPool.
    ReservedAddressPrefixes List<string>
    List of reserved IP address prefixes. These IP addresses could be reclaimed if not assigned in the given time.
    TotalNumberOfIPAddresses string
    Total number of IP addresses managed in the IpamPool.
    AddressPrefixes []string
    List of IP address prefixes of the resource.
    AllocatedAddressPrefixes []string
    List of assigned IP address prefixes.
    AvailableAddressPrefixes []string
    List of available IP address prefixes.
    ChildPools []ResourceBasicsResponse
    List of IpamPool that are children of this IpamPool.
    NumberOfAllocatedIPAddresses string
    Total number of assigned IP addresses in the IpamPool.
    NumberOfAvailableIPAddresses string
    Total number of available IP addresses in the IpamPool.
    NumberOfReservedIPAddresses string
    Total number of reserved IP addresses in the IpamPool.
    ReservedAddressPrefixes []string
    List of reserved IP address prefixes. These IP addresses could be reclaimed if not assigned in the given time.
    TotalNumberOfIPAddresses string
    Total number of IP addresses managed in the IpamPool.
    address_prefixes list(string)
    List of IP address prefixes of the resource.
    allocated_address_prefixes list(string)
    List of assigned IP address prefixes.
    available_address_prefixes list(string)
    List of available IP address prefixes.
    child_pools list(object)
    List of IpamPool that are children of this IpamPool.
    number_of_allocated_ip_addresses string
    Total number of assigned IP addresses in the IpamPool.
    number_of_available_ip_addresses string
    Total number of available IP addresses in the IpamPool.
    number_of_reserved_ip_addresses string
    Total number of reserved IP addresses in the IpamPool.
    reserved_address_prefixes list(string)
    List of reserved IP address prefixes. These IP addresses could be reclaimed if not assigned in the given time.
    total_number_of_ip_addresses string
    Total number of IP addresses managed in the IpamPool.
    addressPrefixes List<String>
    List of IP address prefixes of the resource.
    allocatedAddressPrefixes List<String>
    List of assigned IP address prefixes.
    availableAddressPrefixes List<String>
    List of available IP address prefixes.
    childPools List<ResourceBasicsResponse>
    List of IpamPool that are children of this IpamPool.
    numberOfAllocatedIPAddresses String
    Total number of assigned IP addresses in the IpamPool.
    numberOfAvailableIPAddresses String
    Total number of available IP addresses in the IpamPool.
    numberOfReservedIPAddresses String
    Total number of reserved IP addresses in the IpamPool.
    reservedAddressPrefixes List<String>
    List of reserved IP address prefixes. These IP addresses could be reclaimed if not assigned in the given time.
    totalNumberOfIPAddresses String
    Total number of IP addresses managed in the IpamPool.
    addressPrefixes string[]
    List of IP address prefixes of the resource.
    allocatedAddressPrefixes string[]
    List of assigned IP address prefixes.
    availableAddressPrefixes string[]
    List of available IP address prefixes.
    childPools ResourceBasicsResponse[]
    List of IpamPool that are children of this IpamPool.
    numberOfAllocatedIPAddresses string
    Total number of assigned IP addresses in the IpamPool.
    numberOfAvailableIPAddresses string
    Total number of available IP addresses in the IpamPool.
    numberOfReservedIPAddresses string
    Total number of reserved IP addresses in the IpamPool.
    reservedAddressPrefixes string[]
    List of reserved IP address prefixes. These IP addresses could be reclaimed if not assigned in the given time.
    totalNumberOfIPAddresses string
    Total number of IP addresses managed in the IpamPool.
    address_prefixes Sequence[str]
    List of IP address prefixes of the resource.
    allocated_address_prefixes Sequence[str]
    List of assigned IP address prefixes.
    available_address_prefixes Sequence[str]
    List of available IP address prefixes.
    child_pools Sequence[ResourceBasicsResponse]
    List of IpamPool that are children of this IpamPool.
    number_of_allocated_ip_addresses str
    Total number of assigned IP addresses in the IpamPool.
    number_of_available_ip_addresses str
    Total number of available IP addresses in the IpamPool.
    number_of_reserved_ip_addresses str
    Total number of reserved IP addresses in the IpamPool.
    reserved_address_prefixes Sequence[str]
    List of reserved IP address prefixes. These IP addresses could be reclaimed if not assigned in the given time.
    total_number_of_ip_addresses str
    Total number of IP addresses managed in the IpamPool.
    addressPrefixes List<String>
    List of IP address prefixes of the resource.
    allocatedAddressPrefixes List<String>
    List of assigned IP address prefixes.
    availableAddressPrefixes List<String>
    List of available IP address prefixes.
    childPools List<Property Map>
    List of IpamPool that are children of this IpamPool.
    numberOfAllocatedIPAddresses String
    Total number of assigned IP addresses in the IpamPool.
    numberOfAvailableIPAddresses String
    Total number of available IP addresses in the IpamPool.
    numberOfReservedIPAddresses String
    Total number of reserved IP addresses in the IpamPool.
    reservedAddressPrefixes List<String>
    List of reserved IP address prefixes. These IP addresses could be reclaimed if not assigned in the given time.
    totalNumberOfIPAddresses String
    Total number of IP addresses managed in the IpamPool.

    Supporting Types

    ResourceBasicsResponse

    AddressPrefixes List<string>
    List of IP address prefixes of the resource.
    ResourceId string
    ResourceId of the Azure resource.
    AddressPrefixes []string
    List of IP address prefixes of the resource.
    ResourceId string
    ResourceId of the Azure resource.
    address_prefixes list(string)
    List of IP address prefixes of the resource.
    resource_id string
    ResourceId of the Azure resource.
    addressPrefixes List<String>
    List of IP address prefixes of the resource.
    resourceId String
    ResourceId of the Azure resource.
    addressPrefixes string[]
    List of IP address prefixes of the resource.
    resourceId string
    ResourceId of the Azure resource.
    address_prefixes Sequence[str]
    List of IP address prefixes of the resource.
    resource_id str
    ResourceId of the Azure resource.
    addressPrefixes List<String>
    List of IP address prefixes of the resource.
    resourceId String
    ResourceId of the Azure resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.25.0
    published on Wednesday, Aug 5, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial