Network Status - List By Location

Reference

Služba:: API Management

Verze rozhraní API:: 2022-08-01

Získá stav připojení k externím prostředkům, na kterých služba Api Management závisí, z cloudové služby. Tím se také vrátí servery DNS, které jsou viditelné pro cloudovou službu.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/locations/{locationName}/networkstatus?api-version=2022-08-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
locationName	path	True	string	Umístění, ve kterém je služba API Management nasazená. Jedná se o jednu z oblastí Azure, jako jsou USA – západ, USA – východ nebo USA – středojiž.
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serviceName	path	True	string	Název služby API Management. Vzor regulárního výrazu: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	NetworkStatusContract	Získá podrobnosti o stavu sítě.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementServiceGetNetworkStatusByLocation

Ukázkový požadavek

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/locations/North Central US/networkstatus?api-version=2022-08-01

/** Samples for NetworkStatus ListByLocation. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json
     */
    /**
     * Sample code: ApiManagementServiceGetNetworkStatusByLocation.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementServiceGetNetworkStatusByLocation(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .networkStatus()
            .listByLocationWithResponse("rg1", "apimService1", "North Central US", 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.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_service_get_network_status_by_location.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 = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.network_status.list_by_location(
        resource_group_name="rg1",
        service_name="apimService1",
        location_name="North Central US",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementServiceGetNetworkStatusByLocation.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 armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json
func ExampleNetworkStatusClient_ListByLocation() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNetworkStatusClient().ListByLocation(ctx, "rg1", "apimService1", "North Central US", 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.NetworkStatusContract = armapimanagement.NetworkStatusContract{
	// 	ConnectivityStatus: []*armapimanagement.ConnectivityStatusContract{
	// 		{
	// 			Name: to.Ptr("apimgmtst6tnxxxxxxxxxxx.blob.core.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(false),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.936Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:14.703Z"); return t}()),
	// 			ResourceType: to.Ptr("BlobStorage"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("apimgmtst6tnxxxxxxxxxxx.file.core.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.926Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:41.532Z"); return t}()),
	// 			ResourceType: to.Ptr("FileStorage"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("apimgmtst6tnxxxxxxxxxxx.queue.core.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.841Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:30.645Z"); return t}()),
	// 			ResourceType: to.Ptr("Queue"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("apimgmtst6tnxxxxxxxxxxx.table.core.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(false),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.936Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:23.878Z"); return t}()),
	// 			ResourceType: to.Ptr("TableStorage"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("gcs.prod.monitoring.core.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T08:07:37.548Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:57:34.866Z"); return t}()),
	// 			ResourceType: to.Ptr("Monitoring"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("https://gcs.ppe.warm.ingestion.monitoring.azure.com"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.106Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:56:26.187Z"); return t}()),
	// 			ResourceType: to.Ptr("Monitoring"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("https://global.metrics.nsatc.net/"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.051Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:56:35.962Z"); return t}()),
	// 			ResourceType: to.Ptr("Monitoring"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("https://login.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.106Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:56:30.804Z"); return t}()),
	// 			ResourceType: to.Ptr("AzureActiveDirectory"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("https://prod2.metrics.nsatc.net:1886/RecoveryService"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.279Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:56:45.209Z"); return t}()),
	// 			ResourceType: to.Ptr("Metrics"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("LocalGatewayRedis"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.936Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:15.134Z"); return t}()),
	// 			ResourceType: to.Ptr("InternalCache"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("prod.warmpath.msftcloudes.com"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(false),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:55.841Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:57.899Z"); return t}()),
	// 			ResourceType: to.Ptr("Monitoring"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("Scm"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:57.325Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T23:03:57.618Z"); return t}()),
	// 			ResourceType: to.Ptr("SourceControl"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("smtpi-xxx.msn.com:25028"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(true),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.351Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:58:22.243Z"); return t}()),
	// 			ResourceType: to.Ptr("Email"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 		},
	// 		{
	// 			Name: to.Ptr("zwcvuxxxx.database.windows.net"),
	// 			Error: to.Ptr(""),
	// 			IsOptional: to.Ptr(false),
	// 			LastStatusChange: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-20T07:54:56.041Z"); return t}()),
	// 			LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T22:55:44.358Z"); return t}()),
	// 			ResourceType: to.Ptr("SQLDatabase"),
	// 			Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 	}},
	// 	DNSServers: []*string{
	// 		to.Ptr("10.82.98.10")},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.
 *
 * @summary Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json
 */
async function apiManagementServiceGetNetworkStatusByLocation() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const locationName = "North Central US";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.networkStatus.listByLocation(
    resourceGroupName,
    serviceName,
    locationName
  );
  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

Ukázková odpověď

Stavový kód:: 200

