Edge Nodes - List

Service:

CDN

API Version:

2024-02-01

Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.

GET https://management.azure.com/providers/Microsoft.Cdn/edgenodes?api-version=2024-02-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2024-02-01.

Responses

Name	Type	Description
200 OK	EdgenodeResult	OK. The request has succeeded.
Other Status Codes	ErrorResponse	CDN 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

EdgeNodes_List

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Cdn/edgenodes?api-version=2024-02-01

Java

/**
 * Samples for EdgeNodes List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/EdgeNodes_List.json
     */
    /**
     * Sample code: EdgeNodes_List.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void edgeNodesList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getEdgeNodes().list(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.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python edge_nodes_list.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 = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.edge_nodes.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/EdgeNodes_List.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 armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/EdgeNodes_List.json
func ExampleEdgeNodesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewEdgeNodesClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.EdgenodeResult = armcdn.EdgenodeResult{
		// 	Value: []*armcdn.EdgeNode{
		// 		{
		// 			Name: to.Ptr("Standard_Verizon"),
		// 			Type: to.Ptr("Microsoft.Cdn/edgenodes"),
		// 			ID: to.Ptr("/providers/Microsoft.Cdn/edgenodes/Standard_Verizon"),
		// 			Properties: &armcdn.EdgeNodeProperties{
		// 				IPAddressGroups: []*armcdn.IPAddressGroup{
		// 					{
		// 						DeliveryRegion: to.Ptr("All"),
		// 						IPv4Addresses: []*armcdn.CidrIPAddress{
		// 							{
		// 								BaseIPAddress: to.Ptr("192.229.176.0"),
		// 								PrefixLength: to.Ptr[int32](24),
		// 							},
		// 							{
		// 								BaseIPAddress: to.Ptr("180.240.184.128"),
		// 								PrefixLength: to.Ptr[int32](25),
		// 							},
		// 							{
		// 								BaseIPAddress: to.Ptr("152.195.27.0"),
		// 								PrefixLength: to.Ptr[int32](24),
		// 						}},
		// 						IPv6Addresses: []*armcdn.CidrIPAddress{
		// 							{
		// 								BaseIPAddress: to.Ptr("2606:2800:60f2::"),
		// 								PrefixLength: to.Ptr[int32](48),
		// 							},
		// 							{
		// 								BaseIPAddress: to.Ptr("2606:2800:700c::"),
		// 								PrefixLength: to.Ptr[int32](48),
		// 						}},
		// 				}},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Premium_Verizon"),
		// 			Type: to.Ptr("Microsoft.Cdn/edgenodes"),
		// 			ID: to.Ptr("/providers/Microsoft.Cdn/edgenodes/Premium_Verizon"),
		// 			Properties: &armcdn.EdgeNodeProperties{
		// 				IPAddressGroups: []*armcdn.IPAddressGroup{
		// 					{
		// 						DeliveryRegion: to.Ptr("All"),
		// 						IPv4Addresses: []*armcdn.CidrIPAddress{
		// 							{
		// 								BaseIPAddress: to.Ptr("192.229.176.0"),
		// 								PrefixLength: to.Ptr[int32](24),
		// 							},
		// 							{
		// 								BaseIPAddress: to.Ptr("152.195.27.0"),
		// 								PrefixLength: to.Ptr[int32](24),
		// 						}},
		// 						IPv6Addresses: []*armcdn.CidrIPAddress{
		// 							{
		// 								BaseIPAddress: to.Ptr("2606:2800:60f2::"),
		// 								PrefixLength: to.Ptr[int32](48),
		// 							},
		// 							{
		// 								BaseIPAddress: to.Ptr("2606:2800:700c::"),
		// 								PrefixLength: to.Ptr[int32](48),
		// 						}},
		// 				}},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Custom_Verizon"),
		// 			Type: to.Ptr("Microsoft.Cdn/edgenodes"),
		// 			ID: to.Ptr("/providers/Microsoft.Cdn/edgenodes/Custom_Verizon"),
		// 			Properties: &armcdn.EdgeNodeProperties{
		// 				IPAddressGroups: []*armcdn.IPAddressGroup{
		// 					{
		// 						DeliveryRegion: to.Ptr("All"),
		// 						IPv4Addresses: []*armcdn.CidrIPAddress{
		// 							{
		// 								BaseIPAddress: to.Ptr("192.229.176.0"),
		// 								PrefixLength: to.Ptr[int32](24),
		// 							},
		// 							{
		// 								BaseIPAddress: to.Ptr("2606:2800:420b::"),
		// 								PrefixLength: to.Ptr[int32](48),
		// 							},
		// 							{
		// 								BaseIPAddress: to.Ptr("2606:2800:700c::"),
		// 								PrefixLength: to.Ptr[int32](48),
		// 						}},
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

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 { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.
 *
 * @summary Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/EdgeNodes_List.json
 */
