Public IP Addresses - Create Or Update

Service:

Virtual Networks

API Version:

2023-09-01

Hiermee maakt of werkt u een statisch of dynamisch openbaar IP-adres bij.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}?api-version=2023-09-01

URI-parameters

Name	In	Vereist	Type	Description
publicIpAddressName	path	True	string	De naam van het openbare IP-adres.
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
extendedLocation	ExtendedLocation	De uitgebreide locatie van het openbare IP-adres.
id	string	Resource-id.
location	string	Resourcelocatie.
properties.ddosSettings	DdosSettings	Het aangepaste DDoS-beveiligingsbeleid dat is gekoppeld aan het openbare IP-adres.
properties.deleteOption	DeleteOptions	Opgeven wat er met het openbare IP-adres gebeurt wanneer de VM die deze gebruikt, wordt verwijderd
properties.dnsSettings	PublicIPAddressDnsSettings	De FQDN van de DNS-record die is gekoppeld aan het openbare IP-adres.
properties.idleTimeoutInMinutes	integer	De time-out voor inactiviteit van het openbare IP-adres.
properties.ipAddress	string	Het IP-adres dat is gekoppeld aan de resource van het openbare IP-adres.
properties.ipTags	IpTag[]	De lijst met tags die zijn gekoppeld aan het openbare IP-adres.
properties.linkedPublicIPAddress	PublicIPAddress	Het gekoppelde openbare IP-adres van de resource van het openbare IP-adres.
properties.migrationPhase	PublicIPAddressMigrationPhase	Migratiefase van openbaar IP-adres.
properties.natGateway	NatGateway	De NatGateway voor het openbare IP-adres.
properties.publicIPAddressVersion	IPVersion	De versie van het openbare IP-adres.
properties.publicIPAllocationMethod	IPAllocationMethod	De toewijzingsmethode voor openbare IP-adressen.
properties.publicIPPrefix	SubResource	Het openbare IP-voorvoegsel waaruit dit openbare IP-adres moet worden toegewezen.
properties.servicePublicIPAddress	PublicIPAddress	Het openbare IP-adres van de service van de resource van het openbare IP-adres.
sku	PublicIPAddressSku	De openbare IP-adres-SKU.
tags	object	Resourcetags.
zones	string[]	Een lijst met beschikbaarheidszones die het IP-adres aangeeft dat voor de resource is toegewezen, moet afkomstig zijn.

Antwoorden

Name	Type	Description
200 OK	PublicIPAddress	De update is voltooid. De bewerking retourneert de resulterende PublicIPAddress-resource.
201 Created	PublicIPAddress	Maken is voltooid. De bewerking retourneert de resulterende PublicIPAddress-resource.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Create public IP address allocation method

Create public IP address defaults

Create public IP address DNS

Create public IP address DNS with Domain Name Label Scope

Create public IP address allocation method

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip?api-version=2023-09-01

{
  "properties": {
    "publicIPAllocationMethod": "Static",
    "idleTimeoutInMinutes": 10,
    "publicIPAddressVersion": "IPv4"
  },
  "sku": {
    "name": "Standard",
    "tier": "Global"
  },
  "location": "eastus"
}

Java

import com.azure.resourcemanager.network.fluent.models.PublicIpAddressInner;
import com.azure.resourcemanager.network.models.IpAllocationMethod;
import com.azure.resourcemanager.network.models.IpVersion;
import com.azure.resourcemanager.network.models.PublicIpAddressDnsSettings;
import com.azure.resourcemanager.network.models.PublicIpAddressDnsSettingsDomainNameLabelScope;
import com.azure.resourcemanager.network.models.PublicIpAddressSku;
import com.azure.resourcemanager.network.models.PublicIpAddressSkuName;
import com.azure.resourcemanager.network.models.PublicIpAddressSkuTier;

/**
 * Samples for PublicIpAddresses CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * PublicIpAddressCreateCustomizedValues.json
     */
    /**
     * Sample code: Create public IP address allocation method.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createPublicIPAddressAllocationMethod(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPublicIpAddresses().createOrUpdate("rg1", "test-ip",
            new PublicIpAddressInner().withLocation("eastus")
                .withSku(new PublicIpAddressSku().withName(PublicIpAddressSkuName.STANDARD)
                    .withTier(PublicIpAddressSkuTier.GLOBAL))
                .withPublicIpAllocationMethod(IpAllocationMethod.STATIC).withPublicIpAddressVersion(IpVersion.IPV4)
                .withIdleTimeoutInMinutes(10),
            com.azure.core.util.Context.NONE);
    }

    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * PublicIpAddressCreateDnsWithDomainNameLabelScope.json
     */
    /**
     * Sample code: Create public IP address DNS with Domain Name Label Scope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createPublicIPAddressDNSWithDomainNameLabelScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPublicIpAddresses().createOrUpdate("rg1", "test-ip",
            new PublicIpAddressInner().withLocation("eastus")
                .withDnsSettings(new PublicIpAddressDnsSettings().withDomainNameLabel("dnslbl")
                    .withDomainNameLabelScope(PublicIpAddressDnsSettingsDomainNameLabelScope.TENANT_REUSE)),
            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 public_ip_address_create_customized_values.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.public_ip_addresses.begin_create_or_update(
        resource_group_name="rg1",
        public_ip_address_name="test-ip",
        parameters={
            "location": "eastus",
            "properties": {
                "idleTimeoutInMinutes": 10,
                "publicIPAddressVersion": "IPv4",
                "publicIPAllocationMethod": "Static",
            },
            "sku": {"name": "Standard", "tier": "Global"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateCustomizedValues.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateCustomizedValues.json
func ExamplePublicIPAddressesClient_BeginCreateOrUpdate_createPublicIpAddressAllocationMethod() {
	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.NewPublicIPAddressesClient().BeginCreateOrUpdate(ctx, "rg1", "test-ip", armnetwork.PublicIPAddress{
		Location: to.Ptr("eastus"),
		Properties: &armnetwork.PublicIPAddressPropertiesFormat{
			IdleTimeoutInMinutes:     to.Ptr[int32](10),
			PublicIPAddressVersion:   to.Ptr(armnetwork.IPVersionIPv4),
			PublicIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodStatic),
		},
		SKU: &armnetwork.PublicIPAddressSKU{
			Name: to.Ptr(armnetwork.PublicIPAddressSKUNameStandard),
			Tier: to.Ptr(armnetwork.PublicIPAddressSKUTierGlobal),
		},
	}, 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.PublicIPAddress = armnetwork.PublicIPAddress{
	// 	Name: to.Ptr("testDNS-ip"),
	// 	Type: to.Ptr("Microsoft.Network/publicIPAddresses"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armnetwork.PublicIPAddressPropertiesFormat{
	// 		DdosSettings: &armnetwork.DdosSettings{
	// 			ProtectionMode: to.Ptr(armnetwork.DdosSettingsProtectionModeVirtualNetworkInherited),
	// 		},
	// 		IdleTimeoutInMinutes: to.Ptr[int32](10),
	// 		IPConfiguration: &armnetwork.IPConfiguration{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"),
	// 		},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		PublicIPAddressVersion: to.Ptr(armnetwork.IPVersionIPv4),
	// 		PublicIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodStatic),
	// 	},
	// 	SKU: &armnetwork.PublicIPAddressSKU{
	// 		Name: to.Ptr(armnetwork.PublicIPAddressSKUNameStandard),
	// 		Tier: to.Ptr(armnetwork.PublicIPAddressSKUTierGlobal),
	// 	},
	// 	Zones: []*string{
	// 		to.Ptr("1")},
	// 	}
}

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");

/**
 * This sample demonstrates how to Creates or updates a static or dynamic public IP address.
 *
 * @summary Creates or updates a static or dynamic public IP address.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateCustomizedValues.json
 */
async function createPublicIPAddressAllocationMethod() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const publicIpAddressName = "test-ip";
  const parameters = {
    idleTimeoutInMinutes: 10,
    location: "eastus",
    publicIPAddressVersion: "IPv4",
    publicIPAllocationMethod: "Static",
    sku: { name: "Standard", tier: "Global" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.publicIPAddresses.beginCreateOrUpdateAndWait(
    resourceGroupName,
    publicIpAddressName,
    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

dotnet

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateCustomizedValues.json
// this example is just showing the usage of "PublicIPAddresses_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 PublicIPAddressResource
PublicIPAddressCollection collection = resourceGroupResource.GetPublicIPAddresses();

// invoke the operation
string publicIPAddressName = "test-ip";
PublicIPAddressData data = new PublicIPAddressData()
{
    Sku = new PublicIPAddressSku()
    {
        Name = PublicIPAddressSkuName.Standard,
        Tier = PublicIPAddressSkuTier.Global,
    },
    PublicIPAllocationMethod = NetworkIPAllocationMethod.Static,
    PublicIPAddressVersion = NetworkIPVersion.IPv4,
    IdleTimeoutInMinutes = 10,
    Location = new AzureLocation("eastus"),
};
ArmOperation<PublicIPAddressResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, publicIPAddressName, data);
PublicIPAddressResource 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
PublicIPAddressData 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

Sample Response

Status code:

200

{
  "name": "testDNS-ip",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip",
  "location": "eastus",
  "zones": [
    "1"
  ],
  "properties": {
    "provisioningState": "Succeeded",
    "publicIPAddressVersion": "IPv4",
    "publicIPAllocationMethod": "Static",
    "idleTimeoutInMinutes": 10,
    "ipConfiguration": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"
    },
    "ddosSettings": {
      "protectionMode": "VirtualNetworkInherited"
    }
  },
  "sku": {
    "name": "Standard",
    "tier": "Global"
  },
  "type": "Microsoft.Network/publicIPAddresses"
}

Status code:

201

{
  "name": "testDNS-ip",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip",
  "location": "eastus",
  "zones": [
    "1"
  ],
  "properties": {
    "provisioningState": "Succeeded",
    "publicIPAddressVersion": "IPv4",
    "publicIPAllocationMethod": "Static",
    "idleTimeoutInMinutes": 10,
    "ipConfiguration": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"
    },
    "ddosSettings": {
      "protectionMode": "VirtualNetworkInherited"
    }
  },
  "sku": {
    "name": "Standard",
    "tier": "Global"
  },
  "type": "Microsoft.Network/publicIPAddresses"
}