{
  "dnsServers": [
    "10.82.98.10"
  ],
  "connectivityStatus": [
    {
      "name": "apimgmtst6tnxxxxxxxxxxx.blob.core.windows.net",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:55:14.7035899Z",
      "lastStatusChange": "2020-11-20T07:54:55.9365931Z",
      "resourceType": "BlobStorage",
      "isOptional": false
    },
    {
      "name": "apimgmtst6tnxxxxxxxxxxx.file.core.windows.net",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:55:41.5322463Z",
      "lastStatusChange": "2020-11-20T07:54:55.9265938Z",
      "resourceType": "FileStorage",
      "isOptional": true
    },
    {
      "name": "apimgmtst6tnxxxxxxxxxxx.queue.core.windows.net",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:55:30.645994Z",
      "lastStatusChange": "2020-11-20T07:54:55.8410477Z",
      "resourceType": "Queue",
      "isOptional": true
    },
    {
      "name": "apimgmtst6tnxxxxxxxxxxx.table.core.windows.net",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:55:23.8789171Z",
      "lastStatusChange": "2020-11-20T07:54:55.9365931Z",
      "resourceType": "TableStorage",
      "isOptional": false
    },
    {
      "name": "gcs.prod.monitoring.core.windows.net",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:57:34.8666833Z",
      "lastStatusChange": "2020-11-20T08:07:37.5486932Z",
      "resourceType": "Monitoring",
      "isOptional": true
    },
    {
      "name": "https://gcs.ppe.warm.ingestion.monitoring.azure.com",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:56:26.1870188Z",
      "lastStatusChange": "2020-11-20T07:54:56.1060523Z",
      "resourceType": "Monitoring",
      "isOptional": true
    },
    {
      "name": "https://global.metrics.nsatc.net/",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:56:35.9620612Z",
      "lastStatusChange": "2020-11-20T07:54:56.0510519Z",
      "resourceType": "Monitoring",
      "isOptional": true
    },
    {
      "name": "https://login.windows.net",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:56:30.8047708Z",
      "lastStatusChange": "2020-11-20T07:54:56.1060523Z",
      "resourceType": "AzureActiveDirectory",
      "isOptional": true
    },
    {
      "name": "https://prod2.metrics.nsatc.net:1886/RecoveryService",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:56:45.2095302Z",
      "lastStatusChange": "2020-11-20T07:54:56.2796235Z",
      "resourceType": "Metrics",
      "isOptional": true
    },
    {
      "name": "LocalGatewayRedis",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:55:15.1345836Z",
      "lastStatusChange": "2020-11-20T07:54:55.9365931Z",
      "resourceType": "InternalCache",
      "isOptional": true
    },
    {
      "name": "prod.warmpath.msftcloudes.com",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:55:57.8992141Z",
      "lastStatusChange": "2020-11-20T07:54:55.8410477Z",
      "resourceType": "Monitoring",
      "isOptional": false
    },
    {
      "name": "Scm",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T23:03:57.6187917Z",
      "lastStatusChange": "2020-11-20T07:54:57.325384Z",
      "resourceType": "SourceControl",
      "isOptional": true
    },
    {
      "name": "smtpi-xxx.msn.com:25028",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:58:22.2430074Z",
      "lastStatusChange": "2020-11-20T07:54:56.3510577Z",
      "resourceType": "Email",
      "isOptional": true
    },
    {
      "name": "zwcvuxxxx.database.windows.net",
      "status": "success",
      "error": "",
      "lastUpdated": "2020-11-24T22:55:44.3582171Z",
      "lastStatusChange": "2020-11-20T07:54:56.0410467Z",
      "resourceType": "SQLDatabase",
      "isOptional": false
    }
  ]
}

Definice

Name	Description
ConnectivityStatusContract	Podrobnosti o připojení k prostředku
ConnectivityStatusType	Identifikátor typu stavu připojení k prostředku.
ErrorFieldContract	Chyba Kontrakt pole.
ErrorResponse	Odpověď na chybu.
NetworkStatusContract	Podrobnosti o stavu sítě.

ConnectivityStatusContract

Podrobnosti o připojení k prostředku

Name	Typ	Description
error	string	Podrobnosti o chybě připojení k prostředku
isOptional	boolean	Jestli je to volitelné.
lastStatusChange	string	Datum, kdy se stav připojení k prostředku naposledy změnil z úspěchu na selhání nebo naopak. Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
lastUpdated	string	Datum poslední aktualizace stavu připojení prostředku. Tento stav by se měl aktualizovat každých 15 minut. Pokud se tento stav neaktualizoval, znamená to, že služba ztratila síťové připojení k prostředku ze Virtual Network. Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
name	string	Název hostitele prostředku, na kterém služba závisí. Může se jednat o databázi, úložiště nebo jakýkoli jiný prostředek Azure, na kterém služba závisí.
resourceType	string	Typ prostředku.
status	ConnectivityStatusType	Identifikátor typu stavu připojení k prostředku.

ConnectivityStatusType

Identifikátor typu stavu připojení k prostředku.

Name	Typ	Description
failure	string
initializing	string
success	string

ErrorFieldContract

Chyba Kontrakt pole.

Name	Typ	Description
code	string	Kód chyby na úrovni vlastnosti.
message	string	Čitelné znázornění chyby na úrovni vlastností.
target	string	Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error.code	string	Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
error.details	ErrorFieldContract[]	Seznam neplatných polí se odešle v žádosti v případě chyby ověření.
error.message	string	Znázornění chyby čitelné pro člověka

NetworkStatusContract

Podrobnosti o stavu sítě.

Name	Typ	Description
connectivityStatus	ConnectivityStatusContract[]	Získá seznam stavu připojení k prostředkům, na kterých služba závisí.
dnsServers	string[]	Získá seznam IPV4 adres serverů DNS.

Sdílet prostřednictvím

Network Status - List By Location

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ApiManagementServiceGetNetworkStatusByLocation

Ukázkový požadavek

Ukázková odpověď

Definice

ConnectivityStatusContract

ConnectivityStatusType

ErrorFieldContract

ErrorResponse

NetworkStatusContract

Další materiály