Web Apps - Approve Or Reject Private Endpoint Connection

リファレンス

Service:: App Service

API Version:: 2023-12-01

プライベートエンドポイント接続を承認または拒否するための説明

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-12-01

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	サイトの名前。
privateEndpointConnectionName	path	True	string
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 バージョン

要求本文

名前	型	説明
kind	string	リソースの種類。
properties.ipAddresses	string[]	リモートプライベートエンドポイントにマップされたプライベート IPAddresses
properties.privateEndpoint	ArmIdWrapper	リモートプライベートエンドポイント接続の PrivateEndpoint
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	プライベートリンク接続の状態

応答

名前	型	説明
200 OK	RemotePrivateEndpointConnectionARMResource	OK です。
202 Accepted	RemotePrivateEndpointConnectionARMResource	非同期操作が進行中です。
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	ユーザーアカウントの借用

例

Approves or rejects a private endpoint connection for a site.

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateEndpointConnections/connection?api-version=2023-12-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by admin.",
      "actionsRequired": ""
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateEndpointConnections/connection",
  "name": "connection",
  "type": "Microsoft.Web/sites/privateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by admin.",
      "actionsRequired": ""
    }
  }
}

Status code:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01

Response Body

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/privateEndpointConnections/connection",
  "name": "connection",
  "type": "Microsoft.Web/sites/privateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by admin.",
      "actionsRequired": ""
    }
  }
}

定義

名前	説明
ArmIdWrapper	ARM リソース ID のラッパー
DefaultErrorResponse	エラー応答をApp Serviceします。
Details
Error	エラーモデル。
PrivateLinkConnectionState	プライベートリンク接続の状態
RemotePrivateEndpointConnectionARMResource	リモートプライベートエンドポイント接続 ARM リソース。

ArmIdWrapper

ARM リソース ID のラッパー

名前	型	説明
id	string

DefaultErrorResponse

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

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

Details

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

Error

エラーモデル。

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

PrivateLinkConnectionState

プライベートリンク接続の状態

名前	型	説明
actionsRequired	string	プライベートリンク接続の ActionsRequired
description	string	プライベートリンク接続の説明
status	string	プライベートリンク接続の状態

RemotePrivateEndpointConnectionARMResource

リモートプライベートエンドポイント接続 ARM リソース。

名前	型	説明
id	string	リソース ID。
kind	string	リソースの種類。
name	string	リソース名。
properties.ipAddresses	string[]	リモートプライベートエンドポイントにマップされたプライベート IPAddresses
properties.privateEndpoint	ArmIdWrapper	リモートプライベートエンドポイント接続の PrivateEndpoint
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	プライベートリンク接続の状態
properties.provisioningState	string
type	string	リソースの種類。