Ipam Pools - Get Pool Usage

Referenz

Dienst:: Virtual Networks

API-Version:: 2024-05-01

Rufen Sie die Poolnutzung ab.

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/ipamPools/{poolName}/getPoolUsage?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
networkManagerName	path	True	string	Der Name des Netzwerk-Managers. RegEx-Muster: `^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$`
poolName	path	True	string	Poolressourcenname. RegEx-Muster: `^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	PoolUsage	Anzeigen der Zusammenfassung der Nutzungsinformationen von ipamPool
Other Status Codes	CommonErrorResponse	Standardfehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

IpamPools_GetPoolUsage

Beispielanforderung

POST /subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool/getPoolUsage?api-version=2024-05-01


/**
 * Samples for IpamPools GetPoolUsage.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/IpamPools_GetPoolUsage.json
     */
    /**
     * Sample code: IpamPools_GetPoolUsage.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void ipamPoolsGetPoolUsage(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getIpamPools().getPoolUsageWithResponse("rg1", "TestNetworkManager",
            "TestPool", 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

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_get_pool_usage.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.get_pool_usage(
        resource_group_name="rg1",
        network_manager_name="TestNetworkManager",
        pool_name="TestPool",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/IpamPools_GetPoolUsage.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

package armnetwork_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/IpamPools_GetPoolUsage.json
func ExampleIpamPoolsClient_GetPoolUsage() {
	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)
	}
	res, err := clientFactory.NewIpamPoolsClient().GetPoolUsage(ctx, "rg1", "TestNetworkManager", "TestPool", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.PoolUsage = armnetwork.PoolUsage{
	// 	AddressPrefixes: []*string{
	// 		to.Ptr("10.0.0.0/8"),
	// 		to.Ptr("192.0.0.0/8")},
	// 		AllocatedAddressPrefixes: []*string{
	// 			to.Ptr("10.0.2.0/26"),
	// 			to.Ptr("10.0.3.0/26")},
	// 			AvailableAddressPrefixes: []*string{
	// 				to.Ptr("10.0.1.0/24"),
	// 				to.Ptr("10.0.2.64/26"),
	// 				to.Ptr("10.0.2.128/25"),
	// 				to.Ptr("10.0.3.64/26"),
	// 				to.Ptr("10.0.3.128/25"),
	// 				to.Ptr("10.0.4.0/22"),
	// 				to.Ptr("10.0.8.0/21"),
	// 				to.Ptr("10.0.16.0/20"),
	// 				to.Ptr("10.0.32.0/19"),
	// 				to.Ptr("10.0.64.0/18"),
	// 				to.Ptr("10.0.128.0/17"),
	// 				to.Ptr("10.1.0.0/16"),
	// 				to.Ptr("10.2.0.0/15"),
	// 				to.Ptr("10.4.0.0/14"),
	// 				to.Ptr("10.8.0.0/13"),
	// 				to.Ptr("10.16.0.0/12"),
	// 				to.Ptr("10.32.0.0/11"),
	// 				to.Ptr("10.64.0.0/10"),
	// 				to.Ptr("10.128.0.0/9"),
	// 				to.Ptr("192.0.0.0/8")},
	// 				ChildPools: []*armnetwork.ResourceBasics{
	// 					{
	// 						AddressPrefixes: []*string{
	// 							to.Ptr("10.0.2.0/26")},
	// 							ResourceID: to.Ptr("/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool1"),
	// 						},
	// 						{
	// 							AddressPrefixes: []*string{
	// 								to.Ptr("10.0.3.0/26")},
	// 								ResourceID: to.Ptr("/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool2"),
	// 						}},
	// 						NumberOfAllocatedIPAddresses: to.Ptr("128"),
	// 						NumberOfAvailableIPAddresses: to.Ptr("33554048"),
	// 						NumberOfReservedIPAddresses: to.Ptr("256"),
	// 						ReservedAddressPrefixes: []*string{
	// 							to.Ptr("10.0.0.0/24")},
	// 							TotalNumberOfIPAddresses: to.Ptr("33554432"),
	// 						}
}

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

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

/**
 * This sample demonstrates how to Get the Pool Usage.
 *
 * @summary Get the Pool Usage.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/IpamPools_GetPoolUsage.json
 */
async function ipamPoolsGetPoolUsage() {
  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 credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.ipamPools.getPoolUsage(
    resourceGroupName,
    networkManagerName,
    poolName,
  );
  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

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/2024-05-01/examples/IpamPools_GetPoolUsage.json
// this example is just showing the usage of "IpamPools_GetPoolUsage" 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 IpamPoolResource created on azure
// for more information of creating IpamPoolResource, please refer to the document of IpamPoolResource
string subscriptionId = "11111111-1111-1111-1111-111111111111";
string resourceGroupName = "rg1";
string networkManagerName = "TestNetworkManager";
string poolName = "TestPool";
ResourceIdentifier ipamPoolResourceId = IpamPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkManagerName, poolName);
IpamPoolResource ipamPool = client.GetIpamPoolResource(ipamPoolResourceId);

// invoke the operation
IpamPoolUsage result = await ipamPool.GetPoolUsageAsync();

Console.WriteLine($"Succeeded: {result}");

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "addressPrefixes": [
    "10.0.0.0/8",
    "192.0.0.0/8"
  ],
  "childPools": [
    {
      "resourceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool1",
      "addressPrefixes": [
        "10.0.2.0/26"
      ]
    },
    {
      "resourceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool2",
      "addressPrefixes": [
        "10.0.3.0/26"
      ]
    }
  ],
  "allocatedAddressPrefixes": [
    "10.0.2.0/26",
    "10.0.3.0/26"
  ],
  "reservedAddressPrefixes": [
    "10.0.0.0/24"
  ],
  "availableAddressPrefixes": [
    "10.0.1.0/24",
    "10.0.2.64/26",
    "10.0.2.128/25",
    "10.0.3.64/26",
    "10.0.3.128/25",
    "10.0.4.0/22",
    "10.0.8.0/21",
    "10.0.16.0/20",
    "10.0.32.0/19",
    "10.0.64.0/18",
    "10.0.128.0/17",
    "10.1.0.0/16",
    "10.2.0.0/15",
    "10.4.0.0/14",
    "10.8.0.0/13",
    "10.16.0.0/12",
    "10.32.0.0/11",
    "10.64.0.0/10",
    "10.128.0.0/9",
    "192.0.0.0/8"
  ],
  "totalNumberOfIPAddresses": "33554432",
  "numberOfAllocatedIPAddresses": "128",
  "numberOfReservedIPAddresses": "256",
  "numberOfAvailableIPAddresses": "33554048"
}

Definitionen

Name	Beschreibung
CommonErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
CommonErrorDetail	Das Fehlerdetails.
CommonErrorResponse	Fehlerantwort
PoolUsage	IpamPool-Nutzungsinformationen.
ResourceBasics	Darstellung grundlegender Ressourceninformationen.

CommonErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

CommonErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	CommonErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	CommonErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

CommonErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	CommonErrorDetail	Das Fehlerobjekt.

PoolUsage

Objekt

IpamPool-Nutzungsinformationen.

Name	Typ	Beschreibung
addressPrefixes	string[]	Liste der IP-Adresspräfixe der Ressource.
allocatedAddressPrefixes	string[]	Liste der zugewiesenen IP-Adresspräfixe.
availableAddressPrefixes	string[]	Liste der verfügbaren IP-Adresspräfixe.
childPools	ResourceBasics[]	Liste von IpamPool, die untergeordnete Elemente dieses IpamPools sind.
numberOfAllocatedIPAddresses	string	Gesamtzahl der zugewiesenen IP-Adressen im IpamPool.
numberOfAvailableIPAddresses	string	Die Gesamtzahl der verfügbaren IP-Adressen im IpamPool.
numberOfReservedIPAddresses	string	Gesamtzahl der reservierten IP-Adressen im IpamPool.
reservedAddressPrefixes	string[]	Liste der reservierten IP-Adresspräfixe. Diese IP-Adressen können zurückgefordert werden, wenn sie nicht in der angegebenen Zeit zugewiesen sind.
totalNumberOfIPAddresses	string	Die Gesamtanzahl der im IpamPool verwalteten IP-Adressen.

ResourceBasics

Objekt

Darstellung grundlegender Ressourceninformationen.

Name	Typ	Beschreibung
addressPrefixes	string[]	Liste der IP-Adresspräfixe der Ressource.
resourceId	string	ResourceId der Azure-Ressource.