Ip Allocations - Create Or Update

Referencia

Servicio:: Virtual Networks

Versión de la API:: 2024-05-01

Crea o actualiza una IpAllocation en el grupo de recursos especificado.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations/{ipAllocationName}?api-version=2024-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
ipAllocationName	path	True	string	Nombre de IpAllocation.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
id	string	Identificador de recurso.
location	string	Ubicación del recurso.
properties.allocationTags	object	Etiquetas ipAllocation.
properties.ipamAllocationId	string	Identificador de asignación de IPAM.
properties.prefix	string	Prefijo de dirección para IpAllocation.
properties.prefixLength	integer	Longitud del prefijo de dirección para IpAllocation.
properties.prefixType	IPVersion	Tipo de prefijo de dirección para IpAllocation.
properties.type	IpAllocationType	Tipo de IpAllocation.
tags	object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	IpAllocation	Se ha actualizado correctamente. La operación devuelve el recurso IpAllocation resultante.
201 Created	IpAllocation	Cree correctamente. La operación devuelve el recurso IpAllocation resultante.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create IpAllocation

Solicitud de ejemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation?api-version=2024-05-01

{
  "properties": {
    "type": "Hypernet",
    "prefix": "3.2.5.0/24",
    "allocationTags": {
      "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1"
    }
  },
  "location": "centraluseuap"
}


import com.azure.resourcemanager.network.fluent.models.IpAllocationInner;
import com.azure.resourcemanager.network.models.IpAllocationType;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for IpAllocations CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/IpAllocationCreate.json
     */
    /**
     * Sample code: Create IpAllocation.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createIpAllocation(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getIpAllocations().createOrUpdate("rg1", "test-ipallocation",
            new IpAllocationInner().withLocation("centraluseuap").withTypePropertiesType(IpAllocationType.HYPERNET)
                .withPrefix("3.2.5.0/24")
                .withAllocationTags(mapOf("VNetID",
                    "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1")),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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 ip_allocation_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="subid",
    )

    response = client.ip_allocations.begin_create_or_update(
        resource_group_name="rg1",
        ip_allocation_name="test-ipallocation",
        parameters={
            "location": "centraluseuap",
            "properties": {
                "allocationTags": {
                    "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1"
                },
                "prefix": "3.2.5.0/24",
                "type": "Hypernet",
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/IpAllocationCreate.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/azcore/to"
	"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/IpAllocationCreate.json
func ExampleIPAllocationsClient_BeginCreateOrUpdate() {
	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.NewIPAllocationsClient().BeginCreateOrUpdate(ctx, "rg1", "test-ipallocation", armnetwork.IPAllocation{
		Location: to.Ptr("centraluseuap"),
		Properties: &armnetwork.IPAllocationPropertiesFormat{
			Type: to.Ptr(armnetwork.IPAllocationTypeHypernet),
			AllocationTags: map[string]*string{
				"VNetID": to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1"),
			},
			Prefix: to.Ptr("3.2.5.0/24"),
		},
	}, 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.IPAllocation = armnetwork.IPAllocation{
	// 	Name: to.Ptr("test-ipallocation"),
	// 	Type: to.Ptr("Microsoft.Network/IpAllocations"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation"),
	// 	Location: to.Ptr("centraluseuap"),
	// 	Properties: &armnetwork.IPAllocationPropertiesFormat{
	// 		Type: to.Ptr(armnetwork.IPAllocationTypeHypernet),
	// 		AllocationTags: map[string]*string{
	// 			"VNetID": to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1"),
	// 		},
	// 		IpamAllocationID: to.Ptr("916d3b28-663f-448b-9abc-1bea9d5fed8f"),
	// 		Prefix: to.Ptr("3.2.5.0/24"),
	// 	},
	// }
}

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 Creates or updates an IpAllocation in the specified resource group.
 *
 * @summary Creates or updates an IpAllocation in the specified resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/IpAllocationCreate.json
 */
async function createIPAllocation() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const ipAllocationName = "test-ipallocation";
  const parameters = {
    typePropertiesType: "Hypernet",
    allocationTags: {
      vNetID:
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1",
    },
    location: "centraluseuap",
    prefix: "3.2.5.0/24",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.ipAllocations.beginCreateOrUpdateAndWait(
    resourceGroupName,
    ipAllocationName,
    parameters,
  );
  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.Resources;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/IpAllocationCreate.json
// this example is just showing the usage of "IpAllocations_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this IPAllocationResource
IPAllocationCollection collection = resourceGroupResource.GetIPAllocations();

// invoke the operation
string ipAllocationName = "test-ipallocation";
IPAllocationData data = new IPAllocationData
{
    IPAllocationType = NetworkIPAllocationType.Hypernet,
    Prefix = "3.2.5.0/24",
    AllocationTags =
    {
    ["VNetID"] = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1"
    },
    Location = new AzureLocation("centraluseuap"),
};
ArmOperation<IPAllocationResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, ipAllocationName, data);
IPAllocationResource 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
IPAllocationData 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

Respuesta de muestra

status code:: 200

{
  "name": "test-ipallocation",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation",
  "type": "Microsoft.Network/IpAllocations",
  "location": "centraluseuap",
  "properties": {
    "type": "Hypernet",
    "prefix": "3.2.5.0/24",
    "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f",
    "allocationTags": {
      "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1"
    }
  }
}

status code:: 201

{
  "name": "test-ipallocation",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation",
  "type": "Microsoft.Network/IpAllocations",
  "location": "centraluseuap",
  "properties": {
    "type": "Hypernet",
    "prefix": "3.2.5.0/24",
    "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f",
    "allocationTags": {
      "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1"
    }
  }
}

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
IpAllocation	Recurso IpAllocation.
IpAllocationType	Tipo de IpAllocation.
IPVersion	Versión de la dirección IP.
SubResource	Referencia a otro subrecurso.

CloudError

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo del error en la nube.

CloudErrorBody

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

IpAllocation

Object

Recurso IpAllocation.

Nombre	Tipo	Valor predeterminado	Description
etag	string		Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string		Identificador de recurso.
location	string		Ubicación del recurso.
name	string		Nombre del recurso.
properties.allocationTags	object		Etiquetas ipAllocation.
properties.ipamAllocationId	string		Identificador de asignación de IPAM.
properties.prefix	string		Prefijo de dirección para IpAllocation.
properties.prefixLength	integer	0	Longitud del prefijo de dirección para IpAllocation.
properties.prefixType	IPVersion		Tipo de prefijo de dirección para IpAllocation.
properties.subnet	SubResource		Subred que usa el prefijo de este recurso IpAllocation.
properties.type	IpAllocationType		Tipo de IpAllocation.
properties.virtualNetwork	SubResource		VirtualNetwork que usa el prefijo de este recurso IpAllocation.
tags	object		Etiquetas de recursos.
type	string		Tipo de recurso.

IpAllocationType

Enumeración

Tipo de IpAllocation.

Valor	Description
Hypernet
Undefined

IPVersion

Enumeración

Versión de la dirección IP.

Valor	Description
IPv4
IPv6

SubResource

Object

Referencia a otro subrecurso.

Nombre	Tipo	Description
id	string	Identificador de recurso.