Network Watchers - List Available Providers

Referenz

Service:: Network Watcher

API Version:: 2023-09-01

HINWEIS: Dieses Feature befindet sich derzeit in der Vorschauphase und wird noch auf Stabilität getestet. Listen alle verfügbaren Internetdienstanbieter für eine angegebene Azure-Region.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/availableProvidersList?api-version=2023-09-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
networkWatcherName	path	True	string	Der Name der Network Watcher-Ressource.
resourceGroupName	path	True	string	Der Name der Network Watcher-Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
azureLocations	string[]	Eine Liste der Azure-Regionen.
city	string	Die Liste der verfügbaren Anbieter.
country	string	Die Liste des Landes für verfügbare Anbieter.
state	string	Die Statusliste für verfügbare Anbieter.

Antworten

Name	Typ	Beschreibung
200 OK	AvailableProvidersList	Erfolgreiche Anforderung für die Liste der verfügbaren Anbieter.
202 Accepted	AvailableProvidersList	Akzeptiert, und der Vorgang wird asynchron abgeschlossen.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get Available Providers List

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/availableProvidersList?api-version=2023-09-01

{
  "azureLocations": [
    "West US"
  ],
  "country": "United States",
  "state": "washington",
  "city": "seattle"
}


import com.azure.resourcemanager.network.models.AvailableProvidersListParameters;
import java.util.Arrays;

/**
 * Samples for NetworkWatchers ListAvailableProviders.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * NetworkWatcherAvailableProvidersListGet.json
     */
    /**
     * Sample code: Get Available Providers List.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAvailableProvidersList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getNetworkWatchers().listAvailableProviders("rg1", "nw1",
            new AvailableProvidersListParameters().withAzureLocations(Arrays.asList("West US"))
                .withCountry("United States").withState("washington").withCity("seattle"),
            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 network_watcher_available_providers_list_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.network_watchers.begin_list_available_providers(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        parameters={
            "azureLocations": ["West US"],
            "city": "seattle",
            "country": "United States",
            "state": "washington",
        },
    ).result()
    print(response)


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

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

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/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/NetworkWatcherAvailableProvidersListGet.json
func ExampleWatchersClient_BeginListAvailableProviders() {
	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.NewWatchersClient().BeginListAvailableProviders(ctx, "rg1", "nw1", armnetwork.AvailableProvidersListParameters{
		AzureLocations: []*string{
			to.Ptr("West US")},
		City:    to.Ptr("seattle"),
		Country: to.Ptr("United States"),
		State:   to.Ptr("washington"),
	}, 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.AvailableProvidersList = armnetwork.AvailableProvidersList{
	// 	Countries: []*armnetwork.AvailableProvidersListCountry{
	// 		{
	// 			CountryName: to.Ptr("United States"),
	// 			States: []*armnetwork.AvailableProvidersListState{
	// 				{
	// 					Cities: []*armnetwork.AvailableProvidersListCity{
	// 						{
	// 							CityName: to.Ptr("seattle"),
	// 							Providers: []*string{
	// 								to.Ptr("Comcast Cable Communications, Inc. - ASN 7922"),
	// 								to.Ptr("Comcast Cable Communications, LLC - ASN 7922"),
	// 								to.Ptr("Level 3 Communications, Inc. (GBLX) - ASN 3549"),
	// 								to.Ptr("Qwest Communications Company, LLC - ASN 209")},
	// 						}},
	// 						StateName: to.Ptr("washington"),
	// 				}},
	// 		}},
	// 	}
}

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 NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.
 *
 * @summary NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherAvailableProvidersListGet.json
 */
async function getAvailableProvidersList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const parameters = {
    azureLocations: ["West US"],
    city: "seattle",
    country: "United States",
    state: "washington",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkWatchers.beginListAvailableProvidersAndWait(
    resourceGroupName,
    networkWatcherName,
    parameters,
  );
  console.log(result);
}

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

