NetApp Resource Region Infos - List

Service:

Azure NetApp Files

API Version:

2025-01-01

Describes region specific information.
Provides region specific information.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos?api-version=2025-01-01

URI Parameters

Name	In	Required	Type	Description
location	path	True	string minLength: 1	The name of the Azure region.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	regionInfosList	OK
Other Status Codes	ErrorResponse	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

RegionInfos_List

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/regionInfos?api-version=2025-01-01

Java

/**
 * Samples for NetAppResourceRegionInfos List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/RegionInfos_List.json
     */
    /**
     * Sample code: RegionInfos_List.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void regionInfosList(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.netAppResourceRegionInfos().list("eastus", 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.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python region_infos_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 = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.net_app_resource_region_infos.list(
        location="eastus",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/RegionInfos_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 armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/27046dbff974e3901970aa53b29cec6d8ec1342a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/RegionInfos_List.json
func ExampleResourceRegionInfosClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewResourceRegionInfosClient().NewListPager("eastus", 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.RegionInfosList = armnetapp.RegionInfosList{
		// 	Value: []*armnetapp.RegionInfoResource{
		// 		{
		// 			Name: to.Ptr("eastus/default"),
		// 			Type: to.Ptr("Microsoft.NetApp/locations/regionInfos"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/regionInfos/default"),
		// 			Properties: &armnetapp.RegionInfo{
		// 				AvailabilityZoneMappings: []*armnetapp.RegionInfoAvailabilityZoneMappingsItem{
		// 					{
		// 						AvailabilityZone: to.Ptr("1"),
		// 						IsAvailable: to.Ptr(true),
		// 					},
		// 					{
		// 						AvailabilityZone: to.Ptr("2"),
		// 						IsAvailable: to.Ptr(true),
		// 					},
		// 					{
		// 						AvailabilityZone: to.Ptr("3"),
		// 						IsAvailable: to.Ptr(true),
		// 				}},
		// 				StorageToNetworkProximity: to.Ptr(armnetapp.RegionStorageToNetworkProximityT2),
		// 			},
		// 	}},
		// }
	}
}

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 { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Provides region specific information.
 *
 * @summary Provides region specific information.
 * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/RegionInfos_List.json
 */
async function regionInfosList() {
  const subscriptionId =
    process.env["NETAPP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const location = "eastus";
  const credential = new DefaultAzureCredential();
  const client = new NetAppManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.netAppResourceRegionInfos.list(location)) {
    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.Resources;
using Azure.ResourceManager.NetApp;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/stable/2025-01-01/examples/RegionInfos_List.json
// this example is just showing the usage of "NetAppResourceRegionInfos_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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this RegionInfoResource
AzureLocation location = new AzureLocation("eastus");
RegionInfoResourceCollection collection = subscriptionResource.GetRegionInfoResources(location);

// invoke the operation and iterate over the result
await foreach (RegionInfoResource item in collection.GetAllAsync())
{
    // the variable item 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
    RegionInfoResourceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/regionInfos/default",
      "name": "eastus/default",
      "type": "Microsoft.NetApp/locations/regionInfos",
      "properties": {
        "storageToNetworkProximity": "T2",
        "availabilityZoneMappings": [
          {
            "availabilityZone": "1",
            "isAvailable": true
          },
          {
            "availabilityZone": "2",
            "isAvailable": true
          },
          {
            "availabilityZone": "3",
            "isAvailable": true
          }
        ]
      }
    }
  ]
}

Definitions

Name	Description
AvailabilityZoneMappings	Logical availability zone mappings.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
regionInfoResource	Information regarding regionInfo Item.
regionInfosList	List of regionInfo resources
RegionStorageToNetworkProximity	Storage to Network Proximity
systemData	Metadata pertaining to creation and last modification of the resource.

AvailabilityZoneMappings

Object

Logical availability zone mappings.

Name	Type	Description
availabilityZone	string	Logical availability zone.
isAvailable	boolean	Available availability zone

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

regionInfoResource

Object

Information regarding regionInfo Item.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.availabilityZoneMappings	AvailabilityZoneMappings[]	Logical availability zone mappings. Provides logical availability zone mappings for the subscription for a region.
properties.storageToNetworkProximity	RegionStorageToNetworkProximity	Storage to Network Proximity Provides storage to network proximity information in the region.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

regionInfosList

Object

List of regionInfo resources

Name	Type	Description
nextLink	string	URL to get the next set of results.
value	regionInfoResource[]	A list of regionInfo resources

RegionStorageToNetworkProximity

Enumeration

Storage to Network Proximity

Value	Description
Default	Basic network connectivity.
T1	Standard T1 network connectivity.
T2	Standard T2 network connectivity.
AcrossT2	Standard AcrossT2 network connectivity.
T1AndT2	Standard T1 and T2 network connectivity.
T1AndAcrossT2	Standard T1 and AcrossT2 network connectivity.
T2AndAcrossT2	Standard T2 and AcrossT2 network connectivity.
T1AndT2AndAcrossT2	Standard T1, T2 and AcrossT2 network connectivity.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.