Api Gateway Config Connection - List By Gateway

サービス:

API Management

API バージョン:

2024-05-01

ゲートウェイ内のすべての API Management ゲートウェイ構成接続を一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management ゲートウェイの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	ApiManagementGatewayConfigConnectionListResult	API Management ゲートウェイ構成接続の一覧。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

ApiManagementListGatewayConfigConnection

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections?api-version=2024-05-01

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1",
      "name": "gcc-1",
      "type": "Microsoft.ApiManagement/gateways/configConnections",
      "etag": "AAAAAAAWN/4=",
      "properties": {
        "provisioningState": "Succeeded",
        "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001",
        "defaultHostname": "gcc-1-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net",
        "hostnames": [
          "gcc1standard-gw-1.gateway.eastus.azure-api.net"
        ]
      }
    },
    {
      "etag": "AAAAAAAWKwo=",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-2",
      "name": "gcc-2",
      "properties": {
        "provisioningState": "Succeeded",
        "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-002",
        "defaultHostname": "gcc-2-ahg4t5iof8gaafex.standard-gw-1.gateway.eastus.azure-api.net"
      },
      "type": "Microsoft.ApiManagement/gateways/configConnetions"
    }
  ]
}

定義

名前	説明
ApiManagementGatewayConfigConnectionListResult	List API Management ゲートウェイ操作の応答。
ApiManagementGatewayConfigConnectionResource	List または Get 応答の単一の API Management ゲートウェイ リソース。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

ApiManagementGatewayConfigConnectionListResult

Object

List API Management ゲートウェイ操作の応答。

名前	型	説明
nextLink	string	次の結果セットにリンクします。 値に API Management サービスの不完全なリストが含まれている場合は空ではありません。
value	ApiManagementGatewayConfigConnectionResource[]	LIST API Management ゲートウェイ構成接続操作の結果。

ApiManagementGatewayConfigConnectionResource

Object

List または Get 応答の単一の API Management ゲートウェイ リソース。

名前	型	説明
etag	string	リソースの ETag。
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.defaultHostname	string	データ プレーン ゲートウェイの既定のホスト名。
properties.hostnames	string[]	要求の送信先となるデータ プレーン ゲートウェイのホスト名。
properties.provisioningState	string	API Management ゲートウェイ構成接続の現在のプロビジョニング状態
properties.sourceId	string (arm-id)	API Management サービス ワークスペースへのリンク。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。