using 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/NetworkWatcherAvailableProvidersListGet.json
// this example is just showing the usage of "NetworkWatchers_ListAvailableProviders" 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 NetworkWatcherResource created on azure
// for more information of creating NetworkWatcherResource, please refer to the document of NetworkWatcherResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkWatcherName = "nw1";
ResourceIdentifier networkWatcherResourceId = NetworkWatcherResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkWatcherName);
NetworkWatcherResource networkWatcher = client.GetNetworkWatcherResource(networkWatcherResourceId);

// invoke the operation
AvailableProvidersListContent content = new AvailableProvidersListContent()
{
    AzureLocations =
    {
    new AzureLocation("West US")
    },
    Country = "United States",
    State = "washington",
    City = "seattle",
};
ArmOperation<AvailableProvidersList> lro = await networkWatcher.GetAvailableProvidersAsync(WaitUntil.Completed, content);
AvailableProvidersList result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

{
  "countries": [
    {
      "countryName": "United States",
      "states": [
        {
          "stateName": "washington",
          "cities": [
            {
              "cityName": "seattle",
              "providers": [
                "Comcast Cable Communications, Inc. - ASN 7922",
                "Comcast Cable Communications, LLC - ASN 7922",
                "Level 3 Communications, Inc. (GBLX) - ASN 3549",
                "Qwest Communications Company, LLC - ASN 209"
              ]
            }
          ]
        }
      ]
    }
  ]
}

Status code:: 202

Location: https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/availableProvidersList?api-version=2023-09-01

Response Body

{
  "countries": [
    {
      "countryName": "United States",
      "states": [
        {
          "stateName": "washington",
          "cities": [
            {
              "cityName": "seattle",
              "providers": [
                "Comcast Cable Communications, Inc. - ASN 7922",
                "Comcast Cable Communications, LLC - ASN 7922",
                "Level 3 Communications, Inc. (GBLX) - ASN 3549",
                "Qwest Communications Company, LLC - ASN 209"
              ]
            }
          ]
        }
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
AvailableProvidersList	Liste der verfügbaren Länder mit Details.
AvailableProvidersListCity	Stadt- oder Stadtdetails.
AvailableProvidersListCountry	Länderdetails.
AvailableProvidersListParameters	Einschränkungen, die die Liste der verfügbaren Internetdienstanbieter bestimmen.
AvailableProvidersListState	Statusdetails.
ErrorDetails	Allgemeine Darstellung von Fehlerdetails.
ErrorResponse	Das Fehlerobjekt.

AvailableProvidersList

Liste der verfügbaren Länder mit Details.

Name	Typ	Beschreibung
countries	AvailableProvidersListCountry[]	Liste der verfügbaren Länder.

AvailableProvidersListCity

Stadt- oder Stadtdetails.

Name	Typ	Beschreibung
cityName	string	Der Name der Stadt oder der Stadt.
providers	string[]	Eine Liste der Internetdienstanbieter.

AvailableProvidersListCountry

Länderdetails.

Name	Typ	Beschreibung
countryName	string	Der Name des Landes.
providers	string[]	Eine Liste der Internetdienstanbieter.
states	AvailableProvidersListState[]	Liste der verfügbaren Staaten im Land.

AvailableProvidersListParameters

Einschränkungen, die die Liste der verfügbaren Internetdienstanbieter bestimmen.

Name	Typ	Beschreibung
azureLocations	string[]	Eine Liste der Azure-Regionen.
city	string	Die Liste der verfügbaren Anbieter.
country	string	Die Liste des Landes für verfügbare Anbieter.
state	string	Die Statusliste für verfügbare Anbieter.

AvailableProvidersListState

Statusdetails.

Name	Typ	Beschreibung
cities	AvailableProvidersListCity[]	Liste der verfügbaren Städte im Bundesstaat.
providers	string[]	Eine Liste der Internetdienstanbieter.
stateName	string	Der Statusname.

ErrorDetails

Allgemeine Darstellung von Fehlerdetails.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung.
target	string	Fehlerziel.

ErrorResponse

Das Fehlerobjekt.

Name	Typ	Beschreibung
error	ErrorDetails	Fehler Das Fehlerdetails-Objekt.