Network Status - List By Service

Service:

API Management

API Version:

2022-08-01

Obtém o Status de Conectividade para os recursos externos dos quais o serviço de Gerenciamento de API depende de dentro do Serviço de Nuvem. Isso também retorna os servidores DNS como visíveis para o CloudService.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName	path	True	string	O nome do serviço Gerenciamento de API. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	NetworkStatusContractByLocation[]	Obtém a lista Detalhes de status de rede para todas as regiões em que o serviço é implantado.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementServiceGetNetworkStatus

Sample Request

HTTP

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

Java

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_service_get_network_status.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_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementServiceGetNetworkStatus.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 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/ApiManagementServiceGetNetworkStatus.json
func ExampleNetworkStatusClient_ListByService() {
	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().ListByService(ctx, "rg1", "apimService1", 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.NetworkStatusContractByLocationArray = []*armapimanagement.NetworkStatusContractByLocation{
	// 	{
	// 		Location: to.Ptr("West US"),
	// 		NetworkStatus: &armapimanagement.NetworkStatusContract{
	// 			ConnectivityStatus: []*armapimanagement.ConnectivityStatusContract{
	// 				{
	// 					Name: to.Ptr("apimgmtst6xxxxxxxxxxx.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("apimgmtst6xxxxxxxxxxx.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("apimgmtst6xxxxxxxxxxx.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("apimgmtst6xxxxxxxxxxx.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, "2019-07-20T02:25:48.706Z"); return t}()),
	// 					LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-11-24T23:01:24.055Z"); return t}()),
	// 					ResourceType: to.Ptr("SourceControl"),
	// 					Status: to.Ptr(armapimanagement.ConnectivityStatusTypeSuccess),
	// 				},
	// 				{
	// 					Name: to.Ptr("smtpi-ch1.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

JavaScript

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/ApiManagementServiceGetNetworkStatus.json
 */
async function apiManagementServiceGetNetworkStatus() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.networkStatus.listByService(resourceGroupName, serviceName);
  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

Sample Response

Status code:

200

[
  {
    "location": "West US",
    "networkStatus": {
      "dnsServers": [
        "10.82.98.10"
      ],
      "connectivityStatus": [
        {
          "name": "apimgmtst6xxxxxxxxxxx.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": "apimgmtst6xxxxxxxxxxx.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": "apimgmtst6xxxxxxxxxxx.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": "apimgmtst6xxxxxxxxxxx.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:01:24.0553684Z",
          "lastStatusChange": "2019-07-20T02:25:48.7066996Z",
          "resourceType": "SourceControl",
          "isOptional": true
        },
        {
          "name": "smtpi-ch1.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
        }
      ]
    }
  }
]

Definições

Nome	Description
ConnectivityStatusContract	Detalhes sobre a conectividade com um recurso.
ConnectivityStatusType	Identificador de Tipo de Status de Conectividade de Recurso.
ErrorFieldContract	Contrato de Campo de Erro.
ErrorResponse	Resposta de erro.
NetworkStatusContract	Detalhes do Status da Rede.
NetworkStatusContractByLocation	Status da Rede no Local

ConnectivityStatusContract

Detalhes sobre a conectividade com um recurso.

Nome	Tipo	Description
error	string	Detalhes do erro da conectividade com o recurso.
isOptional	boolean	Se isso é opcional.
lastStatusChange	string	A data em que a conectividade do recurso status alterada pela última vez de êxito para falha ou vice-versa. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.
lastUpdated	string	A data em que a status de conectividade do recurso foi atualizada pela última vez. Esse status deve ser atualizado a cada 15 minutos. Se esse status não tiver sido atualizado, significa que o serviço perdeu a conectividade de rede com o recurso, de dentro do Rede Virtual. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.
name	string	O nome do host do recurso do qual o serviço depende. Pode ser o banco de dados, o armazenamento ou qualquer outro recurso do azure do qual o serviço depende.
resourceType	string	Tipo de recurso.
status	ConnectivityStatusType	Identificador de Tipo de Status de Conectividade de Recurso.

ConnectivityStatusType

Identificador de Tipo de Status de Conectividade de Recurso.

Nome	Tipo	Description
failure	string
initializing	string
success	string

ErrorFieldContract

Contrato de Campo de Erro.

Nome	Tipo	Description
code	string	Código de erro no nível da propriedade.
message	string	Representação legível por humanos do erro no nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
error.message	string	Representação legível ao olho humano do erro.

NetworkStatusContract

Detalhes do Status da Rede.

Nome	Tipo	Description
connectivityStatus	ConnectivityStatusContract[]	Obtém a lista de Status de Conectividade para os Recursos dos quais o serviço depende.
dnsServers	string[]	Obtém a lista de endereços IPV4 de servidores DNS.

NetworkStatusContractByLocation

Status da Rede no Local

Nome	Tipo	Description
location	string	Local do serviço
networkStatus	NetworkStatusContract	Status de rede no Local