App Service Environments - Approve Or Reject Private Endpoint Connection

Szolgáltatás:

App Service

API-verzió:

2024-11-01

Magánvégpont-kapcsolat jóváhagyása vagy elutasítása

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
name	path	True	string	Az App Service-környezet neve.
privateEndpointConnectionName	path	True	string
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Annak az erőforráscsoportnak a neve, amelyhez az erőforrás tartozik.
subscriptionId	path	True	string	Az Ön Azure előfizetési azonosítója. Ez egy GUID formátumú sztring (például 000000000-0000-0000-0000-0000000000).
api-version	query	True	string	API-verzió

Kérelem törzse

Name	Típus	Description
kind	string	Erőforrás típusa.
properties.ipAddresses	string[]	A távoli privát végpontra leképezett privát IPAddresses
properties.privateEndpoint	ArmIdWrapper	Távoli privát végpontkapcsolat PrivateEndpointja
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	Privát kapcsolat állapota

Válaszok

Name	Típus	Description
200 OK	RemotePrivateEndpointConnectionARMResource	OKÉ.
202 Accepted	RemotePrivateEndpointConnectionARMResource	Folyamatban lévő aszinkron művelet.
Other Status Codes	DefaultErrorResponse	App Service-hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Approves or rejects a private endpoint connection.

Mintakérelem

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/privateEndpointConnections/fa38656c-034e-43d8-adce-fe06ce039c98?api-version=2024-11-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by johndoe@company.com"
    }
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.RemotePrivateEndpointConnectionArmResourceInner;
import com.azure.resourcemanager.appservice.models.PrivateLinkConnectionState;

/**
 * Samples for AppServiceEnvironments ApproveOrRejectPrivateEndpointConnection.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/
     * AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.json
     */
    /**
     * Sample code: Approves or rejects a private endpoint connection.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        approvesOrRejectsAPrivateEndpointConnection(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getAppServiceEnvironments().approveOrRejectPrivateEndpointConnection(
            "test-rg", "test-ase", "fa38656c-034e-43d8-adce-fe06ce039c98",
            new RemotePrivateEndpointConnectionArmResourceInner()
                .withPrivateLinkServiceConnectionState(new PrivateLinkConnectionState().withStatus("Approved")
                    .withDescription("Approved by johndoe@company.com")),
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python app_service_environments_approve_or_reject_private_endpoint_connection.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.app_service_environments.begin_approve_or_reject_private_endpoint_connection(
        resource_group_name="test-rg",
        name="test-ase",
        private_endpoint_connection_name="fa38656c-034e-43d8-adce-fe06ce039c98",
        private_endpoint_wrapper={
            "properties": {
                "privateLinkServiceConnectionState": {
                    "description": "Approved by johndoe@company.com",
                    "status": "Approved",
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.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

Go

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.json
func ExampleEnvironmentsClient_BeginApproveOrRejectPrivateEndpointConnection() {
	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.NewEnvironmentsClient().BeginApproveOrRejectPrivateEndpointConnection(ctx, "test-rg", "test-ase", "fa38656c-034e-43d8-adce-fe06ce039c98", armappservice.RemotePrivateEndpointConnectionARMResource{
		Properties: &armappservice.RemotePrivateEndpointConnectionARMResourceProperties{
			PrivateLinkServiceConnectionState: &armappservice.PrivateLinkConnectionState{
				Description: to.Ptr("Approved by johndoe@company.com"),
				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("fa38656c-034e-43d8-adce-fe06ce039c98"),
	// 	Type: to.Ptr("Microsoft.Web/hostingEnvironments/privateEndpointConnections"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/privateEndpointConnections/fa38656c-034e-43d8-adce-fe06ce039c98"),
	// 	Properties: &armappservice.RemotePrivateEndpointConnectionARMResourceProperties{
	// 		IPAddresses: []*string{
	// 		},
	// 		PrivateEndpoint: &armappservice.ArmIDWrapper{
	// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/test-privateEndpoint"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armappservice.PrivateLinkConnectionState{
	// 			Description: to.Ptr("Approved by johndoe@company.com"),
	// 			ActionsRequired: to.Ptr("None"),
	// 			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

JavaScript

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

/**
 * 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/2024-11-01/examples/AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.json
 */
