Gateway - Get

取得識別碼所指定之閘道的詳細資料。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}?api-version=2020-12-01

URI 參數

Name In Required Type Description
gatewayId
path True
  • string

閘道實體識別碼。 在目前的 API 管理服務實例中必須是唯一的。 不能有 ' managed ' 值

resourceGroupName
path True
  • string

資源群組的名稱。

serviceName
path True
  • string

API 管理服務的名稱。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳號憑證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

api-version
query True
  • string

要搭配用戶端要求使用的 API 版本。

回應

Name Type Description
200 OK

回應主體包含指定的閘道實體。

Headers

  • ETag: string
Other Status Codes

描述作業為何失敗的錯誤回應。

安全性

azure_auth

Azure Active DirectoryOAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模擬您的使用者帳戶

範例

ApiManagementGetGateway

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1?api-version=2020-12-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1",
  "type": "Microsoft.ApiManagement/service/gateways",
  "name": "a1",
  "properties": {
    "description": "my gateway 1",
    "locationData": {
      "name": "my location"
    }
  }
}

定義

ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

GatewayContract

閘道詳細資料。

ResourceLocationDataContract

資源位置資料屬性。

ErrorFieldContract

錯誤欄位合約。

Name Type Description
code
  • string

屬性層級錯誤碼。

message
  • string

人們可讀取的屬性層級錯誤標記法。

target
  • string

屬性名稱。

ErrorResponse

錯誤回應。

Name Type Description
error.code
  • string

服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。

error.details

如果發生驗證錯誤,則為不正確欄位清單會送出要求。

error.message
  • string

錯誤的人們可讀取標記法。

GatewayContract

閘道詳細資料。

Name Type Description
id
  • string

資源識別碼。

name
  • string

資源名稱。

properties.description
  • string

閘道描述

properties.locationData

閘道位置。

type
  • string

API 管理資源的資源類型。

ResourceLocationDataContract

資源位置資料屬性。

Name Type Description
city
  • string

資源所在的城市或位置。

countryOrRegion
  • string

資源所在的國家或地區。

district
  • string

資源所在的區域、州/省。

name
  • string

地理或實體位置的正式名稱。