Perform Connectivity Check Async - Perform Connectivity Check Async

リファレンス

Service:: API Management

API Version:: 2022-08-01

API Management サービスと特定の宛先の間で接続チェックを実行し、接続のメトリックと、確立中に発生したエラーを返します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
serviceName	path	True	string	API Management サービスの名前。 Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
destination	True	Destination	操作の宛先チェック接続。
source	True	Source	接続チェック配信元に関する定義。
preferredIPVersion		PreferredIPVersion	使用する IP バージョン。現時点では、IPv4 のみがサポートされています。
protocol		ConnectivityCheckProtocol	要求のプロトコル。この選択に基づいて、特定のプロトコル構成を使用できます。指定された宛先アドレスは、この値と一貫性がある必要があります。
protocolConfiguration		ProtocolConfiguration	プロトコル固有の構成。

応答

名前	型	説明
200 OK	ConnectivityCheckResponse	接続チェック要求が完了しました。
202 Accepted		要求が受け入れられ、現在実行中です。 Location ヘッダーには、実行時間の長い操作の状態を確認し、最終的に結果を取得できる URL が含まれています。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

HTTP Connectivity Check

TCP Connectivity Check

HTTP Connectivity Check

Sample Request

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

{
  "source": {
    "region": "northeurope"
  },
  "destination": {
    "address": "https://microsoft.com",
    "port": 3306
  },
  "protocol": "HTTPS",
  "protocolConfiguration": {
    "HTTPConfiguration": {
      "method": "GET",
      "validStatusCodes": [
        200,
        204
      ],
      "headers": [
        {
          "name": "Authorization",
          "value": "******"
        }
      ]
    }
  }
}

import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckProtocol;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequest;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestDestination;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestProtocolConfiguration;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestProtocolConfigurationHttpConfiguration;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestSource;
import com.azure.resourcemanager.apimanagement.models.HttpHeader;
import com.azure.resourcemanager.apimanagement.models.Method;
import java.util.Arrays;

/** Samples for ResourceProvider PerformConnectivityCheckAsync. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheckHttpConnect.json
     */
    /**
     * Sample code: HTTP Connectivity Check.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void hTTPConnectivityCheck(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .resourceProviders()
            .performConnectivityCheckAsync(
                "rg1",
                "apimService1",
                new ConnectivityCheckRequest()
                    .withSource(new ConnectivityCheckRequestSource().withRegion("northeurope"))
                    .withDestination(
                        new ConnectivityCheckRequestDestination().withAddress("https://microsoft.com").withPort(3306L))
                    .withProtocol(ConnectivityCheckProtocol.HTTPS)
                    .withProtocolConfiguration(
                        new ConnectivityCheckRequestProtocolConfiguration()
                            .withHttpConfiguration(
                                new ConnectivityCheckRequestProtocolConfigurationHttpConfiguration()
                                    .withMethod(Method.GET)
                                    .withValidStatusCodes(Arrays.asList(200L, 204L))
                                    .withHeaders(
                                        Arrays
                                            .asList(new HttpHeader().withName("Authorization").withValue("******"))))),
                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 typing import Any, IO, Union

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_perform_connectivity_check_http_connect.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.begin_perform_connectivity_check_async(
        resource_group_name="rg1",
        service_name="apimService1",
        connectivity_check_request_params={
            "destination": {"address": "https://microsoft.com", "port": 3306},
            "protocol": "HTTPS",
            "protocolConfiguration": {
                "HTTPConfiguration": {
                    "headers": [{"name": "Authorization", "value": "******"}],
                    "method": "GET",
                    "validStatusCodes": [200, 204],
                }
            },
            "source": {"region": "northeurope"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheckHttpConnect.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/azcore/to"
	"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/ApiManagementPerformConnectivityCheckHttpConnect.json
func ExampleClient_BeginPerformConnectivityCheckAsync_httpConnectivityCheck() {
	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)
	}
	poller, err := clientFactory.NewClient().BeginPerformConnectivityCheckAsync(ctx, "rg1", "apimService1", armapimanagement.ConnectivityCheckRequest{
		Destination: &armapimanagement.ConnectivityCheckRequestDestination{
			Address: to.Ptr("https://microsoft.com"),
			Port:    to.Ptr[int64](3306),
		},
		ProtocolConfiguration: &armapimanagement.ConnectivityCheckRequestProtocolConfiguration{
			HTTPConfiguration: &armapimanagement.ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration{
				Method: to.Ptr(armapimanagement.MethodGET),
				Headers: []*armapimanagement.HTTPHeader{
					{
						Name:  to.Ptr("Authorization"),
						Value: to.Ptr("******"),
					}},
				ValidStatusCodes: []*int64{
					to.Ptr[int64](200),
					to.Ptr[int64](204)},
			},
		},
		Source: &armapimanagement.ConnectivityCheckRequestSource{
			Region: to.Ptr("northeurope"),
		},
		Protocol: to.Ptr(armapimanagement.ConnectivityCheckProtocolHTTPS),
	}, 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.ConnectivityCheckResponse = armapimanagement.ConnectivityCheckResponse{
	// 	AvgLatencyInMs: to.Ptr[int64](260),
	// 	ConnectionStatus: to.Ptr(armapimanagement.ConnectionStatus("Reachable")),
	// 	Hops: []*armapimanagement.ConnectivityHop{
	// 		{
	// 			Type: to.Ptr("Source"),
	// 			Address: to.Ptr("20.82.216.48"),
	// 			ID: to.Ptr("c60e2296-5ebc-48cc-80e8-7e6d2981e7b2"),
	// 			Issues: []*armapimanagement.ConnectivityIssue{
	// 			},
	// 			NextHopIDs: []*string{
	// 				to.Ptr("26aa44e7-04f1-462f-aa5d-5951957b5650")},
	// 				ResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 			},
	// 			{
	// 				Type: to.Ptr("Internet"),
	// 				Address: to.Ptr("40.113.200.201"),
	// 				ID: to.Ptr("26aa44e7-04f1-462f-aa5d-5951957b5650"),
	// 				Issues: []*armapimanagement.ConnectivityIssue{
	// 				},
	// 				NextHopIDs: []*string{
	// 				},
	// 		}},
	// 		MaxLatencyInMs: to.Ptr[int64](281),
	// 		MinLatencyInMs: to.Ptr[int64](250),
	// 		ProbesFailed: to.Ptr[int64](0),
	// 		ProbesSent: to.Ptr[int64](3),
	// 	}
}

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 Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.
 *
 * @summary Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheckHttpConnect.json
 */