async function edgeNodesList() {
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.edgeNodes.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/EdgeNodes_List.json
// this example is just showing the usage of "EdgeNodes_List" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// invoke the operation and iterate over the result
await foreach (EdgeNode item in tenantResource.GetEdgeNodesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "name": "Standard_Verizon",
      "id": "/providers/Microsoft.Cdn/edgenodes/Standard_Verizon",
      "type": "Microsoft.Cdn/edgenodes",
      "properties": {
        "ipAddressGroups": [
          {
            "deliveryRegion": "All",
            "ipv4Addresses": [
              {
                "baseIpAddress": "192.229.176.0",
                "prefixLength": 24
              },
              {
                "baseIpAddress": "180.240.184.128",
                "prefixLength": 25
              },
              {
                "baseIpAddress": "152.195.27.0",
                "prefixLength": 24
              }
            ],
            "ipv6Addresses": [
              {
                "baseIpAddress": "2606:2800:60f2::",
                "prefixLength": 48
              },
              {
                "baseIpAddress": "2606:2800:700c::",
                "prefixLength": 48
              }
            ]
          }
        ]
      }
    },
    {
      "name": "Premium_Verizon",
      "id": "/providers/Microsoft.Cdn/edgenodes/Premium_Verizon",
      "type": "Microsoft.Cdn/edgenodes",
      "properties": {
        "ipAddressGroups": [
          {
            "deliveryRegion": "All",
            "ipv4Addresses": [
              {
                "baseIpAddress": "192.229.176.0",
                "prefixLength": 24
              },
              {
                "baseIpAddress": "152.195.27.0",
                "prefixLength": 24
              }
            ],
            "ipv6Addresses": [
              {
                "baseIpAddress": "2606:2800:60f2::",
                "prefixLength": 48
              },
              {
                "baseIpAddress": "2606:2800:700c::",
                "prefixLength": 48
              }
            ]
          }
        ]
      }
    },
    {
      "name": "Custom_Verizon",
      "id": "/providers/Microsoft.Cdn/edgenodes/Custom_Verizon",
      "type": "Microsoft.Cdn/edgenodes",
      "properties": {
        "ipAddressGroups": [
          {
            "deliveryRegion": "All",
            "ipv4Addresses": [
              {
                "baseIpAddress": "192.229.176.0",
                "prefixLength": 24
              },
              {
                "baseIpAddress": "2606:2800:420b::",
                "prefixLength": 48
              },
              {
                "baseIpAddress": "2606:2800:700c::",
                "prefixLength": 48
              }
            ]
          }
        ]
      }
    }
  ]
}

Definitions

Name	Description
cidrIpAddress	CIDR Ip address
EdgeNode	Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.
EdgenodeResult	Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IdentityType	The type of identity that creates/modifies resources
IpAddressGroup	CDN Ip address group
SystemData	Read only system data

cidrIpAddress

CIDR Ip address

Name	Type	Description
baseIpAddress	string	Ip address itself.
prefixLength	integer	The length of the prefix of the ip address.

EdgeNode

Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.ipAddressGroups	IpAddressGroup[]	List of ip address groups.
systemData	SystemData	Read only system data
type	string	Resource type.

EdgenodeResult

Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.

Name	Type	Description
nextLink	string	URL to get the next set of edgenode list results if there are any.
value	EdgeNode[]	Edge node of CDN service.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IdentityType

The type of identity that creates/modifies resources

Name	Type	Description
application	string
key	string
managedIdentity	string
user	string

IpAddressGroup

CDN Ip address group

Name	Type	Description
deliveryRegion	string	The delivery region of the ip address group
ipv4Addresses	cidrIpAddress[]	The list of ip v4 addresses.
ipv6Addresses	cidrIpAddress[]	The list of ip v6 addresses.

SystemData

Read only system data

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC)
createdBy	string	An identifier for the identity that created the resource
createdByType	IdentityType	The type of identity that created the resource
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	An identifier for the identity that last modified the resource
lastModifiedByType	IdentityType	The type of identity that last modified the resource