Create public IP address defaults

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip?api-version=2023-09-01

{
  "location": "eastus"
}

Java

import com.azure.resourcemanager.network.fluent.models.PublicIpAddressInner;
import com.azure.resourcemanager.network.models.PublicIpAddressDnsSettings;
import com.azure.resourcemanager.network.models.PublicIpAddressDnsSettingsDomainNameLabelScope;

/**
 * Samples for PublicIpAddresses CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDefaults
     * .json
     */
    /**
     * Sample code: Create public IP address defaults.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createPublicIPAddressDefaults(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPublicIpAddresses().createOrUpdate("rg1", "test-ip",
            new PublicIpAddressInner().withLocation("eastus"), com.azure.core.util.Context.NONE);
    }

    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * PublicIpAddressCreateDnsWithDomainNameLabelScope.json
     */
    /**
     * Sample code: Create public IP address DNS with Domain Name Label Scope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createPublicIPAddressDNSWithDomainNameLabelScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPublicIpAddresses().createOrUpdate("rg1", "test-ip",
            new PublicIpAddressInner().withLocation("eastus")
                .withDnsSettings(new PublicIpAddressDnsSettings().withDomainNameLabel("dnslbl")
                    .withDomainNameLabelScope(PublicIpAddressDnsSettingsDomainNameLabelScope.TENANT_REUSE)),
            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 public_ip_address_create_defaults.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.public_ip_addresses.begin_create_or_update(
        resource_group_name="rg1",
        public_ip_address_name="test-ip",
        parameters={"location": "eastus"},
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDefaults.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDefaults.json
func ExamplePublicIPAddressesClient_BeginCreateOrUpdate_createPublicIpAddressDefaults() {
	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.NewPublicIPAddressesClient().BeginCreateOrUpdate(ctx, "rg1", "test-ip", armnetwork.PublicIPAddress{
		Location: to.Ptr("eastus"),
	}, 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.PublicIPAddress = armnetwork.PublicIPAddress{
	// 	Name: to.Ptr("testDNS-ip"),
	// 	Type: to.Ptr("Microsoft.Network/publicIPAddresses"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armnetwork.PublicIPAddressPropertiesFormat{
	// 		IdleTimeoutInMinutes: to.Ptr[int32](4),
	// 		IPConfiguration: &armnetwork.IPConfiguration{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"),
	// 		},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		PublicIPAddressVersion: to.Ptr(armnetwork.IPVersionIPv4),
	// 		PublicIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
	// 	},
	// 	SKU: &armnetwork.PublicIPAddressSKU{
	// 		Name: to.Ptr(armnetwork.PublicIPAddressSKUNameBasic),
	// 	},
	// }
}

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");

/**
 * This sample demonstrates how to Creates or updates a static or dynamic public IP address.
 *
 * @summary Creates or updates a static or dynamic public IP address.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDefaults.json
 */
async function createPublicIPAddressDefaults() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const publicIpAddressName = "test-ip";
  const parameters = { location: "eastus" };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.publicIPAddresses.beginCreateOrUpdateAndWait(
    resourceGroupName,
    publicIpAddressName,
    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

dotnet

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDefaults.json
// this example is just showing the usage of "PublicIPAddresses_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 PublicIPAddressResource
PublicIPAddressCollection collection = resourceGroupResource.GetPublicIPAddresses();

// invoke the operation
string publicIPAddressName = "test-ip";
PublicIPAddressData data = new PublicIPAddressData()
{
    Location = new AzureLocation("eastus"),
};
ArmOperation<PublicIPAddressResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, publicIPAddressName, data);
PublicIPAddressResource 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
PublicIPAddressData 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

Sample Response

Status code:

200

{
  "name": "testDNS-ip",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded",
    "publicIPAddressVersion": "IPv4",
    "publicIPAllocationMethod": "Dynamic",
    "idleTimeoutInMinutes": 4,
    "ipConfiguration": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"
    }
  },
  "sku": {
    "name": "Basic"
  },
  "type": "Microsoft.Network/publicIPAddresses"
}

Status code:

201

{
  "name": "testDNS-ip",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded",
    "publicIPAddressVersion": "IPv4",
    "publicIPAllocationMethod": "Dynamic",
    "idleTimeoutInMinutes": 4,
    "ipConfiguration": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"
    }
  },
  "sku": {
    "name": "Basic"
  },
  "type": "Microsoft.Network/publicIPAddresses"
}

Create public IP address DNS

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip?api-version=2023-09-01

{
  "properties": {
    "dnsSettings": {
      "domainNameLabel": "dnslbl"
    }
  },
  "location": "eastus"
}

Java

import com.azure.resourcemanager.network.fluent.models.PublicIpAddressInner;
import com.azure.resourcemanager.network.models.PublicIpAddressDnsSettings;
import com.azure.resourcemanager.network.models.PublicIpAddressDnsSettingsDomainNameLabelScope;

/**
 * Samples for PublicIpAddresses CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDns.json
     */
    /**
     * Sample code: Create public IP address DNS.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createPublicIPAddressDNS(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPublicIpAddresses().createOrUpdate("rg1", "test-ip",
            new PublicIpAddressInner().withLocation("eastus").withDnsSettings(
                new PublicIpAddressDnsSettings().withDomainNameLabel("dnslbl")),
            com.azure.core.util.Context.NONE);
    }

    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * PublicIpAddressCreateDnsWithDomainNameLabelScope.json
     */
    /**
     * Sample code: Create public IP address DNS with Domain Name Label Scope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createPublicIPAddressDNSWithDomainNameLabelScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPublicIpAddresses().createOrUpdate("rg1", "test-ip",
            new PublicIpAddressInner().withLocation("eastus")
                .withDnsSettings(new PublicIpAddressDnsSettings().withDomainNameLabel("dnslbl")
                    .withDomainNameLabelScope(PublicIpAddressDnsSettingsDomainNameLabelScope.TENANT_REUSE)),
            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 public_ip_address_create_dns.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.public_ip_addresses.begin_create_or_update(
        resource_group_name="rg1",
        public_ip_address_name="test-ip",
        parameters={"location": "eastus", "properties": {"dnsSettings": {"domainNameLabel": "dnslbl"}}},
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDns.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDns.json
func ExamplePublicIPAddressesClient_BeginCreateOrUpdate_createPublicIpAddressDns() {
	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.NewPublicIPAddressesClient().BeginCreateOrUpdate(ctx, "rg1", "test-ip", armnetwork.PublicIPAddress{
		Location: to.Ptr("eastus"),
		Properties: &armnetwork.PublicIPAddressPropertiesFormat{
			DNSSettings: &armnetwork.PublicIPAddressDNSSettings{
				DomainNameLabel: to.Ptr("dnslbl"),
			},
		},
	}, 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.PublicIPAddress = armnetwork.PublicIPAddress{
	// 	Name: to.Ptr("testDNS-ip"),
	// 	Type: to.Ptr("Microsoft.Network/publicIPAddresses"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armnetwork.PublicIPAddressPropertiesFormat{
	// 		DNSSettings: &armnetwork.PublicIPAddressDNSSettings{
	// 			DomainNameLabel: to.Ptr("dnslbl"),
	// 			Fqdn: to.Ptr("dnslbl.westus.cloudapp.azure.com"),
	// 		},
	// 		IdleTimeoutInMinutes: to.Ptr[int32](4),
	// 		IPConfiguration: &armnetwork.IPConfiguration{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"),
	// 		},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		PublicIPAddressVersion: to.Ptr(armnetwork.IPVersionIPv4),
	// 		PublicIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
	// 	},
	// }
}

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");

/**
 * This sample demonstrates how to Creates or updates a static or dynamic public IP address.
 *
 * @summary Creates or updates a static or dynamic public IP address.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDns.json
 */
async function createPublicIPAddressDns() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const publicIpAddressName = "test-ip";
  const parameters = {
    dnsSettings: { domainNameLabel: "dnslbl" },
    location: "eastus",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.publicIPAddresses.beginCreateOrUpdateAndWait(
    resourceGroupName,
    publicIpAddressName,
    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

dotnet

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDns.json
// this example is just showing the usage of "PublicIPAddresses_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 PublicIPAddressResource
PublicIPAddressCollection collection = resourceGroupResource.GetPublicIPAddresses();

// invoke the operation
string publicIPAddressName = "test-ip";
PublicIPAddressData data = new PublicIPAddressData()
{
    DnsSettings = new PublicIPAddressDnsSettings()
    {
        DomainNameLabel = "dnslbl",
    },
    Location = new AzureLocation("eastus"),
};
ArmOperation<PublicIPAddressResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, publicIPAddressName, data);
PublicIPAddressResource 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
PublicIPAddressData 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

Sample Response

Status code:

200

{
  "name": "testDNS-ip",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded",
    "publicIPAddressVersion": "IPv4",
    "publicIPAllocationMethod": "Dynamic",
    "idleTimeoutInMinutes": 4,
    "dnsSettings": {
      "domainNameLabel": "dnslbl",
      "fqdn": "dnslbl.westus.cloudapp.azure.com"
    },
    "ipConfiguration": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"
    }
  },
  "type": "Microsoft.Network/publicIPAddresses"
}

Status code:

201

{
  "name": "testDNS-ip",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded",
    "publicIPAddressVersion": "IPv4",
    "publicIPAllocationMethod": "Dynamic",
    "idleTimeoutInMinutes": 4,
    "dnsSettings": {
      "domainNameLabel": "dnslbl",
      "fqdn": "dnslbl.westus.cloudapp.azure.com"
    },
    "ipConfiguration": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"
    },
    "ddosSettings": {
      "protectionMode": "VirtualNetworkInherited"
    }
  },
  "type": "Microsoft.Network/publicIPAddresses"
}