async function approvesOrRejectsAPrivateEndpointConnection() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "test-rg";
  const name = "test-ase";
  const privateEndpointConnectionName = "fa38656c-034e-43d8-adce-fe06ce039c98";
  const privateEndpointWrapper = {
    privateLinkServiceConnectionState: {
      description: "Approved by johndoe@company.com",
      status: "Approved",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result =
    await client.appServiceEnvironments.beginApproveOrRejectPrivateEndpointConnectionAndWait(
      resourceGroupName,
      name,
      privateEndpointConnectionName,
      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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.json
// this example is just showing the usage of "AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AppServiceEnvironmentResource created on azure
// for more information of creating AppServiceEnvironmentResource, please refer to the document of AppServiceEnvironmentResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-rg";
string name = "test-ase";
ResourceIdentifier appServiceEnvironmentResourceId = AppServiceEnvironmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
AppServiceEnvironmentResource appServiceEnvironment = client.GetAppServiceEnvironmentResource(appServiceEnvironmentResourceId);

// get the collection of this HostingEnvironmentPrivateEndpointConnectionResource
HostingEnvironmentPrivateEndpointConnectionCollection collection = appServiceEnvironment.GetHostingEnvironmentPrivateEndpointConnections();

// invoke the operation
string privateEndpointConnectionName = "fa38656c-034e-43d8-adce-fe06ce039c98";
RemotePrivateEndpointConnectionARMResourceData data = new RemotePrivateEndpointConnectionARMResourceData
{
    PrivateLinkServiceConnectionState = new PrivateLinkConnectionState
    {
        Status = "Approved",
        Description = "Approved by johndoe@company.com",
    },
};
ArmOperation<HostingEnvironmentPrivateEndpointConnectionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, privateEndpointConnectionName, data);
HostingEnvironmentPrivateEndpointConnectionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
RemotePrivateEndpointConnectionARMResourceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Mintaválasz

Állapotkód:

200

{
  "name": "fa38656c-034e-43d8-adce-fe06ce039c98",
  "type": "Microsoft.Web/hostingEnvironments/privateEndpointConnections",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/privateEndpointConnections/fa38656c-034e-43d8-adce-fe06ce039c98",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/test-privateEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by johndoe@company.com",
      "actionsRequired": "None"
    },
    "ipAddresses": []
  }
}

Állapotkód:

202

{
  "name": "fa38656c-034e-43d8-adce-fe06ce039c98",
  "type": "Microsoft.Web/hostingEnvironments/privateEndpointConnections",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/privateEndpointConnections/fa38656c-034e-43d8-adce-fe06ce039c98",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/test-privateEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by johndoe@company.com",
      "actionsRequired": "None"
    },
    "ipAddresses": []
  }
}

Definíciók

Name	Description
ArmIdWrapper	ARM-erőforrás-azonosító burkolója
DefaultErrorResponse	App Service-hibaválasz.
Details
Error	Hibamodell.
PrivateLinkConnectionState	Privát kapcsolat állapota
RemotePrivateEndpointConnectionARMResource	Távoli privát végpont kapcsolati ARM-erőforrása.

ArmIdWrapper

Objektum

ARM-erőforrás-azonosító burkolója

Name	Típus	Description
id	string

DefaultErrorResponse

Objektum

App Service-hibaválasz.

Name	Típus	Description
error	Error	Hibamodell.

Details

Objektum

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

Error

Objektum

Hibamodell.

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
details	Details[]	Részletes hibák.
innererror	string	További információ a hibakereséshez.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

PrivateLinkConnectionState

Objektum

Privát kapcsolat állapota

Name	Típus	Description
actionsRequired	string	ActionsRequired egy privát kapcsolathoz
description	string	Privát kapcsolat leírása
status	string	Privát kapcsolat állapota

RemotePrivateEndpointConnectionARMResource

Objektum

Távoli privát végpont kapcsolati ARM-erőforrása.

Name	Típus	Description
id	string	Erőforrás-azonosító.
kind	string	Erőforrás típusa.
name	string	Erőforrás neve.
properties.ipAddresses	string[]	A távoli privát végpontra leképezett privát IPAddresses
properties.privateEndpoint	ArmIdWrapper	Távoli privát végpontkapcsolat PrivateEndpointja
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	Privát kapcsolat állapota
properties.provisioningState	string
type	string	Erőforrás típusa.