async function httpConnectivityCheck() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const connectivityCheckRequestParams = {
    destination: { address: "https://microsoft.com", port: 3306 },
    protocolConfiguration: {
      httpConfiguration: {
        method: "GET",
        headers: [{ name: "Authorization", value: "******" }],
        validStatusCodes: [200, 204],
      },
    },
    source: { region: "northeurope" },
    protocol: "HTTPS",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.beginPerformConnectivityCheckAsyncAndWait(
    resourceGroupName,
    serviceName,
    connectivityCheckRequestParams
  );
  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:: 202

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

Status code:: 200

{
  "hops": [
    {
      "type": "Source",
      "id": "c60e2296-5ebc-48cc-80e8-7e6d2981e7b2",
      "address": "20.82.216.48",
      "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
      "nextHopIds": [
        "26aa44e7-04f1-462f-aa5d-5951957b5650"
      ],
      "issues": []
    },
    {
      "type": "Internet",
      "id": "26aa44e7-04f1-462f-aa5d-5951957b5650",
      "address": "40.113.200.201",
      "nextHopIds": [],
      "issues": []
    }
  ],
  "connectionStatus": "Reachable",
  "avgLatencyInMs": 260,
  "minLatencyInMs": 250,
  "maxLatencyInMs": 281,
  "probesSent": 3,
  "probesFailed": 0
}

TCP Connectivity Check

Sample Request

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

{
  "source": {
    "region": "northeurope"
  },
  "destination": {
    "address": "8.8.8.8",
    "port": 53
  },
  "preferredIPVersion": "IPv4"
}

import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequest;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestDestination;
import com.azure.resourcemanager.apimanagement.models.ConnectivityCheckRequestSource;
import com.azure.resourcemanager.apimanagement.models.PreferredIpVersion;

/** Samples for ResourceProvider PerformConnectivityCheckAsync. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheck.json
     */
    /**
     * Sample code: TCP Connectivity Check.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void tCPConnectivityCheck(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .resourceProviders()
            .performConnectivityCheckAsync(
                "rg1",
                "apimService1",
                new ConnectivityCheckRequest()
                    .withSource(new ConnectivityCheckRequestSource().withRegion("northeurope"))
                    .withDestination(new ConnectivityCheckRequestDestination().withAddress("8.8.8.8").withPort(53L))
                    .withPreferredIpVersion(PreferredIpVersion.IPV4),
                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 typing import Any, IO, Union

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_perform_connectivity_check.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.begin_perform_connectivity_check_async(
        resource_group_name="rg1",
        service_name="apimService1",
        connectivity_check_request_params={
            "destination": {"address": "8.8.8.8", "port": 53},
            "preferredIPVersion": "IPv4",
            "source": {"region": "northeurope"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheck.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/azcore/to"
	"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/ApiManagementPerformConnectivityCheck.json
func ExampleClient_BeginPerformConnectivityCheckAsync_tcpConnectivityCheck() {
	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)
	}
	poller, err := clientFactory.NewClient().BeginPerformConnectivityCheckAsync(ctx, "rg1", "apimService1", armapimanagement.ConnectivityCheckRequest{
		Destination: &armapimanagement.ConnectivityCheckRequestDestination{
			Address: to.Ptr("8.8.8.8"),
			Port:    to.Ptr[int64](53),
		},
		PreferredIPVersion: to.Ptr(armapimanagement.PreferredIPVersionIPv4),
		Source: &armapimanagement.ConnectivityCheckRequestSource{
			Region: to.Ptr("northeurope"),
		},
	}, 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.ConnectivityCheckResponse = armapimanagement.ConnectivityCheckResponse{
	// 	AvgLatencyInMs: to.Ptr[int64](1),
	// 	ConnectionStatus: to.Ptr(armapimanagement.ConnectionStatusConnected),
	// 	Hops: []*armapimanagement.ConnectivityHop{
	// 		{
	// 			Type: to.Ptr("Source"),
	// 			Address: to.Ptr("10.1.1.4"),
	// 			ID: to.Ptr("7dbbe7aa-60ba-4650-831e-63d775d38e9e"),
	// 			Issues: []*armapimanagement.ConnectivityIssue{
	// 			},
	// 			NextHopIDs: []*string{
	// 				to.Ptr("75c8d819-b208-4584-a311-1aa45ce753f9")},
	// 				ResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 			},
	// 			{
	// 				Type: to.Ptr("Internet"),
	// 				Address: to.Ptr("8.8.8.8"),
	// 				ID: to.Ptr("75c8d819-b208-4584-a311-1aa45ce753f9"),
	// 				Issues: []*armapimanagement.ConnectivityIssue{
	// 				},
	// 				NextHopIDs: []*string{
	// 				},
	// 		}},
	// 		MaxLatencyInMs: to.Ptr[int64](4),
	// 		MinLatencyInMs: to.Ptr[int64](1),
	// 		ProbesFailed: to.Ptr[int64](0),
	// 		ProbesSent: to.Ptr[int64](100),
	// 	}
}

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 Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.
 *
 * @summary Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementPerformConnectivityCheck.json
 */
async function tcpConnectivityCheck() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const connectivityCheckRequestParams = {
    destination: { address: "8.8.8.8", port: 53 },
    preferredIPVersion: "IPv4",
    source: { region: "northeurope" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.beginPerformConnectivityCheckAsyncAndWait(
    resourceGroupName,
    serviceName,
    connectivityCheckRequestParams
  );
  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:: 202

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

Status code:: 200

{
  "hops": [
    {
      "type": "Source",
      "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e",
      "address": "10.1.1.4",
      "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
      "nextHopIds": [
        "75c8d819-b208-4584-a311-1aa45ce753f9"
      ],
      "issues": []
    },
    {
      "type": "Internet",
      "id": "75c8d819-b208-4584-a311-1aa45ce753f9",
      "address": "8.8.8.8",
      "nextHopIds": [],
      "issues": []
    }
  ],
  "connectionStatus": "Connected",
  "avgLatencyInMs": 1,
  "minLatencyInMs": 1,
  "maxLatencyInMs": 4,
  "probesSent": 100,
  "probesFailed": 0
}

定義

名前	説明
ConnectionStatus	接続の状態。
ConnectivityCheckProtocol	要求のプロトコル。この選択に基づいて、特定のプロトコル構成を使用できます。指定された宛先アドレスは、この値と一貫性がある必要があります。
ConnectivityCheckRequest	API Management サービスに対して接続チェック操作を実行する要求。
ConnectivityCheckResponse	接続状態に関する情報。
ConnectivityHop	ソースと宛先の間のホップに関する情報。
ConnectivityIssue	接続を確認するプロセスで発生した問題に関する情報。
Destination	操作の宛先チェック接続。
ErrorFieldContract	エラーフィールドコントラクト。
ErrorResponse	エラー応答。
HTTPConfiguration	HTTP または HTTPS 要求の構成。
HTTPHeader	HTTP ヘッダーと値です。
IssueType	問題の種類。
Method	使用する HTTP メソッド。
Origin	問題の発生元。
PreferredIPVersion	使用する IP バージョン。現時点では、IPv4 のみがサポートされています。
ProtocolConfiguration	プロトコル固有の構成。
Severity	問題の重大度。
Source	接続チェック配信元に関する定義。

ConnectionStatus

接続の状態。

名前	型	説明
Connected	string
Degraded	string
Disconnected	string
Unknown	string

ConnectivityCheckProtocol

要求のプロトコル。この選択に基づいて、特定のプロトコル構成を使用できます。指定された宛先アドレスは、この値と一貫性がある必要があります。

名前	型	説明
HTTP	string
HTTPS	string
TCP	string

ConnectivityCheckRequest

API Management サービスに対して接続チェック操作を実行する要求。

名前	型	説明
destination	Destination	操作の宛先チェック接続。
preferredIPVersion	PreferredIPVersion	使用する IP バージョン。現時点では、IPv4 のみがサポートされています。
protocol	ConnectivityCheckProtocol	要求のプロトコル。この選択に基づいて、特定のプロトコル構成を使用できます。指定された宛先アドレスは、この値と一貫性がある必要があります。
protocolConfiguration	ProtocolConfiguration	プロトコル固有の構成。
source	Source	接続チェック配信元に関する定義。

ConnectivityCheckResponse

接続状態に関する情報。

名前	型	説明
avgLatencyInMs	integer	平均待機時間 (ミリ秒)。
connectionStatus	ConnectionStatus	接続の状態。
hops	ConnectivityHop[]	ソースと宛先の間のホップの一覧。
maxLatencyInMs	integer	最大待機時間 (ミリ秒単位)。
minLatencyInMs	integer	最小待機時間 (ミリ秒単位)。
probesFailed	integer	失敗したプローブの数。
probesSent	integer	送信されたプローブの合計数。

ConnectivityHop

ソースと宛先の間のホップに関する情報。

名前	型	説明
address	string	ホップの IP アドレス。
id	string	ホップの ID。
issues	ConnectivityIssue[]	問題の一覧。
nextHopIds	string[]	次ホップ識別子の一覧。
resourceId	string	このホップに対応するリソースの ID。
type	string	ホップの種類。

ConnectivityIssue

接続を確認するプロセスで発生した問題に関する情報。

名前	型	説明
context	object[]	この問題に関する追加のコンテキストを提供します。
origin	Origin	問題の発生元。
severity	Severity	問題の重大度。
type	IssueType	問題の種類。

Destination

操作の宛先チェック接続。

名前	型	説明
address	string	宛先アドレス。 IP アドレスまたは FQDN を指定できます。
port	integer	送信先ポート。

ErrorFieldContract

エラーフィールドコントラクト。

名前	型	説明
code	string	プロパティレベルのエラーコード。
message	string	プロパティレベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラーコード。このコードは、応答に指定された HTTP エラーコードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

HTTPConfiguration

HTTP または HTTPS 要求の構成。

名前	型	説明
headers	HTTPHeader[]	要求に含めるヘッダーの一覧。
method	Method	使用する HTTP メソッド。
validStatusCodes	integer[]	要求応答に対して有効と見なされる HTTP 状態コードの一覧。

HTTPHeader

HTTP ヘッダーと値です。

名前	型	説明
name	string	ヘッダー名。
value	string	ヘッダー値。

IssueType

問題の種類。

名前	型	説明
AgentStopped	string
DnsResolution	string
GuestFirewall	string
NetworkSecurityRule	string
Platform	string
PortThrottled	string
SocketBind	string
Unknown	string
UserDefinedRoute	string

Method

使用する HTTP メソッド。

名前	型	説明
GET	string
POST	string

Origin

問題の発生元。

名前	型	説明
Inbound	string
Local	string
Outbound	string

PreferredIPVersion

使用する IP バージョン。現時点では、IPv4 のみがサポートされています。

名前	型	説明
IPv4	string

ProtocolConfiguration

プロトコル固有の構成。

名前	型	説明
HTTPConfiguration	HTTPConfiguration	HTTP または HTTPS 要求の構成。

Severity

問題の重大度。

名前	型	説明
Error	string
Warning	string

Source

接続チェック配信元に関する定義。

名前	型	説明
instance	integer	要求の発生元となる特定の VMSS インスタンス。
region	string	接続チェック操作を開始する場所のAPI Management サービスリージョン。

Share via

Perform Connectivity Check Async - Perform Connectivity Check Async

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

Scopes

例

HTTP Connectivity Check

Sample Request

Sample Response

TCP Connectivity Check

Sample Request

Sample Response

定義

ConnectionStatus

ConnectivityCheckProtocol

ConnectivityCheckRequest

ConnectivityCheckResponse

ConnectivityHop

ConnectivityIssue

Destination

ErrorFieldContract

ErrorResponse

HTTPConfiguration

HTTPHeader

IssueType

Method

Origin

PreferredIPVersion

ProtocolConfiguration

Severity

Source

その他のリソース