Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getIpamPoolUsage
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.getIpamPoolUsage

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

IpamPool usage information. Azure REST API version: 2024-01-01-preview.

Other available API versions: 2024-05-01.

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>
Copy
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: Optional[pulumi.Input[str]] = None,
                        pool_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetIpamPoolUsageResult]
Copy
func GetIpamPoolUsage(ctx *Context, args *GetIpamPoolUsageArgs, opts ...InvokeOption) (*GetIpamPoolUsageResult, error)
func GetIpamPoolUsageOutput(ctx *Context, args *GetIpamPoolUsageOutputArgs, opts ...InvokeOption) GetIpamPoolUsageResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetIpamPoolUsageResult> getIpamPoolUsage(GetIpamPoolUsageArgs args, InvokeOptions options)
public static Output<GetIpamPoolUsageResult> getIpamPoolUsage(GetIpamPoolUsageArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getIpamPoolUsage
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
PoolName
This property is required.
Changes to this property will trigger replacement.
string
Pool resource name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
PoolName
This property is required.
Changes to this property will trigger replacement.
string
Pool resource name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
poolName
This property is required.
Changes to this property will trigger replacement.
String
Pool resource name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
poolName
This property is required.
Changes to this property will trigger replacement.
string
Pool resource name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
network_manager_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network manager.
pool_name
This property is required.
Changes to this property will trigger replacement.
str
Pool resource name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
poolName
This property is required.
Changes to this property will trigger replacement.
String
Pool resource name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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.
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.
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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native