Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. network
  6. getIpamPool
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.20.0
published on Thursday, Jul 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.network.getIpamPool

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.20.0
published on Thursday, Jul 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Instance of Pool resource.

    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 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>
    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: 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[GetIpamPoolResult]
    func LookupIpamPool(ctx *Context, args *LookupIpamPoolArgs, opts ...InvokeOption) (*LookupIpamPoolResult, error)
func LookupIpamPoolOutput(ctx *Context, args *LookupIpamPoolOutputArgs, opts ...InvokeOption) LookupIpamPoolResultOutput

    > 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)
}
    public static CompletableFuture<GetIpamPoolResult> getIpamPool(GetIpamPoolArgs args, InvokeOptions options)
public static Output<GetIpamPoolResult> getIpamPool(GetIpamPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:network:getIpamPool
  arguments:
    # arguments dictionary
    data "azure-native_network_getipampool" "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.

    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.
    azure_api_version 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 object
    Properties of IpamPool resource properties which are specific to the Pool resource.
    system_data object
    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.
    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 List<string>
    List of IP address prefixes of the resource.
    IpAddressType List<string>
    List of IP address type for the IpamPool.
    ProvisioningState 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 []string
    List of IP address prefixes of the resource.
    IpAddressType []string
    List of IP address type for the IpamPool.
    ProvisioningState 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 list(string)
    List of IP address prefixes of the resource.
    ip_address_type list(string)
    List of IP address type for the IpamPool.
    provisioning_state string
    Provisioning states of a resource.
    description string
    display_name string
    String representing a friendly name for the resource.
    parent_pool_name string
    String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
    addressPrefixes List<String>
    List of IP address prefixes of the resource.
    ipAddressType List<String>
    List of IP address type for the IpamPool.
    provisioningState 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 string[]
    List of IP address prefixes of the resource.
    ipAddressType string[]
    List of IP address type for the IpamPool.
    provisioningState 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 Sequence[str]
    List of IP address prefixes of the resource.
    ip_address_type Sequence[str]
    List of IP address type for the IpamPool.
    provisioning_state 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 List<String>
    List of IP address prefixes of the resource.
    ipAddressType List<String>
    List of IP address type for the IpamPool.
    provisioningState 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.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The type of identity that last modified the resource.
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type 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
    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.20.0
    published on Thursday, Jul 9, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial