Ipam Pools - Create

Služba:

Virtual Networks

Verze rozhraní API:

2025-03-01

Vytvoří nebo aktualizuje prostředek fondu.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/ipamPools/{poolName}?api-version=2025-03-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Název správce sítě.
poolName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Název zdroje fondu správce IP adres.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match		string	Verze stavu entity (ETag) fondu, která se má aktualizovat. Tuto hodnotu je možné vynechat nebo nastavit na *, aby se operace použila bezpodmínečně.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Geografické umístění, ve kterém se nachází zdroj
properties	True	IpamPoolProperties	Vlastnosti prostředků IpamPool, které jsou specifické pro zdroj fondu.
tags		object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	IpamPool	Pool byl aktualizován
201 Created	IpamPool	Pool byl vytvořen Hlavičky Azure-AsyncOperation: string
Other Status Codes	CommonErrorResponse	Výchozí chybová odpověď.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

IpamPools_Create

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool?api-version=2025-03-01

{
  "location": "eastus",
  "properties": {
    "description": "Test description.",
    "parentPoolName": "",
    "addressPrefixes": [
      "10.0.0.0/24"
    ]
  }
}

Java

import com.azure.resourcemanager.network.fluent.models.IpamPoolInner;
import com.azure.resourcemanager.network.models.IpamPoolProperties;
import java.util.Arrays;

/**
 * Samples for IpamPools Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Create.json
     */
    /**
     * Sample code: IpamPools_Create.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void ipamPoolsCreate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getIpamPools().create("rg1", "TestNetworkManager", "TestPool",
            new IpamPoolInner().withLocation("eastus")
                .withProperties(new IpamPoolProperties().withDescription("Test description.").withParentPoolName("")
                    .withAddressPrefixes(Arrays.asList("10.0.0.0/24"))),
            null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python ipam_pools_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="11111111-1111-1111-1111-111111111111",
    )

    response = client.ipam_pools.begin_create(
        resource_group_name="rg1",
        network_manager_name="TestNetworkManager",
        pool_name="TestPool",
        body={
            "location": "eastus",
            "properties": {
                "addressPrefixes": ["10.0.0.0/24"],
                "description": "Test description.",
                "parentPoolName": "",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Create.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v8"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b24c97bfc136b01dd46a1c8ddcecd0bb5a1ab152/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Create.json
func ExampleIpamPoolsClient_BeginCreate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewIpamPoolsClient().BeginCreate(ctx, "rg1", "TestNetworkManager", "TestPool", armnetwork.IpamPool{
		Location: to.Ptr("eastus"),
		Properties: &armnetwork.IpamPoolProperties{
			Description: to.Ptr("Test description."),
			AddressPrefixes: []*string{
				to.Ptr("10.0.0.0/24")},
			ParentPoolName: to.Ptr(""),
		},
	}, &armnetwork.IpamPoolsClientBeginCreateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IpamPool = armnetwork.IpamPool{
	// 	Name: to.Ptr("TestPool"),
	// 	Type: to.Ptr("Microsoft.Network/networkManagers/ipamPools"),
	// 	ID: to.Ptr("/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool"),
	// 	SystemData: &armnetwork.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
	// 		CreatedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
	// 		CreatedByType: to.Ptr(armnetwork.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
	// 		LastModifiedByType: to.Ptr(armnetwork.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("eastus"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Etag: to.Ptr("\"00000000-0000-0000-0000-000000000000\""),
	// 	Properties: &armnetwork.IpamPoolProperties{
	// 		Description: to.Ptr("Test description."),
	// 		AddressPrefixes: []*string{
	// 			to.Ptr("10.0.0.0/24")},
	// 			IPAddressType: []*armnetwork.IPType{
	// 				to.Ptr(armnetwork.IPTypeIPv4)},
	// 				ParentPoolName: to.Ptr(""),
	// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates/Updates the Pool resource.
 *
 * @summary Creates/Updates the Pool resource.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Create.json
 */
