Network Status - List By Service

Api Management サービスがクラウド サービス内から依存している外部リソースへの接続状態を取得します。 これにより、CloudService に表示される DNS サーバーも返されます。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/networkstatus?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 バージョン。

応答

名前 説明
200 OK

NetworkStatusContractByLocation[]

サービスがデプロイされているすべてのリージョンのネットワーク状態の詳細の一覧を取得します。

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 ユーザー アカウントの借用

ApiManagementServiceGetNetworkStatus

Sample Request

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

Sample Response

[
  {
    "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
        }
      ]
    }
  }
]

定義

名前 説明
ConnectivityStatusContract

リソースへの接続の詳細。

ConnectivityStatusType

リソース接続状態の種類識別子。

ErrorFieldContract

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

ErrorResponse

エラー応答。

NetworkStatusContract

ネットワーク状態の詳細。

NetworkStatusContractByLocation

場所のネットワークの状態

ConnectivityStatusContract

リソースへの接続の詳細。

名前 説明
error

string

リソースへの接続のエラーの詳細。

isOptional

boolean

これが省略可能かどうか。

lastStatusChange

string

リソースの接続状態が最後に成功から失敗に変更された日付、またはその逆の日付。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。

lastUpdated

string

リソースの接続状態が最後に更新された日付。 この状態は 15 分ごとに更新する必要があります。 この状態が更新されていない場合は、サービスがVirtual Network内からリソースへのネットワーク接続を失ったことを意味します。日付は、ISO 8601 標準で指定されている形式yyyy-MM-ddTHH:mm:ssZに準拠しています。

name

string

サービスが依存するリソースのホスト名。 これには、データベース、ストレージ、またはサービスが依存するその他の Azure リソースを指定できます。

resourceType

string

リソースの種類。

status

ConnectivityStatusType

リソース接続状態の種類識別子。

ConnectivityStatusType

リソース接続状態の種類識別子。

名前 説明
failure

string

initializing

string

success

string

ErrorFieldContract

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

名前 説明
code

string

プロパティ レベルのエラー コード。

message

string

プロパティ レベルエラーの人間が判読できる表現。

target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 説明
error.code

string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。

error.details

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。

error.message

string

人が判読できるエラーの表現。

NetworkStatusContract

ネットワーク状態の詳細。

名前 説明
connectivityStatus

ConnectivityStatusContract[]

サービスが依存するリソースへの接続状態の一覧を取得します。

dnsServers

string[]

DNS サーバーの IPV4 アドレスの一覧を取得します。

NetworkStatusContractByLocation

場所のネットワークの状態

名前 説明
location

string

サービスの場所

networkStatus

NetworkStatusContract

場所のネットワークの状態