Web Apps - Approve Or Reject Private Endpoint Connection Slot

참조

서비스:: App Service

API 버전:: 2023-12-01

프라이빗 엔드포인트 연결 승인 또는 거부에 대한 설명

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
name	path	True	string	사이트의 이름입니다.
privateEndpointConnectionName	path	True	string
resourceGroupName	path	True	string	리소스가 속한 리소스 그룹의 이름입니다. regex 패턴: `^[-\w\._]+[^\.]$`
slot	path	True	string
subscriptionId	path	True	string	Azure 구독 ID. GUID 형식 문자열입니다(예: 000000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	API 버전

요청 본문

Name	형식	Description
kind	string	리소스 종류입니다.
properties.ipAddresses	string[]	원격 프라이빗 엔드포인트에 매핑된 개인 IPAddresses
properties.privateEndpoint	ArmIdWrapper	원격 프라이빗 엔드포인트 연결의 PrivateEndpoint
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	프라이빗 링크 연결의 상태입니다.

응답

Name	형식	Description
200 OK	RemotePrivateEndpointConnectionARMResource	OK.
202 Accepted	RemotePrivateEndpointConnectionARMResource	진행 중인 비동기 작업입니다.
Other Status Codes	DefaultErrorResponse	오류 응답을 App Service.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Approves or rejects a private endpoint connection for a site.

샘플 요청

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

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

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python approve_reject_site_private_endpoint_connection_slot.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.begin_approve_or_reject_private_endpoint_connection_slot(
        resource_group_name="rg",
        name="testSite",
        private_endpoint_connection_name="connection",
        slot="stage",
        private_endpoint_wrapper={
            "properties": {
                "privateLinkServiceConnectionState": {
                    "actionsRequired": "",
                    "description": "Approved by admin.",
                    "status": "Approved",
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ApproveRejectSitePrivateEndpointConnectionSlot.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/de1f3772629b6f4d3ac01548a5f6d719bfb97c9e/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ApproveRejectSitePrivateEndpointConnectionSlot.json
func ExampleWebAppsClient_BeginApproveOrRejectPrivateEndpointConnectionSlot() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWebAppsClient().BeginApproveOrRejectPrivateEndpointConnectionSlot(ctx, "rg", "testSite", "connection", "stage", armappservice.RemotePrivateEndpointConnectionARMResource{
		Properties: &armappservice.RemotePrivateEndpointConnectionARMResourceProperties{
			PrivateLinkServiceConnectionState: &armappservice.PrivateLinkConnectionState{
				Description:     to.Ptr("Approved by admin."),
				ActionsRequired: to.Ptr(""),
				Status:          to.Ptr("Approved"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RemotePrivateEndpointConnectionARMResource = armappservice.RemotePrivateEndpointConnectionARMResource{
	// 	Name: to.Ptr("connection"),
	// 	Type: to.Ptr("Microsoft.Web/sites/privateEndpointConnections"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/privateEndpointConnections/connection"),
	// 	Properties: &armappservice.RemotePrivateEndpointConnectionARMResourceProperties{
	// 		PrivateEndpoint: &armappservice.ArmIDWrapper{
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armappservice.PrivateLinkConnectionState{
	// 			Description: to.Ptr("Approved by admin."),
	// 			ActionsRequired: to.Ptr(""),
	// 			Status: to.Ptr("Approved"),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Description for Approves or rejects a private endpoint connection
 *
 * @summary Description for Approves or rejects a private endpoint connection
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ApproveRejectSitePrivateEndpointConnectionSlot.json
 */
async function approvesOrRejectsAPrivateEndpointConnectionForASite() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const name = "testSite";
  const privateEndpointConnectionName = "connection";
  const slot = "stage";
  const privateEndpointWrapper = {
    privateLinkServiceConnectionState: {
      description: "Approved by admin.",
      actionsRequired: "",
      status: "Approved",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.beginApproveOrRejectPrivateEndpointConnectionSlotAndWait(
    resourceGroupName,
    name,
    privateEndpointConnectionName,
    slot,
    privateEndpointWrapper,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

샘플 응답

상태 코드:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/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": ""
    }
  }
}

상태 코드:: 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

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/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": ""
    }
  }
}

정의

Name	Description
ArmIdWrapper	ARM 리소스 ID에 대한 래퍼
DefaultErrorResponse	오류 응답을 App Service.
Details
Error	오류 모델.
PrivateLinkConnectionState	프라이빗 링크 연결의 상태입니다.
RemotePrivateEndpointConnectionARMResource	원격 프라이빗 엔드포인트 연결 ARM 리소스.

ArmIdWrapper

ARM 리소스 ID에 대한 래퍼

Name	형식	Description
id	string

DefaultErrorResponse

오류 응답을 App Service.

Name	형식	Description
error	Error	오류 모델.

Details

Name	형식	Description
code	string	프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
message	string	자세한 오류 설명 및 디버깅 정보입니다.
target	string	자세한 오류 설명 및 디버깅 정보입니다.

Error

오류 모델.

Name	형식	Description
code	string	프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
details	Details[]	자세한 오류입니다.
innererror	string	디버그 오류에 대한 자세한 정보입니다.
message	string	자세한 오류 설명 및 디버깅 정보입니다.
target	string	자세한 오류 설명 및 디버깅 정보입니다.

PrivateLinkConnectionState

프라이빗 링크 연결의 상태입니다.

Name	형식	Description
actionsRequired	string	프라이빗 링크 연결에 대한 ActionsRequired
description	string	프라이빗 링크 연결에 대한 설명
status	string	프라이빗 링크 연결 상태

RemotePrivateEndpointConnectionARMResource

원격 프라이빗 엔드포인트 연결 ARM 리소스.

Name	형식	Description
id	string	리소스 ID입니다.
kind	string	리소스 종류입니다.
name	string	리소스 이름입니다.
properties.ipAddresses	string[]	원격 프라이빗 엔드포인트에 매핑된 개인 IPAddresses
properties.privateEndpoint	ArmIdWrapper	원격 프라이빗 엔드포인트 연결의 PrivateEndpoint
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	프라이빗 링크 연결의 상태입니다.
properties.provisioningState	string
type	string	리소스 종류.

다음을 통해 공유

Web Apps - Approve Or Reject Private Endpoint Connection Slot

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

Approves or rejects a private endpoint connection for a site.

샘플 요청

샘플 응답

정의

ArmIdWrapper

DefaultErrorResponse

Details

Error

PrivateLinkConnectionState

RemotePrivateEndpointConnectionARMResource

추가 리소스