async function ipamPoolsCreate() {
  const subscriptionId =
    process.env["NETWORK_SUBSCRIPTION_ID"] || "11111111-1111-1111-1111-111111111111";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkManagerName = "TestNetworkManager";
  const poolName = "TestPool";
  const body = {
    location: "eastus",
    properties: {
      description: "Test description.",
      addressPrefixes: ["10.0.0.0/24"],
      parentPoolName: "",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.ipamPools.beginCreateAndWait(
    resourceGroupName,
    networkManagerName,
    poolName,
    body,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Create.json
// this example is just showing the usage of "IpamPools_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this NetworkManagerResource created on azure
// for more information of creating NetworkManagerResource, please refer to the document of NetworkManagerResource
string subscriptionId = "11111111-1111-1111-1111-111111111111";
string resourceGroupName = "rg1";
string networkManagerName = "TestNetworkManager";
ResourceIdentifier networkManagerResourceId = NetworkManagerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkManagerName);
NetworkManagerResource networkManager = client.GetNetworkManagerResource(networkManagerResourceId);

// get the collection of this IpamPoolResource
IpamPoolCollection collection = networkManager.GetIpamPools();

// invoke the operation
string poolName = "TestPool";
IpamPoolData data = new IpamPoolData(new AzureLocation("eastus"), new IpamPoolProperties(new string[] { "10.0.0.0/24" })
{
    Description = "Test description.",
    ParentPoolName = "",
});
ArmOperation<IpamPoolResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, poolName, data);
IpamPoolResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
IpamPoolData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:

200

{
  "name": "TestPool",
  "type": "Microsoft.Network/networkManagers/ipamPools",
  "properties": {
    "description": "Test description.",
    "ipAddressType": [
      "IPv4"
    ],
    "parentPoolName": "",
    "addressPrefixes": [
      "10.0.0.0/24"
    ],
    "provisioningState": "Updating"
  },
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool",
  "tags": {},
  "location": "eastus",
  "etag": "\"00000000-0000-0000-0000-000000000000\"",
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "createdAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z"
  }
}

Stavový kód:

201

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/ipamPoolOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01

{
  "name": "TestPool",
  "type": "Microsoft.Network/networkManagers/ipamPools",
  "properties": {
    "description": "Test description.",
    "ipAddressType": [
      "IPv4"
    ],
    "parentPoolName": "",
    "addressPrefixes": [
      "10.0.0.0/24"
    ],
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool",
  "tags": {},
  "location": "eastus",
  "etag": "\"00000000-0000-0000-0000-000000000000\"",
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "createdByType": "User",
    "createdAt": "2021-01-11T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-11T18:52:27Z"
  }
}

Definice

Name	Description
CommonErrorAdditionalInfo	Další informace o chybě správy prostředků
CommonErrorDetail	Podrobnosti o chybě.
CommonErrorResponse	Chybová odpověď
createdByType	Typ identity, která prostředek vytvořila.
IpamPool	Instance zdroje fondu
IpamPoolProperties	Vlastnosti prostředků IpamPool, které jsou specifické pro zdroj fondu.
IpType	Výčet označující typ protokolu IP.
ProvisioningState	Stavy zřizování prostředku
SystemData	Metadata týkající se vytvoření a poslední změny prostředku.

CommonErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

CommonErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	CommonErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	CommonErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

CommonErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	CommonErrorDetail	Objekt chyby.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

IpamPool

Objekt

Instance zdroje fondu

Name	Typ	Description
etag	string	Řetězec představující jedinečnou značku etag pro dokument zdroje.
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties	IpamPoolProperties	Vlastnosti prostředků IpamPool, které jsou specifické pro zdroj fondu.
systemData	SystemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

IpamPoolProperties

Objekt

Vlastnosti prostředků IpamPool, které jsou specifické pro zdroj fondu.

Name	Typ	Description
addressPrefixes	string[]	Seznam předpon IP adres prostředku
description	string
displayName	string	Řetězec představující popisný název prostředku
ipAddressType	IpType[]	Seznam typů IP adres pro IpamPool.
parentPoolName	string	Řetězec představující nadřazený název prostředku IpamPool Pokud bude fond IpamPool prázdný, bude kořenovým fondem.
provisioningState	ProvisioningState	Stavy zřizování prostředku

IpType

Výčet

Výčet označující typ protokolu IP.

Hodnota	Description
IPv4
IPv6

ProvisioningState

Výčet

Stavy zřizování prostředku

Hodnota	Description
Failed
Succeeded
Canceled
Creating
Updating
Deleting

SystemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Typ identity, která naposledy změnila prostředek.
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.