App Service Environments - Get Vip Info

リファレンス

Service:: App Service

API Version:: 2023-12-01

App Service Environmentに割り当てられた IP アドレスの取得に関する説明。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip?api-version=2023-12-01

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	App Service Environmentの名前。
resourceGroupName	path	True	string	リソースが属しているリソースグループの名前。 Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Azure のサブスクリプション ID。これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-00000000000000)。
api-version	query	True	string	API バージョン

応答

名前	型	説明
200 OK	AddressResponse	OK
Other Status Codes	DefaultErrorResponse	エラー応答をApp Serviceします。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

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

例

Get IP addresses assigned to an App Service Environment.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/capacities/virtualip?api-version=2023-12-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/Microsoft.Web/hostingEnvironments/test-ase/capacities/virtualip",
  "name": "test-ase",
  "type": "Microsoft.Web/hostingEnvironments/capacities",
  "properties": {
    "serviceIpAddress": "20.112.141.120",
    "internalIpAddress": null,
    "outboundIpAddresses": [
      "20.112.141.120"
    ],
    "vipMappings": [
      {
        "virtualIP": "20.112.141.135",
        "internalHttpPort": 20003,
        "internalHttpsPort": 20001,
        "inUse": false,
        "serviceName": null
      },
      {
        "virtualIP": "20.112.141.150",
        "internalHttpPort": 20004,
        "internalHttpsPort": 20002,
        "inUse": false,
        "serviceName": null
      }
    ]
  }
}

定義

名前	説明
AddressResponse	パブリック IP アドレスと追加の仮想 IP メインについて説明します。
DefaultErrorResponse	エラー応答をApp Serviceします。
Details
Error	エラーモデル。
VirtualIPMapping	仮想 IP マッピング。

AddressResponse

パブリック IP アドレスと追加の仮想 IP メインについて説明します。

名前	型	説明
id	string	リソース ID。
kind	string	リソースの種類。
name	string	リソース名。
properties.internalIpAddress	string	内部負荷分散モードの場合は、App Service Environmentの内部 IP アドレスをVirtual Networkします。
properties.outboundIpAddresses	string[]	送信接続に表示される IP アドレス。
properties.serviceIpAddress	string	メインのパブリック仮想 IP。
properties.vipMappings	VirtualIPMapping[]	追加の仮想 IP。
type	string	リソースの種類。

DefaultErrorResponse

エラー応答をApp Serviceします。

名前	型	説明
error	Error	エラーモデル。

Details

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

Error

エラーモデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細なエラー。
innererror	string	デバッグエラーの詳細。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

VirtualIPMapping

仮想 IP マッピング。

名前	型	説明
inUse	boolean	使用中の仮想 IP マッピングです。
internalHttpPort	integer	内部 HTTP ポート。
internalHttpsPort	integer	内部 HTTPS ポート。
serviceName	string	仮想 IP が割り当てられているサービスの名前
virtualIP	string	仮想 IP アドレス。