Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getIpamPool
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getIpamPool

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Instance of Pool resource.

Uses Azure REST API version 2024-05-01.

Other available API versions: 2024-01-01-preview. 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 getIpamPool

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 getIpamPool(args: GetIpamPoolArgs, opts?: InvokeOptions): Promise<GetIpamPoolResult>
function getIpamPoolOutput(args: GetIpamPoolOutputArgs, opts?: InvokeOptions): Output<GetIpamPoolResult>
Copy
def get_ipam_pool(network_manager_name: Optional[str] = None,
                  pool_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetIpamPoolResult
def get_ipam_pool_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[GetIpamPoolResult]
Copy
func LookupIpamPool(ctx *Context, args *LookupIpamPoolArgs, opts ...InvokeOption) (*LookupIpamPoolResult, error)
func LookupIpamPoolOutput(ctx *Context, args *LookupIpamPoolOutputArgs, opts ...InvokeOption) LookupIpamPoolResultOutput
Copy

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

public static class GetIpamPool 
{
    public static Task<GetIpamPoolResult> InvokeAsync(GetIpamPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetIpamPoolResult> Invoke(GetIpamPoolInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIpamPoolResult> getIpamPool(GetIpamPoolArgs args, InvokeOptions options)
public static Output<GetIpamPoolResult> getIpamPool(GetIpamPoolArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getIpamPool
  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.

getIpamPool Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties Pulumi.AzureNative.Network.Outputs.IpamPoolPropertiesResponse
Properties of IpamPool resource properties which are specific to the Pool resource.
SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties IpamPoolPropertiesResponse
Properties of IpamPool resource properties which are specific to the Pool resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties IpamPoolPropertiesResponse
Properties of IpamPool resource properties which are specific to the Pool resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
name string
The name of the resource
properties IpamPoolPropertiesResponse
Properties of IpamPool resource properties which are specific to the Pool resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
name str
The name of the resource
properties IpamPoolPropertiesResponse
Properties of IpamPool resource properties which are specific to the Pool resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties Property Map
Properties of IpamPool resource properties which are specific to the Pool resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String>
Resource tags.

Supporting Types

IpamPoolPropertiesResponse

AddressPrefixes This property is required. List<string>
List of IP address prefixes of the resource.
IpAddressType This property is required. List<string>
List of IP address type for the IpamPool.
ProvisioningState This property is required. string
Provisioning states of a resource.
Description string
DisplayName string
String representing a friendly name for the resource.
ParentPoolName string
String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
AddressPrefixes This property is required. []string
List of IP address prefixes of the resource.
IpAddressType This property is required. []string
List of IP address type for the IpamPool.
ProvisioningState This property is required. string
Provisioning states of a resource.
Description string
DisplayName string
String representing a friendly name for the resource.
ParentPoolName string
String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
addressPrefixes This property is required. List<String>
List of IP address prefixes of the resource.
ipAddressType This property is required. List<String>
List of IP address type for the IpamPool.
provisioningState This property is required. String
Provisioning states of a resource.
description String
displayName String
String representing a friendly name for the resource.
parentPoolName String
String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
addressPrefixes This property is required. string[]
List of IP address prefixes of the resource.
ipAddressType This property is required. string[]
List of IP address type for the IpamPool.
provisioningState This property is required. string
Provisioning states of a resource.
description string
displayName string
String representing a friendly name for the resource.
parentPoolName string
String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
address_prefixes This property is required. Sequence[str]
List of IP address prefixes of the resource.
ip_address_type This property is required. Sequence[str]
List of IP address type for the IpamPool.
provisioning_state This property is required. str
Provisioning states of a resource.
description str
display_name str
String representing a friendly name for the resource.
parent_pool_name str
String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
addressPrefixes This property is required. List<String>
List of IP address prefixes of the resource.
ipAddressType This property is required. List<String>
List of IP address type for the IpamPool.
provisioningState This property is required. String
Provisioning states of a resource.
description String
displayName String
String representing a friendly name for the resource.
parentPoolName String
String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The type of identity that last modified the resource.
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The type of identity that last modified the resource.
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native