Ip Allocations - Create Or Update

Referencia

Szolgáltatás:: Virtual Networks

API-verzió:: 2024-05-01

IpAllocation létrehozása vagy frissítése a megadott erőforráscsoportban.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
ipAllocationName	path	True	string	Az IpAllocation neve.
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem törzse

Name	Típus	Description
id	string	Erőforrás-azonosító.
location	string	Erőforrás helye.
properties.allocationTags	object	IpAllocation-címkék.
properties.ipamAllocationId	string	Az IPAM foglalási azonosítója.
properties.prefix	string	Az IpAllocation címelőtagja.
properties.prefixLength	integer	Az IpAllocation címelőtagjának hossza.
properties.prefixType	IPVersion	Az IpAllocation címelőtagjának típusa.
properties.type	IpAllocationType	Az IpAllocation típusa.
tags	object	Erőforráscímkék.

Válaszok

Name	Típus	Description
200 OK	IpAllocation	A frissítés sikeres. A művelet az eredményül kapott IpAllocation-erőforrást adja vissza.
201 Created	IpAllocation	Sikeres létrehozás. A művelet az eredményül kapott IpAllocation-erőforrást adja vissza.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Create IpAllocation

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
    }
  }
}

Állapotkód:: 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"
    }
  }
}

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
IpAllocation	IpAllocation erőforrás.
IpAllocationType	IpAllocation típus.
IPVersion	IP-cím verziója.
SubResource	Hivatkozás egy másik alforrásra.

CloudError

Objektum

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Felhőbeli hibatörzs.

CloudErrorBody

Objektum

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hiba további részleteinek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a tulajdonság neve hibás.

IpAllocation

Objektum

IpAllocation erőforrás.

Name	Típus	Alapértelmezett érték	Description
etag	string		Egyedi írásvédett sztring, amely az erőforrás frissítésekor változik.
id	string		Erőforrás-azonosító.
location	string		Erőforrás helye.
name	string		Erőforrás neve.
properties.allocationTags	object		IpAllocation-címkék.
properties.ipamAllocationId	string		Az IPAM foglalási azonosítója.
properties.prefix	string		Az IpAllocation címelőtagja.
properties.prefixLength	integer	0	Az IpAllocation címelőtagjának hossza.
properties.prefixType	IPVersion		Az IpAllocation címelőtagjának típusa.
properties.subnet	SubResource		Az IpAllocation-erőforrás előtagját használó alhálózat.
properties.type	IpAllocationType		Az IpAllocation típusa.
properties.virtualNetwork	SubResource		Az IpAllocation-erőforrás előtagját használó VirtualNetwork.
tags	object		Erőforráscímkék.
type	string		Erőforrás típusa.

IpAllocationType

Enumerálás

IpAllocation típus.

Érték	Description
Hypernet
Undefined

IPVersion

Enumerálás

IP-cím verziója.

Érték	Description
IPv4
IPv6

SubResource

Objektum

Hivatkozás egy másik alforrásra.

Name	Típus	Description
id	string	Erőforrás-azonosító.