Custom IP Prefixes - Get

Reference

Service:: Virtual Networks

API Version:: 2024-03-01

Gets the specified custom IP prefix in a specified resource group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}?api-version=2024-03-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}?api-version=2024-03-01&$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
customIpPrefixName	path	True	string	The name of the custom IP prefix.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.
$expand	query		string	Expands referenced resources.

Responses

Name	Type	Description
200 OK	CustomIpPrefix	Request successful. The operation returns the resulting CustomIpPrefix resource.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get custom IP prefix

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix?api-version=2024-03-01


/**
 * Samples for CustomIpPrefixes GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/CustomIpPrefixGet.json
     */
    /**
     * Sample code: Get custom IP prefix.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getCustomIPPrefix(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getCustomIpPrefixes().getByResourceGroupWithResponse("rg1",
            "test-customipprefix", null, com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python custom_ip_prefix_get.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.custom_ip_prefixes.get(
        resource_group_name="rg1",
        custom_ip_prefix_name="test-customipprefix",
    )
    print(response)


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

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

package armnetwork_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/CustomIpPrefixGet.json
func ExampleCustomIPPrefixesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCustomIPPrefixesClient().Get(ctx, "rg1", "test-customipprefix", &armnetwork.CustomIPPrefixesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CustomIPPrefix = armnetwork.CustomIPPrefix{
	// 	Name: to.Ptr("test-customipprefix"),
	// 	Type: to.Ptr("Microsoft.Network/customIpPrefixes"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix"),
	// 	Location: to.Ptr("westus"),
	// 	Etag: to.Ptr("W/\"00000000-0000-0000-0000-00000000\""),
	// 	Properties: &armnetwork.CustomIPPrefixPropertiesFormat{
	// 		AuthorizationMessage: to.Ptr("authorizationMessage"),
	// 		ChildCustomIPPrefixes: []*armnetwork.SubResource{
	// 		},
	// 		Cidr: to.Ptr("0.0.0.0/24"),
	// 		CommissionedState: to.Ptr(armnetwork.CommissionedStateCommissioned),
	// 		ExpressRouteAdvertise: to.Ptr(false),
	// 		FailedReason: to.Ptr(""),
	// 		NoInternetAdvertise: to.Ptr(false),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		PublicIPPrefixes: []*armnetwork.SubResource{
	// 		},
	// 		ResourceGUID: to.Ptr("00000000-0000-0000-0000-00000000"),
	// 		SignedMessage: to.Ptr("signedMessage"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets the specified custom IP prefix in a specified resource group.
 *
 * @summary Gets the specified custom IP prefix in a specified resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/CustomIpPrefixGet.json
 */
async function getCustomIPPrefix() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const customIpPrefixName = "test-customipprefix";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.customIPPrefixes.get(resourceGroupName, customIpPrefixName);
  console.log(result);
}

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

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/CustomIpPrefixGet.json
// this example is just showing the usage of "CustomIPPrefixes_Get" 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 CustomIPPrefixResource
CustomIPPrefixCollection collection = resourceGroupResource.GetCustomIPPrefixes();

// invoke the operation
string customIPPrefixName = "test-customipprefix";
NullableResponse<CustomIPPrefixResource> response = await collection.GetIfExistsAsync(customIPPrefixName);
CustomIPPrefixResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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
    CustomIPPrefixData 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": "test-customipprefix",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix",
  "etag": "W/\"00000000-0000-0000-0000-00000000\"",
  "location": "westus",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceGuid": "00000000-0000-0000-0000-00000000",
    "cidr": "0.0.0.0/24",
    "commissionedState": "Commissioned",
    "signedMessage": "signedMessage",
    "authorizationMessage": "authorizationMessage",
    "noInternetAdvertise": false,
    "expressRouteAdvertise": false,
    "failedReason": "",
    "publicIpPrefixes": [],
    "childCustomIpPrefixes": []
  },
  "type": "Microsoft.Network/customIpPrefixes"
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
CommissionedState	The commissioned state of the Custom IP Prefix.
CustomIpPrefix	Custom IP prefix resource.
CustomIpPrefixType	Type of custom IP prefix. Should be Singular, Parent, or Child.
ExtendedLocation	ExtendedLocation complex type.
ExtendedLocationTypes	The type of the extended location.
Geo	The Geo for CIDR advertising. Should be an Geo code.
ProvisioningState	The current provisioning state.
SubResource	Reference to another subresource.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

CommissionedState

The commissioned state of the Custom IP Prefix.

Name	Type	Description
Commissioned	string
CommissionedNoInternetAdvertise	string
Commissioning	string
Decommissioning	string
Deprovisioned	string
Deprovisioning	string
Provisioned	string
Provisioning	string

CustomIpPrefix

Custom IP prefix resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	ExtendedLocation	The extended location of the custom IP prefix.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.asn	string	The ASN for CIDR advertising. Should be an integer as string.
properties.authorizationMessage	string	Authorization message for WAN validation.
properties.childCustomIpPrefixes	SubResource[]	The list of all Children for IPv6 /48 CustomIpPrefix.
properties.cidr	string	The prefix range in CIDR notation. Should include the start address and the prefix length.
properties.commissionedState	CommissionedState	The commissioned state of the Custom IP Prefix.
properties.customIpPrefixParent	SubResource	The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.
properties.expressRouteAdvertise	boolean	Whether to do express route advertise.
properties.failedReason	string	The reason why resource is in failed state.
properties.geo	Geo	The Geo for CIDR advertising. Should be an Geo code.
properties.noInternetAdvertise	boolean	Whether to Advertise the range to Internet.
properties.prefixType	CustomIpPrefixType	Type of custom IP prefix. Should be Singular, Parent, or Child.
properties.provisioningState	ProvisioningState	The provisioning state of the custom IP prefix resource.
properties.publicIpPrefixes	SubResource[]	The list of all referenced PublicIpPrefixes.
properties.resourceGuid	string	The resource GUID property of the custom IP prefix resource.
properties.signedMessage	string	Signed message for WAN validation.
tags	object	Resource tags.
type	string	Resource type.
zones	string[]	A list of availability zones denoting the IP allocated for the resource needs to come from.

CustomIpPrefixType

Type of custom IP prefix. Should be Singular, Parent, or Child.

Name	Type	Description
Child	string
Parent	string
Singular	string

ExtendedLocation

ExtendedLocation complex type.

Name	Type	Description
name	string	The name of the extended location.
type	ExtendedLocationTypes	The type of the extended location.

ExtendedLocationTypes

The type of the extended location.

Name	Type	Description
EdgeZone	string

Geo

The Geo for CIDR advertising. Should be an Geo code.

Name	Type	Description
AFRI	string
APAC	string
AQ	string
EURO	string
GLOBAL	string
LATAM	string
ME	string
NAM	string
OCEANIA	string

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.