Create public IP address DNS with Domain Name Label Scope

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip?api-version=2023-09-01

{
  "properties": {
    "dnsSettings": {
      "domainNameLabel": "dnslbl",
      "domainNameLabelScope": "TenantReuse"
    }
  },
  "location": "eastus"
}

Java

No code sample is available. To request a 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 public_ip_address_create_dns_with_domain_name_label_scope.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.public_ip_addresses.begin_create_or_update(
        resource_group_name="rg1",
        public_ip_address_name="test-ip",
        parameters={
            "location": "eastus",
            "properties": {"dnsSettings": {"domainNameLabel": "dnslbl", "domainNameLabelScope": "TenantReuse"}},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json
func ExamplePublicIPAddressesClient_BeginCreateOrUpdate_createPublicIpAddressDnsWithDomainNameLabelScope() {
	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.NewPublicIPAddressesClient().BeginCreateOrUpdate(ctx, "rg1", "test-ip", armnetwork.PublicIPAddress{
		Location: to.Ptr("eastus"),
		Properties: &armnetwork.PublicIPAddressPropertiesFormat{
			DNSSettings: &armnetwork.PublicIPAddressDNSSettings{
				DomainNameLabel:      to.Ptr("dnslbl"),
				DomainNameLabelScope: to.Ptr(armnetwork.PublicIPAddressDNSSettingsDomainNameLabelScopeTenantReuse),
			},
		},
	}, 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.PublicIPAddress = armnetwork.PublicIPAddress{
	// 	Name: to.Ptr("testDNS-ip"),
	// 	Type: to.Ptr("Microsoft.Network/publicIPAddresses"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armnetwork.PublicIPAddressPropertiesFormat{
	// 		DNSSettings: &armnetwork.PublicIPAddressDNSSettings{
	// 			DomainNameLabel: to.Ptr("dnslbl"),
	// 			DomainNameLabelScope: to.Ptr(armnetwork.PublicIPAddressDNSSettingsDomainNameLabelScopeTenantReuse),
	// 			Fqdn: to.Ptr("dnslbl.hxdwgjcdfgbhgebs.eastus.sysgen.cloudapp.azure.com"),
	// 		},
	// 		IdleTimeoutInMinutes: to.Ptr[int32](4),
	// 		IPConfiguration: &armnetwork.IPConfiguration{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"),
	// 		},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		PublicIPAddressVersion: to.Ptr(armnetwork.IPVersionIPv4),
	// 		PublicIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
	// 	},
	// }
}

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");

/**
 * This sample demonstrates how to Creates or updates a static or dynamic public IP address.
 *
 * @summary Creates or updates a static or dynamic public IP address.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json
 */
async function createPublicIPAddressDnsWithDomainNameLabelScope() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const publicIpAddressName = "test-ip";
  const parameters = {
    dnsSettings: {
      domainNameLabel: "dnslbl",
      domainNameLabelScope: "TenantReuse",
    },
    location: "eastus",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.publicIPAddresses.beginCreateOrUpdateAndWait(
    resourceGroupName,
    publicIpAddressName,
    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

dotnet

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json
// this example is just showing the usage of "PublicIPAddresses_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 PublicIPAddressResource
PublicIPAddressCollection collection = resourceGroupResource.GetPublicIPAddresses();

// invoke the operation
string publicIPAddressName = "test-ip";
PublicIPAddressData data = new PublicIPAddressData()
{
    DnsSettings = new PublicIPAddressDnsSettings()
    {
        DomainNameLabel = "dnslbl",
        DomainNameLabelScope = PublicIPAddressDnsSettingsDomainNameLabelScope.TenantReuse,
    },
    Location = new AzureLocation("eastus"),
};
ArmOperation<PublicIPAddressResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, publicIPAddressName, data);
PublicIPAddressResource 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
PublicIPAddressData 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

Sample Response

Status code:

200

{
  "name": "testDNS-ip",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded",
    "publicIPAddressVersion": "IPv4",
    "publicIPAllocationMethod": "Dynamic",
    "idleTimeoutInMinutes": 4,
    "dnsSettings": {
      "domainNameLabel": "dnslbl",
      "domainNameLabelScope": "TenantReuse",
      "fqdn": "dnslbl.hxdwgjcdfgbhgebs.eastus.sysgen.cloudapp.azure.com"
    },
    "ipConfiguration": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"
    }
  },
  "type": "Microsoft.Network/publicIPAddresses"
}

Status code:

201

{
  "name": "testDNS-ip",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded",
    "publicIPAddressVersion": "IPv4",
    "publicIPAllocationMethod": "Dynamic",
    "idleTimeoutInMinutes": 4,
    "dnsSettings": {
      "domainNameLabel": "dnslbl",
      "domainNameLabelScope": "TenantReuse",
      "fqdn": "dnslbl.hxdwgjcdfgbhgebs.eastus.sysgen.cloudapp.azure.com"
    },
    "ipConfiguration": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1"
    },
    "ddosSettings": {
      "protectionMode": "VirtualNetworkInherited"
    }
  },
  "type": "Microsoft.Network/publicIPAddresses"
}

Definities

Name	Description
ApplicationGatewayBackendAddress	Back-endadres van een toepassingsgateway.
ApplicationGatewayBackendAddressPool	Back-endadresgroep van een toepassingsgateway.
ApplicationGatewayIPConfiguration	IP-configuratie van een toepassingsgateway. Momenteel is 1 openbare en 1 privé-IP-configuratie toegestaan.
ApplicationSecurityGroup	Een toepassingsbeveiligingsgroep in een resourcegroep.
AutoApproval	De lijst met automatische goedkeuring van de Private Link-service.
BackendAddressPool	Pool van back-end-IP-adressen.
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
CustomDnsConfigPropertiesFormat	Bevat aangepaste DNS-omzettingsconfiguratie van de klant.
DdosSettings	Bevat de DDoS-beveiligingsinstellingen van het openbare IP-adres.
DdosSettingsProtectionMode	De DDoS-beveiligingsmodus van het openbare IP-adres
Delegation	Details van de service waaraan het subnet is gedelegeerd.
DeleteOptions	Opgeven wat er met het openbare IP-adres gebeurt wanneer de VM die deze gebruikt, wordt verwijderd
ExtendedLocation	Complex type ExtendedLocation.
ExtendedLocationTypes	Het type van de uitgebreide locatie.
FlowLog	Een stroomlogboekresource.
FlowLogFormatParameters	Parameters die de indeling van het stroomlogboek definiëren.
FlowLogFormatType	Het bestandstype van het stroomlogboek.
FrontendIPConfiguration	Front-end-IP-adres van de load balancer.
GatewayLoadBalancerTunnelInterface	Gateway load balancer tunnelinterface van een back-endadresgroep van load balancer.
GatewayLoadBalancerTunnelInterfaceType	Het verkeerstype van de tunnelinterface van de gateway load balancer.
GatewayLoadBalancerTunnelProtocol	Protocol van de tunnelinterface van de gateway load balancer.
InboundNatRule	Inkomende NAT-regel van de load balancer.
IPAllocationMethod	Methode voor ip-adrestoewijzing.
IPConfiguration	IP-configuratie.
IPConfigurationProfile	Onderliggende resource van IP-configuratieprofiel.
IpTag	Bevat de IpTag die is gekoppeld aan het -object.
IPVersion	IP-adresversie.
LoadBalancerBackendAddress	Back-endadressen van load balancer.
LoadBalancerBackendAddressAdminState	Een lijst met beheerstatussen die eenmaal zijn ingesteld, kan de statustest overschrijven, zodat Load Balancer altijd nieuwe verbindingen doorstuurt naar de back-end, of nieuwe verbindingen weigert en bestaande verbindingen opnieuw instelt.
NatGateway	Nat Gateway-resource.
NatGatewaySku	SKU van nat-gateway.
NatGatewaySkuName	Naam van nat-gateway-SKU.
NatRulePortMapping	Afzonderlijke poorttoewijzingen voor inkomende NAT-regel die is gemaakt voor de back-endpool.
NetworkInterface	Een netwerkinterface in een resourcegroep.
NetworkInterfaceAuxiliaryMode	Hulpmodus van de netwerkinterfaceresource.
NetworkInterfaceAuxiliarySku	Hulp-SKU van netwerkinterfaceresource.
NetworkInterfaceDnsSettings	DNS-instellingen van een netwerkinterface.
NetworkInterfaceIPConfiguration	IPConfiguration in een netwerkinterface.
NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties	PrivateLinkConnection-eigenschappen voor de netwerkinterface.
NetworkInterfaceMigrationPhase	Migratiefase van netwerkinterfaceresource.
NetworkInterfaceNicType	Type netwerkinterfaceresource.
NetworkInterfaceTapConfiguration	Tik op configuratie in een netwerkinterface.
NetworkSecurityGroup	NetworkSecurityGroup-resource.
PrivateEndpoint	Privé-eindpuntresource.
PrivateEndpointConnection	PrivateEndpointConnection-resource.
PrivateEndpointIPConfiguration	Een IP-configuratie van het privé-eindpunt.
PrivateLinkService	Private Link-serviceresource.
PrivateLinkServiceConnection	PrivateLinkServiceConnection-resource.
PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.
PrivateLinkServiceIpConfiguration	De IP-configuratie van de private link-service.
ProvisioningState	De huidige inrichtingsstatus.
PublicIPAddress	Openbare IP-adresresource.
PublicIPAddressDnsSettings	Bevat de FQDN van de DNS-record die is gekoppeld aan het openbare IP-adres.
PublicIpAddressDnsSettingsDomainNameLabelScope	Het labelbereik van de domeinnaam. Als een domeinnaamlabel en een labelbereik voor domeinnamen zijn opgegeven, wordt een DNS-record gemaakt voor het openbare IP-adres in het Microsoft Azure DNS-systeem met een gehashte waarde opgenomen in FQDN.
PublicIPAddressMigrationPhase	Migratiefase van openbaar IP-adres.
PublicIPAddressSku	SKU van een openbaar IP-adres.
PublicIPAddressSkuName	Naam van een openbare IP-adres-SKU.
PublicIPAddressSkuTier	Laag van een openbare IP-adres-SKU.
ResourceNavigationLink	ResourceNavigationLink-resource.
RetentionPolicyParameters	Parameters die het bewaarbeleid voor het stroomlogboek definiëren.
Route	Routeresource.
RouteNextHopType	Het type hop in Azure waarnaar het pakket moet worden doorgestuurd.
RouteTable	Routetabelresource.
SecurityRule	Netwerkbeveiligingsregel.
SecurityRuleAccess	Of netwerkverkeer is toegestaan of geweigerd.
SecurityRuleDirection	De richting van de regel. De richting geeft aan of de regel wordt geëvalueerd voor binnenkomend of uitgaand verkeer.
SecurityRuleProtocol	Netwerkprotocol waarop deze regel van toepassing is.
ServiceAssociationLink	ServiceAssociationLink-resource.
ServiceEndpointPolicy	Resource voor service-eindpuntbeleid.
ServiceEndpointPolicyDefinition	Beleidsdefinities voor service-eindpunten.
ServiceEndpointPropertiesFormat	De eigenschappen van het service-eindpunt.
Subnet	Subnet in een virtuele netwerkresource.
SubResource	Verwijzing naar een andere subbron.
SyncMode	Back-endadressynchronisatiemodus voor de back-endpool
TrafficAnalyticsConfigurationProperties	Parameters die de configuratie van verkeersanalyse definiëren.
TrafficAnalyticsProperties	Parameters die de configuratie van verkeersanalyse definiëren.
TransportProtocol	Het transportprotocol voor het eindpunt.
VirtualNetworkPrivateEndpointNetworkPolicies	Netwerkbeleid toepassen op privé-eindpunt in het subnet in- of uitschakelen.
VirtualNetworkPrivateLinkServiceNetworkPolicies	Schakel het toepassen van netwerkbeleid op de Private Link-service in het subnet in of uit.
VirtualNetworkTap	Virtual Network Tik op resource.
Visibility	De zichtbaarheidslijst van de Private Link-service.

ApplicationGatewayBackendAddress

Back-endadres van een toepassingsgateway.

Name	Type	Description
fqdn	string	De FQDN-naam (Fully Qualified Domain Name).
ipAddress	string	IP-adres.

ApplicationGatewayBackendAddressPool

Back-endadresgroep van een toepassingsgateway.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	Naam van de back-endadresgroep die uniek is binnen een Application Gateway.
properties.backendAddresses	ApplicationGatewayBackendAddress[]	Back-endadressen.
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	Verzameling van verwijzingen naar IP-adressen die zijn gedefinieerd in netwerkinterfaces.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de resource van de back-endadresgroep.
type	string	Type van de resource.

ApplicationGatewayIPConfiguration

IP-configuratie van een toepassingsgateway. Momenteel is 1 openbare en 1 privé-IP-configuratie toegestaan.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	Naam van de IP-configuratie die uniek is binnen een Application Gateway.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de IP-configuratieresource van de toepassingsgateway.
properties.subnet	SubResource	Verwijzing naar de subnetresource. Een subnet van waaruit de toepassingsgateway het privéadres ophaalt.
type	string	Type van de resource.

ApplicationSecurityGroup

Een toepassingsbeveiligingsgroep in een resourcegroep.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de resource van de toepassingsbeveiligingsgroep.
properties.resourceGuid	string	De resource-GUID-eigenschap van de resource van de toepassingsbeveiligingsgroep. Het identificeert een resource op unieke wijze, zelfs als de gebruiker de naam wijzigt of de resource migreert tussen abonnementen of resourcegroepen.
tags	object	Resourcetags.
type	string	Resourcetype.

AutoApproval

De lijst met automatische goedkeuring van de Private Link-service.

Name	Type	Description
subscriptions	string[]	De lijst met abonnementen.

BackendAddressPool

Pool van back-end-IP-adressen.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen de set back-endadresgroepen die door de load balancer worden gebruikt. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	Een matrix met verwijzingen naar IP-adressen die zijn gedefinieerd in netwerkinterfaces.
properties.drainPeriodInSeconds	integer	Het aantal seconden waarop Load Balancer wacht voordat reset naar het client- en back-endadres wordt verzonden.
properties.inboundNatRules	SubResource[]	Een matrix met verwijzingen naar binnenkomende NAT-regels die gebruikmaken van deze back-endadresgroep.
properties.loadBalancerBackendAddresses	LoadBalancerBackendAddress[]	Een matrix met back-endadressen.
properties.loadBalancingRules	SubResource[]	Een matrix met verwijzingen naar taakverdelingsregels die gebruikmaken van deze back-endadresgroep.
properties.location	string	De locatie van de back-endadresgroep.
properties.outboundRule	SubResource	Een verwijzing naar een uitgaande regel die gebruikmaakt van deze back-endadresgroep.
properties.outboundRules	SubResource[]	Een matrix met verwijzingen naar uitgaande regels die gebruikmaken van deze back-endadresgroep.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de resource van de back-endadresgroep.
properties.syncMode	SyncMode	Back-endadressynchronisatiemodus voor de back-endpool
properties.tunnelInterfaces	GatewayLoadBalancerTunnelInterface[]	Een matrix van gateway load balancer tunnelinterfaces.
properties.virtualNetwork	SubResource	Een verwijzing naar een virtueel netwerk.
type	string	Type van de resource.

CloudError

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Hoofdtekst van cloudfout.

CloudErrorBody

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap fout.

CustomDnsConfigPropertiesFormat

Bevat aangepaste DNS-omzettingsconfiguratie van de klant.

Name	Type	Description
fqdn	string	Fqdn die wordt omgezet in het IP-adres van het privé-eindpunt.
ipAddresses	string[]	Een lijst met privé-IP-adressen van het privé-eindpunt.

DdosSettings

Bevat de DDoS-beveiligingsinstellingen van het openbare IP-adres.

Name	Type	Description
ddosProtectionPlan	SubResource	Het DDoS-beveiligingsplan dat is gekoppeld aan het openbare IP-adres. Kan alleen worden ingesteld als ProtectionMode is ingeschakeld
protectionMode	DdosSettingsProtectionMode	De DDoS-beveiligingsmodus van het openbare IP-adres

DdosSettingsProtectionMode

De DDoS-beveiligingsmodus van het openbare IP-adres

Name	Type	Description
Disabled	string
Enabled	string
VirtualNetworkInherited	string

Delegation

Details van de service waaraan het subnet is gedelegeerd.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een subnet. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.actions	string[]	De acties die zijn toegestaan voor de service bij delegatie.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de servicedelegatieresource.
properties.serviceName	string	De naam van de service waaraan het subnet moet worden gedelegeerd (bijvoorbeeld Microsoft.Sql/servers).
type	string	Resourcetype.

DeleteOptions

Opgeven wat er met het openbare IP-adres gebeurt wanneer de VM die deze gebruikt, wordt verwijderd

Name	Type	Description
Delete	string
Detach	string

ExtendedLocation

Complex type ExtendedLocation.

Name	Type	Description
name	string	De naam van de uitgebreide locatie.
type	ExtendedLocationTypes	Het type van de uitgebreide locatie.

ExtendedLocationTypes

Het type van de uitgebreide locatie.

Name	Type	Description
EdgeZone	string

FlowLog

Een stroomlogboekresource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.enabled	boolean	Vlag om stroomlogboekregistratie in of uit te schakelen.
properties.flowAnalyticsConfiguration	TrafficAnalyticsProperties	Parameters die de configuratie van verkeersanalyse definiëren.
properties.format	FlowLogFormatParameters	Parameters waarmee de indeling van het stroomlogboek wordt gedefinieerd.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van het stroomlogboek.
properties.retentionPolicy	RetentionPolicyParameters	Parameters die het bewaarbeleid voor het stroomlogboek definiëren.
properties.storageId	string	Id van het opslagaccount dat wordt gebruikt voor het opslaan van het stroomlogboek.
properties.targetResourceGuid	string	Guid van de netwerkbeveiligingsgroep waarop het stroomlogboek wordt toegepast.
properties.targetResourceId	string	Id van de netwerkbeveiligingsgroep waarop het stroomlogboek wordt toegepast.
tags	object	Resourcetags.
type	string	Resourcetype.

FlowLogFormatParameters

Parameters die de indeling van het stroomlogboek definiëren.

Name	Type	Standaardwaarde	Description
type	FlowLogFormatType		Het bestandstype van het stroomlogboek.
version	integer	0	De versie (revisie) van het stroomlogboek.

FlowLogFormatType

Het bestandstype van het stroomlogboek.

Name	Type	Description
JSON	string

FrontendIPConfiguration

Front-end-IP-adres van de load balancer.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen de set front-end-IP-configuraties die door de load balancer wordt gebruikt. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.gatewayLoadBalancer	SubResource	De verwijzing naar front-end-IP van gateway load balancer.
properties.inboundNatPools	SubResource[]	Een matrix met verwijzingen naar binnenkomende groepen die gebruikmaken van dit front-end-IP-adres.
properties.inboundNatRules	SubResource[]	Een matrix met verwijzingen naar binnenkomende regels die gebruikmaken van dit front-end-IP-adres.
properties.loadBalancingRules	SubResource[]	Een matrix met verwijzingen naar taakverdelingsregels die gebruikmaken van dit front-end-IP-adres.
properties.outboundRules	SubResource[]	Een matrix met verwijzingen naar uitgaande regels die gebruikmaken van dit front-end-IP-adres.
properties.privateIPAddress	string	Het privé-IP-adres van de IP-configuratie.
properties.privateIPAddressVersion	IPVersion	Of de specifieke ip-configuratie IPv4 of IPv6 is. De standaardwaarde wordt gebruikt als IPv4.
properties.privateIPAllocationMethod	IPAllocationMethod	De toewijzingsmethode privé-IP.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de front-end-IP-configuratieresource.
properties.publicIPAddress	PublicIPAddress	De verwijzing naar de openbare IP-resource.
properties.publicIPPrefix	SubResource	De verwijzing naar de resource Openbaar IP-voorvoegsel.
properties.subnet	Subnet	De verwijzing naar de subnetresource.
type	string	Type van de resource.
zones	string[]	Een lijst met beschikbaarheidszones die het IP-adres aangeeft dat voor de resource is toegewezen, moet afkomstig zijn.

GatewayLoadBalancerTunnelInterface

Gateway load balancer tunnelinterface van een back-endadresgroep van load balancer.

Name	Type	Description
identifier	integer	Id van de tunnelinterface van de gateway load balancer.
port	integer	Poort van gateway load balancer tunnel interface.
protocol	GatewayLoadBalancerTunnelProtocol	Protocol van de tunnelinterface van de gateway load balancer.
type	GatewayLoadBalancerTunnelInterfaceType	Het verkeerstype van de tunnelinterface van de gateway load balancer.

GatewayLoadBalancerTunnelInterfaceType

Het verkeerstype van de tunnelinterface van de gateway load balancer.

Name	Type	Description
External	string
Internal	string
None	string

GatewayLoadBalancerTunnelProtocol

Protocol van de tunnelinterface van de gateway load balancer.

Name	Type	Description
Native	string
None	string
VXLAN	string

InboundNatRule

Inkomende NAT-regel van de load balancer.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen de set binnenkomende NAT-regels die door de load balancer worden gebruikt. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.backendAddressPool	SubResource	Een verwijzing naar de resource backendAddressPool.
properties.backendIPConfiguration	NetworkInterfaceIPConfiguration	Een verwijzing naar een privé-IP-adres dat is gedefinieerd op een netwerkinterface van een VM. Verkeer dat wordt verzonden naar de front-endpoort van elk van de front-end-IP-configuraties, wordt doorgestuurd naar het back-end-IP-adres.
properties.backendPort	integer	De poort die wordt gebruikt voor het interne eindpunt. Acceptabele waarden variëren van 1 tot 65535.
properties.enableFloatingIP	boolean	Hiermee configureert u het eindpunt van een virtuele machine voor de zwevende IP-mogelijkheid die is vereist voor het configureren van een SQL AlwaysOn-beschikbaarheidsgroep. Deze instelling is vereist bij het gebruik van de SQL AlwaysOn-beschikbaarheidsgroepen in SQL Server. Deze instelling kan niet worden gewijzigd nadat u het eindpunt hebt gemaakt.
properties.enableTcpReset	boolean	Ontvang bidirectioneel TCP Opnieuw instellen bij een time-out voor niet-actieve TCP-stroom of onverwachte beëindiging van de verbinding. Dit element wordt alleen gebruikt wanneer het protocol is ingesteld op TCP.
properties.frontendIPConfiguration	SubResource	Een verwijzing naar front-end-IP-adressen.
properties.frontendPort	integer	De poort voor het externe eindpunt. Poortnummers voor elke regel moeten uniek zijn binnen de Load Balancer. Acceptabele waarden variëren van 1 tot 65534.
properties.frontendPortRangeEnd	integer	Het einde van het poortbereik voor het externe eindpunt. Deze eigenschap wordt samen met BackendAddressPool en FrontendPortRangeStart gebruikt. Afzonderlijke binnenkomende NAT-regelpoorttoewijzingen worden gemaakt voor elk back-endadres van BackendAddressPool. Acceptabele waarden variëren van 1 tot 65534.
properties.frontendPortRangeStart	integer	Het poortbereik begint voor het externe eindpunt. Deze eigenschap wordt samen met BackendAddressPool en FrontendPortRangeEnd gebruikt. Afzonderlijke binnenkomende NAT-regelpoorttoewijzingen worden gemaakt voor elk back-endadres van BackendAddressPool. Acceptabele waarden variëren van 1 tot 65534.
properties.idleTimeoutInMinutes	integer	De time-out voor de NIET-actieve TCP-verbinding. De waarde kan worden ingesteld tussen 4 en 30 minuten. De standaardwaarde is 4 minuten. Dit element wordt alleen gebruikt wanneer het protocol is ingesteld op TCP.
properties.protocol	TransportProtocol	De verwijzing naar het transportprotocol dat wordt gebruikt door de taakverdelingsregel.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de binnenkomende NAT-regelresource.
type	string	Type van de resource.

IPAllocationMethod

Methode voor ip-adrestoewijzing.

Name	Type	Description
Dynamic	string
Static	string

IPConfiguration

IP-configuratie.

Name	Type	Standaardwaarde	Description
etag	string		Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string		Resource-id.
name	string		De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.privateIPAddress	string		Het privé-IP-adres van de IP-configuratie.
properties.privateIPAllocationMethod	IPAllocationMethod	Dynamic	De toewijzingsmethode voor privé-IP-adressen.
properties.provisioningState	ProvisioningState		De inrichtingsstatus van de IP-configuratieresource.
properties.publicIPAddress	PublicIPAddress		De verwijzing naar de openbare IP-resource.
properties.subnet	Subnet		De verwijzing naar de subnetresource.

IPConfigurationProfile

Onderliggende resource van IP-configuratieprofiel.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de resource van het IP-configuratieprofiel.
properties.subnet	Subnet	De verwijzing naar de subnetresource voor het maken van een IP-configuratie van een containernetwerkinterface.
type	string	Subresourcetype.

IpTag

Bevat de IpTag die is gekoppeld aan het -object.

Name	Type	Description
ipTagType	string	Het type IP-tag. Voorbeeld: FirstPartyUsage.
tag	string	De waarde van de IP-tag die is gekoppeld aan het openbare IP-adres. Voorbeeld: SQL.

IPVersion

IP-adresversie.

Name	Type	Description
IPv4	string
IPv6	string

LoadBalancerBackendAddress

Back-endadressen van load balancer.

Name	Type	Description
name	string	Naam van het back-endadres.
properties.adminState	LoadBalancerBackendAddressAdminState	Een lijst met beheerstatussen die eenmaal zijn ingesteld, kan de statustest overschrijven, zodat Load Balancer altijd nieuwe verbindingen doorstuurt naar de back-end, of nieuwe verbindingen weigert en bestaande verbindingen opnieuw instelt.
properties.inboundNatRulesPortMapping	NatRulePortMapping[]	Verzameling van poorttoewijzingen voor binnenkomende NAT-regels.
properties.ipAddress	string	IP-adres dat deel uitmaakt van het virtuele netwerk waarnaar wordt verwezen.
properties.loadBalancerFrontendIPConfiguration	SubResource	Verwijzing naar de front-end-IP-adresconfiguratie die is gedefinieerd in regionale loadbalancer.
properties.networkInterfaceIPConfiguration	SubResource	Verwijzing naar IP-adres dat is gedefinieerd in netwerkinterfaces.
properties.subnet	SubResource	Verwijzing naar een bestaand subnet.
properties.virtualNetwork	SubResource	Verwijzing naar een bestaand virtueel netwerk.

LoadBalancerBackendAddressAdminState

Een lijst met beheerstatussen die eenmaal zijn ingesteld, kan de statustest overschrijven, zodat Load Balancer altijd nieuwe verbindingen doorstuurt naar de back-end, of nieuwe verbindingen weigert en bestaande verbindingen opnieuw instelt.

Name	Type	Description
Down	string
None	string
Up	string

NatGateway

Nat Gateway-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.idleTimeoutInMinutes	integer	De time-out voor inactiviteit van de NAT-gateway.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de NAT-gatewayresource.
properties.publicIpAddresses	SubResource[]	Een matrix van openbare IP-adressen die zijn gekoppeld aan de nat-gatewayresource.
properties.publicIpPrefixes	SubResource[]	Een matrix met openbare IP-voorvoegsels die zijn gekoppeld aan de nat-gatewayresource.
properties.resourceGuid	string	De resource-GUID-eigenschap van de NAT-gatewayresource.
properties.subnets	SubResource[]	Een matrix met verwijzingen naar de subnetten die deze NAT-gatewayresource gebruiken.
sku	NatGatewaySku	De nat-gateway-SKU.
tags	object	Resourcetags.
type	string	Resourcetype.
zones	string[]	Een lijst met beschikbaarheidszones die de zone aangeeft waarin Nat Gateway moet worden geïmplementeerd.

NatGatewaySku

SKU van nat-gateway.

Name	Type	Description
name	NatGatewaySkuName	Naam van nat-gateway-SKU.

NatGatewaySkuName

Naam van nat-gateway-SKU.

Name	Type	Description
Standard	string

NatRulePortMapping

Afzonderlijke poorttoewijzingen voor inkomende NAT-regel die is gemaakt voor de back-endpool.

Name	Type	Description
backendPort	integer	Back-endpoort.
frontendPort	integer	Front-endpoort.
inboundNatRuleName	string	Naam van binnenkomende NAT-regel.

NetworkInterface

Een netwerkinterface in een resourcegroep.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
extendedLocation	ExtendedLocation	De uitgebreide locatie van de netwerkinterface.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	Hulpmodus van netwerkinterfaceresource.
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	Hulp-SKU van netwerkinterfaceresource.
properties.disableTcpStateTracking	boolean	Hiermee wordt aangegeven of tcp-statustracering moet worden uitgeschakeld.
properties.dnsSettings	NetworkInterfaceDnsSettings	De DNS-instellingen in de netwerkinterface.
properties.dscpConfiguration	SubResource	Een verwijzing naar de dscp-configuratie waaraan de netwerkinterface is gekoppeld.
properties.enableAcceleratedNetworking	boolean	Als de netwerkinterface is geconfigureerd voor versneld netwerken. Niet van toepassing op VM-grootten waarvoor versneld netwerken zijn vereist.
properties.enableIPForwarding	boolean	Hiermee wordt aangegeven of doorsturen via IP is ingeschakeld op deze netwerkinterface.
properties.hostedWorkloads	string[]	Een lijst met verwijzingen naar gekoppelde BareMetal-resources.
properties.ipConfigurations	NetworkInterfaceIPConfiguration[]	Een lijst met IP-configuraties van de netwerkinterface.
properties.macAddress	string	Het MAC-adres van de netwerkinterface.
properties.migrationPhase	NetworkInterfaceMigrationPhase	Migratiefase van netwerkinterfaceresource.
properties.networkSecurityGroup	NetworkSecurityGroup	De verwijzing naar de NetworkSecurityGroup-resource.
properties.nicType	NetworkInterfaceNicType	Type netwerkinterfaceresource.
properties.primary	boolean	Of dit een primaire netwerkinterface op een virtuele machine is.
properties.privateEndpoint	PrivateEndpoint	Een verwijzing naar het privé-eindpunt waaraan de netwerkinterface is gekoppeld.
properties.privateLinkService	PrivateLinkService	Privatelinkservice van de netwerkinterfaceresource.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de netwerkinterfaceresource.
properties.resourceGuid	string	De resource-GUID-eigenschap van de netwerkinterfaceresource.
properties.tapConfigurations	NetworkInterfaceTapConfiguration[]	Een lijst met TapConfigurations van de netwerkinterface.
properties.virtualMachine	SubResource	De verwijzing naar een virtuele machine.
properties.vnetEncryptionSupported	boolean	Of de virtuele machine waaraan deze NIC is gekoppeld, versleuteling ondersteunt.
properties.workloadType	string	WorkloadType van de NetworkInterface voor BareMetal-resources
tags	object	Resourcetags.
type	string	Resourcetype.

NetworkInterfaceAuxiliaryMode

Hulpmodus van de netwerkinterfaceresource.

Name	Type	Description
AcceleratedConnections	string
Floating	string
MaxConnections	string
None	string

NetworkInterfaceAuxiliarySku

Hulp-SKU van netwerkinterfaceresource.

Name	Type	Description
A1	string
A2	string
A4	string
A8	string
None	string

NetworkInterfaceDnsSettings

DNS-instellingen van een netwerkinterface.

Name	Type	Description
appliedDnsServers	string[]	Als de VM die deze NIC gebruikt deel uitmaakt van een beschikbaarheidsset, bevat deze lijst de samenvoeging van alle DNS-servers van alle NIC's die deel uitmaken van de beschikbaarheidsset. Deze eigenschap is wat op elk van deze VM's is geconfigureerd.
dnsServers	string[]	Lijst met IP-adressen van DNS-servers. Gebruik 'AzureProvidedDNS' om over te schakelen naar door Azure geleverde DNS-omzetting. De waarde 'AzureProvidedDNS' kan niet worden gecombineerd met andere IP-adressen. Dit moet de enige waarde in de verzameling dnsServers zijn.
internalDnsNameLabel	string	Relatieve DNS-naam voor deze NIC die wordt gebruikt voor interne communicatie tussen VM's in hetzelfde virtuele netwerk.
internalDomainNameSuffix	string	Zelfs als internalDnsNameLabel niet is opgegeven, wordt er een DNS-vermelding gemaakt voor de primaire NIC van de VM. Deze DNS-naam kan worden samengesteld door de vm-naam samen te voegen met de waarde van internalDomainNameSuffix.
internalFqdn	string	Volledig gekwalificeerde DNS-naam die interne communicatie tussen VM's in hetzelfde virtuele netwerk ondersteunt.

NetworkInterfaceIPConfiguration

IPConfiguration in een netwerkinterface.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.applicationGatewayBackendAddressPools	ApplicationGatewayBackendAddressPool[]	De verwijzing naar de resource ApplicationGatewayBackendAddressPool.
properties.applicationSecurityGroups	ApplicationSecurityGroup[]	Toepassingsbeveiligingsgroepen waarin de IP-configuratie is opgenomen.
properties.gatewayLoadBalancer	SubResource	De verwijzing naar front-end-IP van gateway load balancer.
properties.loadBalancerBackendAddressPools	BackendAddressPool[]	De verwijzing naar de resource LoadBalancerBackendAddressPool.
properties.loadBalancerInboundNatRules	InboundNatRule[]	Een lijst met verwijzingen van LoadBalancerInboundNatRules.
properties.primary	boolean	Hiermee wordt aangegeven of dit een primair adres van de klant op de netwerkinterface is.
properties.privateIPAddress	string	Privé-IP-adres van de IP-configuratie.
properties.privateIPAddressVersion	IPVersion	Of de specifieke IP-configuratie IPv4 of IPv6 is. De standaardwaarde is IPv4.
properties.privateIPAllocationMethod	IPAllocationMethod	De toewijzingsmethode voor privé-IP-adressen.
properties.privateLinkConnectionProperties	NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties	PrivateLinkConnection-eigenschappen voor de netwerkinterface.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de IP-configuratie van de netwerkinterface.
properties.publicIPAddress	PublicIPAddress	Openbaar IP-adres dat is gebonden aan de IP-configuratie.
properties.subnet	Subnet	Subnet gebonden aan de IP-configuratie.
properties.virtualNetworkTaps	VirtualNetworkTap[]	De verwijzing naar Virtual Network tikken.
type	string	Resourcetype.

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

PrivateLinkConnection-eigenschappen voor de netwerkinterface.

Name	Type	Description
fqdns	string[]	Lijst met FQDN's voor de huidige privékoppelingsverbinding.
groupId	string	De groeps-id voor de huidige privékoppelingsverbinding.
requiredMemberName	string	De vereiste lidnaam voor de huidige privékoppelingsverbinding.

NetworkInterfaceMigrationPhase

Migratiefase van netwerkinterfaceresource.

Name	Type	Description
Abort	string
Commit	string
Committed	string
None	string
Prepare	string

NetworkInterfaceNicType

Type netwerkinterfaceresource.

Name	Type	Description
Elastic	string
Standard	string

NetworkInterfaceTapConfiguration

Tik op configuratie in een netwerkinterface.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de netwerkinterface tik op configuratieresource.
properties.virtualNetworkTap	VirtualNetworkTap	De verwijzing naar de resource Virtual Network Tap.
type	string	Subresourcetype.

NetworkSecurityGroup

NetworkSecurityGroup-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.defaultSecurityRules	SecurityRule[]	De standaardbeveiligingsregels van de netwerkbeveiligingsgroep.
properties.flowLogs	FlowLog[]	Een verzameling verwijzingen naar stroomlogboekresources.
properties.flushConnection	boolean	Wanneer deze optie is ingeschakeld, worden stromen die zijn gemaakt op basis van netwerkbeveiligingsgroepverbindingen opnieuw geëvalueerd wanneer regels worden bijgewerkt. Initiële activering activeert een nieuwe evaluatie.
properties.networkInterfaces	NetworkInterface[]	Een verzameling verwijzingen naar netwerkinterfaces.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de resource van de netwerkbeveiligingsgroep.
properties.resourceGuid	string	De resource-GUID-eigenschap van de resourcebeveiligingsgroepresource.
properties.securityRules	SecurityRule[]	Een verzameling beveiligingsregels van de netwerkbeveiligingsgroep.
properties.subnets	Subnet[]	Een verzameling verwijzingen naar subnetten.
tags	object	Resourcetags.
type	string	Resourcetype.

PrivateEndpoint

Privé-eindpuntresource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
extendedLocation	ExtendedLocation	De uitgebreide locatie van de load balancer.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.applicationSecurityGroups	ApplicationSecurityGroup[]	Toepassingsbeveiligingsgroepen waarin de IP-configuratie van het privé-eindpunt is opgenomen.
properties.customDnsConfigs	CustomDnsConfigPropertiesFormat[]	Een matrix met aangepaste DNS-configuraties.
properties.customNetworkInterfaceName	string	De aangepaste naam van de netwerkinterface die is gekoppeld aan het privé-eindpunt.
properties.ipConfigurations	PrivateEndpointIPConfiguration[]	Een lijst met IP-configuraties van het privé-eindpunt. Dit wordt gebruikt om toe te wijzen aan de eindpunten van de First Party Service.
properties.manualPrivateLinkServiceConnections	PrivateLinkServiceConnection[]	Een groepering van informatie over de verbinding met de externe resource. Wordt gebruikt wanneer de netwerkbeheerder geen toegang heeft om verbindingen met de externe resource goed te keuren.
properties.networkInterfaces	NetworkInterface[]	Een matrix met verwijzingen naar de netwerkinterfaces die voor dit privé-eindpunt zijn gemaakt.
properties.privateLinkServiceConnections	PrivateLinkServiceConnection[]	Een groepering van informatie over de verbinding met de externe resource.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de privé-eindpuntresource.
properties.subnet	Subnet	De id van het subnet waaruit het privé-IP-adres wordt toegewezen.
tags	object	Resourcetags.
type	string	Resourcetype.

PrivateEndpointConnection

PrivateEndpointConnection-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.linkIdentifier	string	De koppelings-id van de consument.
properties.privateEndpoint	PrivateEndpoint	De resource van het privé-eindpunt.
properties.privateEndpointLocation	string	De locatie van het privé-eindpunt.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de privé-eindpuntverbindingsresource.
type	string	Het resourcetype.

PrivateEndpointIPConfiguration

Een IP-configuratie van het privé-eindpunt.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
name	string	De naam van de resource die uniek is binnen een resourcegroep.
properties.groupId	string	De id van een groep die is verkregen van de externe resource waarmee dit privé-eindpunt verbinding moet maken.
properties.memberName	string	De lidnaam van een groep die is verkregen van de externe resource waarmee dit privé-eindpunt verbinding moet maken.
properties.privateIPAddress	string	Een privé-IP-adres dat is verkregen uit het subnet van het privé-eindpunt.
type	string	Het resourcetype.

PrivateLinkService

Private Link-serviceresource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
extendedLocation	ExtendedLocation	De uitgebreide locatie van de load balancer.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.alias	string	De alias van de Private Link-service.
properties.autoApproval	AutoApproval	De lijst met automatische goedkeuring van de Private Link-service.
properties.enableProxyProtocol	boolean	Of de Private Link-service is ingeschakeld voor het proxyprotocol of niet.
properties.fqdns	string[]	De lijst met Fqdn.
properties.ipConfigurations	PrivateLinkServiceIpConfiguration[]	Een matrix met IP-configuraties van de Private Link-service.
properties.loadBalancerFrontendIpConfigurations	FrontendIPConfiguration[]	Een matrix met verwijzingen naar de IP-configuraties van de load balancer.
properties.networkInterfaces	NetworkInterface[]	Een matrix met verwijzingen naar de netwerkinterfaces die zijn gemaakt voor deze Private Link-service.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Een matrix met lijst over verbindingen met het privé-eindpunt.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de private link-serviceresource.
properties.visibility	Visibility	De zichtbaarheidslijst van de Private Link-service.
tags	object	Resourcetags.
type	string	Resourcetype.

PrivateLinkServiceConnection

PrivateLinkServiceConnection-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.groupIds	string[]	De id('s) van de groep(en) die zijn verkregen uit de externe resource waarmee dit privé-eindpunt verbinding moet maken.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Een verzameling alleen-lezeninformatie over de status van de verbinding met de externe resource.
properties.privateLinkServiceId	string	De resource-id van de Private Link-service.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de verbindingsresource van de Private Link-service.
properties.requestMessage	string	Een bericht dat is doorgegeven aan de eigenaar van de externe resource met deze verbindingsaanvraag. Beperkt tot 140 tekens.
type	string	Het resourcetype.

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.

Name	Type	Description
actionsRequired	string	Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates van de consument vereisen.
description	string	De reden voor goedkeuring/afwijzing van de verbinding.
status	string	Hiermee wordt aangegeven of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

PrivateLinkServiceIpConfiguration

De IP-configuratie van de private link-service.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de IP-configuratie van de Private Link-service.
properties.primary	boolean	Of de IP-configuratie primair is of niet.
properties.privateIPAddress	string	Het privé-IP-adres van de IP-configuratie.
properties.privateIPAddressVersion	IPVersion	Of de specifieke IP-configuratie IPv4 of IPv6 is. De standaardwaarde is IPv4.
properties.privateIPAllocationMethod	IPAllocationMethod	De toewijzingsmethode voor privé-IP-adressen.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de IP-configuratieresource van de Private Link-service.
properties.subnet	Subnet	De verwijzing naar de subnetresource.
type	string	Het resourcetype.

ProvisioningState

De huidige inrichtingsstatus.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

PublicIPAddress

Openbare IP-adresresource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
extendedLocation	ExtendedLocation	De uitgebreide locatie van het openbare IP-adres.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.ddosSettings	DdosSettings	Het aangepaste DDoS-beveiligingsbeleid dat is gekoppeld aan het openbare IP-adres.
properties.deleteOption	DeleteOptions	Opgeven wat er met het openbare IP-adres gebeurt wanneer de VM die deze gebruikt, wordt verwijderd
properties.dnsSettings	PublicIPAddressDnsSettings	De FQDN van de DNS-record die is gekoppeld aan het openbare IP-adres.
properties.idleTimeoutInMinutes	integer	De time-out voor inactiviteit van het openbare IP-adres.
properties.ipAddress	string	Het IP-adres dat is gekoppeld aan de resource van het openbare IP-adres.
properties.ipConfiguration	IPConfiguration	De IP-configuratie die is gekoppeld aan het openbare IP-adres.
properties.ipTags	IpTag[]	De lijst met tags die zijn gekoppeld aan het openbare IP-adres.
properties.linkedPublicIPAddress	PublicIPAddress	Het gekoppelde openbare IP-adres van de resource van het openbare IP-adres.
properties.migrationPhase	PublicIPAddressMigrationPhase	Migratiefase van openbaar IP-adres.
properties.natGateway	NatGateway	De NatGateway voor het openbare IP-adres.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de resource van het openbare IP-adres.
properties.publicIPAddressVersion	IPVersion	De versie van het openbare IP-adres.
properties.publicIPAllocationMethod	IPAllocationMethod	De toewijzingsmethode voor openbare IP-adressen.
properties.publicIPPrefix	SubResource	Het openbare IP-voorvoegsel waaruit dit openbare IP-adres moet worden toegewezen.
properties.resourceGuid	string	De resource-GUID-eigenschap van de openbare IP-adresresource.
properties.servicePublicIPAddress	PublicIPAddress	Het openbare IP-adres van de service van de resource van het openbare IP-adres.
sku	PublicIPAddressSku	De openbare IP-adres-SKU.
tags	object	Resourcetags.
type	string	Resourcetype.
zones	string[]	Een lijst met beschikbaarheidszones die het IP-adres aangeeft dat voor de resource is toegewezen, moet afkomstig zijn.

PublicIPAddressDnsSettings

Bevat de FQDN van de DNS-record die is gekoppeld aan het openbare IP-adres.

Name	Type	Description
domainNameLabel	string	Het domeinnaamlabel. De samenvoeging van het domeinnaamlabel en de geregionaliseerde DNS-zone vormen de volledig gekwalificeerde domeinnaam die is gekoppeld aan het openbare IP-adres. Als een domeinnaamlabel is opgegeven, wordt een A DNS-record gemaakt voor het openbare IP-adres in het Microsoft Azure DNS-systeem.
domainNameLabelScope	PublicIpAddressDnsSettingsDomainNameLabelScope	Het labelbereik van de domeinnaam. Als een domeinnaamlabel en een labelbereik voor domeinnamen zijn opgegeven, wordt een DNS-record gemaakt voor het openbare IP-adres in het Microsoft Azure DNS-systeem met een gehashte waarde opgenomen in FQDN.
fqdn	string	De Fully Qualified Domain Name van de A DNS-record die is gekoppeld aan het openbare IP-adres. Dit is de samenvoeging van de domainNameLabel en de geregionaliseerde DNS-zone.
reverseFqdn	string	De omgekeerde FQDN. Een door de gebruiker zichtbare, volledig gekwalificeerde domeinnaam die wordt omgezet in dit openbare IP-adres. Als de reverseFqdn is opgegeven, wordt er een PTR DNS-record gemaakt die van het IP-adres in het domein in-addr.arpa naar de omgekeerde FQDN wijst.

PublicIpAddressDnsSettingsDomainNameLabelScope

Het labelbereik van de domeinnaam. Als een domeinnaamlabel en een labelbereik voor domeinnamen zijn opgegeven, wordt een DNS-record gemaakt voor het openbare IP-adres in het Microsoft Azure DNS-systeem met een gehashte waarde opgenomen in FQDN.

Name	Type	Description
NoReuse	string
ResourceGroupReuse	string
SubscriptionReuse	string
TenantReuse	string

PublicIPAddressMigrationPhase

Migratiefase van openbaar IP-adres.

Name	Type	Description
Abort	string
Commit	string
Committed	string
None	string
Prepare	string

PublicIPAddressSku

SKU van een openbaar IP-adres.

Name	Type	Description
name	PublicIPAddressSkuName	Naam van een openbare IP-adres-SKU.
tier	PublicIPAddressSkuTier	Laag van een openbare IP-adres-SKU.

PublicIPAddressSkuName

Naam van een openbare IP-adres-SKU.

Name	Type	Description
Basic	string
Standard	string

PublicIPAddressSkuTier

Laag van een openbare IP-adres-SKU.

Name	Type	Description
Global	string
Regional	string

ResourceNavigationLink

ResourceNavigationLink-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resourcenavigatiekoppelings-id.
name	string	Naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.link	string	Maak een koppeling naar de externe resource.
properties.linkedResourceType	string	Resourcetype van de gekoppelde resource.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de resourcenavigatiekoppelingsresource.
type	string	Resourcetype.

RetentionPolicyParameters

Parameters die het bewaarbeleid voor het stroomlogboek definiëren.

Name	Type	Standaardwaarde	Description
days	integer	0	Aantal dagen voor het bewaren van stroomlogboekrecords.
enabled	boolean	False	Vlag om retentie in of uit te schakelen.

Route

Routeresource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.addressPrefix	string	De doel-CIDR waarop de route van toepassing is.
properties.hasBgpOverride	boolean	Een waarde die aangeeft of deze route overlappende BGP-routes overschrijft, ongeacht LPM.
properties.nextHopIpAddress	string	De IP-adrespakketten moeten worden doorgestuurd naar. Volgende hopwaarden zijn alleen toegestaan in routes waarbij het volgende hoptype VirtualAppliance is.
properties.nextHopType	RouteNextHopType	Het type hop in Azure waarnaar het pakket moet worden doorgestuurd.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de routeresource.
type	string	Het type resource.

RouteNextHopType

Het type hop in Azure waarnaar het pakket moet worden doorgestuurd.

Name	Type	Description
Internet	string
None	string
VirtualAppliance	string
VirtualNetworkGateway	string
VnetLocal	string

RouteTable

Routetabelresource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.disableBgpRoutePropagation	boolean	Of de routes die door BGP in die routetabel zijn geleerd, moeten worden uitgeschakeld. Waar betekent uitschakelen.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de routetabelresource.
properties.resourceGuid	string	De resource-GUID-eigenschap van de routetabel.
properties.routes	Route[]	Verzameling van routes in een routetabel.
properties.subnets	Subnet[]	Een verzameling verwijzingen naar subnetten.
tags	object	Resourcetags.
type	string	Resourcetype.

SecurityRule

Netwerkbeveiligingsregel.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.access	SecurityRuleAccess	Het netwerkverkeer wordt toegestaan of geweigerd.
properties.description	string	Een beschrijving voor deze regel. Beperkt tot 140 tekens.
properties.destinationAddressPrefix	string	Het voorvoegsel van het doeladres. CIDR of doel-IP-bereik. Het sterretje *kan ook worden gebruikt om alle bron-IP-adressen te vinden. Standaardtags zoals 'VirtualNetwork', 'AzureLoadBalancer' en 'Internet' kunnen ook worden gebruikt.
properties.destinationAddressPrefixes	string[]	De doeladresvoorvoegsels. CIDR- of doel-IP-bereiken.
properties.destinationApplicationSecurityGroups	ApplicationSecurityGroup[]	De toepassingsbeveiligingsgroep die is opgegeven als doel.
properties.destinationPortRange	string	De doelpoort of het doelbereik. Geheel getal of bereik tussen 0 en 65535. Het sterretje *kan ook worden gebruikt om alle poorten te vinden.
properties.destinationPortRanges	string[]	De doelpoortbereiken.
properties.direction	SecurityRuleDirection	De richting van de regel. De richting geeft aan of de regel wordt geëvalueerd voor binnenkomend of uitgaand verkeer.
properties.priority	integer	De prioriteit van de regel. De waarde kan tussen 100 en 4096 zijn. Het prioriteitsnummer moet uniek zijn voor elke regel in de verzameling. Hoe lager het prioriteitsnummer, hoe hoger de prioriteit van de regel.
properties.protocol	SecurityRuleProtocol	Netwerkprotocol waarop deze regel van toepassing is.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de resource van de beveiligingsregel.
properties.sourceAddressPrefix	string	Het CIDR- of bron-IP-bereik. Het sterretje *kan ook worden gebruikt om alle bron-IP-adressen te vinden. Standaardtags zoals 'VirtualNetwork', 'AzureLoadBalancer' en 'Internet' kunnen ook worden gebruikt. Als dit een regel voor inkomend verkeer is, geeft u op waar netwerkverkeer vandaan komt.
properties.sourceAddressPrefixes	string[]	De CIDR- of bron-IP-bereiken.
properties.sourceApplicationSecurityGroups	ApplicationSecurityGroup[]	De toepassingsbeveiligingsgroep die is opgegeven als bron.
properties.sourcePortRange	string	De bronpoort of het bronbereik. Geheel getal of bereik tussen 0 en 65535. Het sterretje *kan ook worden gebruikt om alle poorten te vinden.
properties.sourcePortRanges	string[]	De bronpoortbereiken.
type	string	Het type resource.

SecurityRuleAccess

Of netwerkverkeer is toegestaan of geweigerd.

Name	Type	Description
Allow	string
Deny	string

SecurityRuleDirection

De richting van de regel. De richting geeft aan of de regel wordt geëvalueerd voor binnenkomend of uitgaand verkeer.

Name	Type	Description
Inbound	string
Outbound	string

SecurityRuleProtocol

Netwerkprotocol waarop deze regel van toepassing is.

Name	Type	Description
*	string
Ah	string
Esp	string
Icmp	string
Tcp	string
Udp	string

ServiceAssociationLink

ServiceAssociationLink-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	Naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.allowDelete	boolean	Indien waar, kan de resource worden verwijderd.
properties.link	string	Maak een koppeling naar de externe resource.
properties.linkedResourceType	string	Resourcetype van de gekoppelde resource.
properties.locations	string[]	Een lijst met locaties.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de koppelingsresource van de service.
type	string	Resourcetype.

ServiceEndpointPolicy

Resource voor service-eindpuntbeleid.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
kind	string	Soort beleid voor service-eindpunten. Dit zijn metagegevens die worden gebruikt voor de Azure Portal ervaring.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.contextualServiceEndpointPolicies	string[]	Een verzameling contextueel beleid voor service-eindpunten.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de service-eindpuntbeleidsresource.
properties.resourceGuid	string	De resource-GUID-eigenschap van de service-eindpuntbeleidsresource.
properties.serviceAlias	string	De alias die aangeeft of het beleid deel uitmaakt van een service
properties.serviceEndpointPolicyDefinitions	ServiceEndpointPolicyDefinition[]	Een verzameling beleidsdefinities voor service-eindpunten van het service-eindpuntbeleid.
properties.subnets	Subnet[]	Een verzameling verwijzingen naar subnetten.
tags	object	Resourcetags.
type	string	Resourcetype.

ServiceEndpointPolicyDefinition

Beleidsdefinities voor service-eindpunten.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.description	string	Een beschrijving voor deze regel. Beperkt tot 140 tekens.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de definitieresource van het service-eindpuntbeleid.
properties.service	string	Naam van service-eindpunt.
properties.serviceResources	string[]	Een lijst met serviceresources.
type	string	Het type resource.

ServiceEndpointPropertiesFormat

De eigenschappen van het service-eindpunt.

Name	Type	Description
locations	string[]	Een lijst met locaties.
provisioningState	ProvisioningState	De inrichtingsstatus van de service-eindpuntresource.
service	string	Het type eindpuntservice.

Subnet

Subnet in een virtuele netwerkresource.

Name	Type	Standaardwaarde	Description
etag	string		Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string		Resource-id.
name	string		De naam van de resource die uniek is binnen een resourcegroep. Deze naam kan worden gebruikt voor toegang tot de resource.
properties.addressPrefix	string		Het adresvoorvoegsel voor het subnet.
properties.addressPrefixes	string[]		Lijst met adresvoorvoegsels voor het subnet.
properties.applicationGatewayIPConfigurations	ApplicationGatewayIPConfiguration[]		IP-configuraties van toepassingsgateway van virtuele netwerkresource.
properties.defaultOutboundAccess	boolean		Stel deze eigenschap in op false om standaard uitgaande connectiviteit uit te schakelen voor alle VM's in het subnet. Deze eigenschap kan alleen worden ingesteld op het moment dat het subnet wordt gemaakt en kan niet worden bijgewerkt voor een bestaand subnet.
properties.delegations	Delegation[]		Een matrix van verwijzingen naar de delegaties in het subnet.
properties.ipAllocations	SubResource[]		Matrix van IpAllocation die verwijst naar dit subnet.
properties.ipConfigurationProfiles	IPConfigurationProfile[]		Matrix van IP-configuratieprofielen die verwijzen naar dit subnet.
properties.ipConfigurations	IPConfiguration[]		Een matrix met verwijzingen naar de IP-configuraties van de netwerkinterface met behulp van het subnet.
properties.natGateway	SubResource		Nat-gateway die is gekoppeld aan dit subnet.
properties.networkSecurityGroup	NetworkSecurityGroup		De verwijzing naar de resource NetworkSecurityGroup.
properties.privateEndpointNetworkPolicies	VirtualNetworkPrivateEndpointNetworkPolicies	Disabled	Netwerkbeleid toepassen op privé-eindpunt in het subnet in- of uitschakelen.
properties.privateEndpoints	PrivateEndpoint[]		Een matrix met verwijzingen naar privé-eindpunten.
properties.privateLinkServiceNetworkPolicies	VirtualNetworkPrivateLinkServiceNetworkPolicies	Enabled	Netwerkbeleid toepassen op private link-service in het subnet in- of uitschakelen.
properties.provisioningState	ProvisioningState		De inrichtingsstatus van de subnetresource.
properties.purpose	string		Een alleen-lezen tekenreeks die de intentie van gebruik voor dit subnet aangeeft op basis van delegaties en andere door de gebruiker gedefinieerde eigenschappen.
properties.resourceNavigationLinks	ResourceNavigationLink[]		Een matrix met verwijzingen naar de externe resources die gebruikmaken van het subnet.
properties.routeTable	RouteTable		De verwijzing naar de RouteTable-resource.
properties.serviceAssociationLinks	ServiceAssociationLink[]		Een matrix met verwijzingen naar services die in dit subnet worden geïnjecteerd.
properties.serviceEndpointPolicies	ServiceEndpointPolicy[]		Een matrix met beleidsregels voor service-eindpunten.
properties.serviceEndpoints	ServiceEndpointPropertiesFormat[]		Een matrix met service-eindpunten.
type	string		Resourcetype.

SubResource

Verwijzing naar een andere subbron.

Name	Type	Description
id	string	Resource-id.

SyncMode

Back-endadressynchronisatiemodus voor de back-endpool

Name	Type	Description
Automatic	string
Manual	string

TrafficAnalyticsConfigurationProperties

Parameters die de configuratie van verkeersanalyse definiëren.

Name	Type	Description
enabled	boolean	Vlag om verkeersanalyse in of uit te schakelen.
trafficAnalyticsInterval	integer	Het interval in minuten dat bepaalt hoe vaak de TA-service stroomanalyses moet uitvoeren.
workspaceId	string	De resource-GUID van de gekoppelde werkruimte.
workspaceRegion	string	De locatie van de gekoppelde werkruimte.
workspaceResourceId	string	Resource-id van de gekoppelde werkruimte.

TrafficAnalyticsProperties

Parameters die de configuratie van verkeersanalyse definiëren.

Name	Type	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	Parameters die de configuratie van verkeersanalyse definiëren.

TransportProtocol

Het transportprotocol voor het eindpunt.

Name	Type	Description
All	string
Tcp	string
Udp	string

VirtualNetworkPrivateEndpointNetworkPolicies

Netwerkbeleid toepassen op privé-eindpunt in het subnet in- of uitschakelen.

Name	Type	Description
Disabled	string
Enabled	string
NetworkSecurityGroupEnabled	string
RouteTableEnabled	string

VirtualNetworkPrivateLinkServiceNetworkPolicies

Schakel het toepassen van netwerkbeleid op de Private Link-service in het subnet in of uit.

Name	Type	Description
Disabled	string
Enabled	string

VirtualNetworkTap

Virtual Network Tik op resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.destinationLoadBalancerFrontEndIPConfiguration	FrontendIPConfiguration	De verwijzing naar het privé-IP-adres op de interne Load Balancer die de tik ontvangt.
properties.destinationNetworkInterfaceIPConfiguration	NetworkInterfaceIPConfiguration	De verwijzing naar het privé-IP-adres van de collector-nic die de tik ontvangt.
properties.destinationPort	integer	De VXLAN-doelpoort die het getikte verkeer ontvangt.
properties.networkInterfaceTapConfigurations	NetworkInterfaceTapConfiguration[]	Hiermee geeft u de lijst met resource-id's op voor de IP-configuratie van de netwerkinterface waarop moet worden getikt.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de virtuele netwerk-tapresource.
properties.resourceGuid	string	De resource-GUID-eigenschap van het virtuele netwerk tik resource.
tags	object	Resourcetags.
type	string	Resourcetype.

Visibility

De zichtbaarheidslijst van de Private Link-service.

Name	Type	Description
subscriptions	string[]	De lijst met abonnementen.