Web Apps - Get Private Endpoint Connection Slot

Serviço:

App Service

Versão da API:

2024-04-01

Descrição para obter uma conexão de ponto de extremidade privado

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do site.
privateEndpointConnectionName	path	True	string	Nome da conexão de ponto de extremidade privado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
slot	path	True	string	Nome do slot de implantação do site.
subscriptionId	path	True	string	Sua ID de assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versão da API

Respostas

Nome	Tipo	Description
200 OK	RemotePrivateEndpointConnectionARMResource	OKEY
Other Status Codes	DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get a private endpoint connection for a site.

Solicitação de exemplo

HTTP

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

Java

/**
 * Samples for WebApps GetPrivateEndpointConnectionSlot.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionSlot.
     * json
     */
    /**
     * Sample code: Get a private endpoint connection for a site.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAPrivateEndpointConnectionForASite(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getPrivateEndpointConnectionSlotWithResponse("rg",
            "testSite", "connection", "stage", 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 get_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.get_private_endpoint_connection_slot(
        resource_group_name="rg",
        name="testSite",
        private_endpoint_connection_name="connection",
        slot="stage",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionSlot.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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionSlot.json
func ExampleWebAppsClient_GetPrivateEndpointConnectionSlot() {
	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)
	}
	res, err := clientFactory.NewWebAppsClient().GetPrivateEndpointConnectionSlot(ctx, "rg", "testSite", "connection", "stage", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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{
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slot/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

JavaScript

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

/**
 * This sample demonstrates how to Description for Gets a private endpoint connection
 *
 * @summary Description for Gets a private endpoint connection
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSitePrivateEndpointConnectionSlot.json
 */
async function getAPrivateEndpointConnectionForASite() {
  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 credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getPrivateEndpointConnectionSlot(
    resourceGroupName,
    name,
    privateEndpointConnectionName,
    slot,
  );
  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-04-01/examples/GetSitePrivateEndpointConnectionSlot.json
// this example is just showing the usage of "WebApps_GetPrivateEndpointConnectionSlot" 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 SiteSlotPrivateEndpointConnectionResource created on azure
// for more information of creating SiteSlotPrivateEndpointConnectionResource, please refer to the document of SiteSlotPrivateEndpointConnectionResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string name = "testSite";
string slot = "stage";
string privateEndpointConnectionName = "connection";
ResourceIdentifier siteSlotPrivateEndpointConnectionResourceId = SiteSlotPrivateEndpointConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, slot, privateEndpointConnectionName);
SiteSlotPrivateEndpointConnectionResource siteSlotPrivateEndpointConnection = client.GetSiteSlotPrivateEndpointConnectionResource(siteSlotPrivateEndpointConnectionResourceId);

// invoke the operation
SiteSlotPrivateEndpointConnectionResource result = await siteSlotPrivateEndpointConnection.GetAsync();

// 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

Resposta de exemplo

Código de status:

200

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

Definições

Nome	Description
ArmIdWrapper	Um wrapper para uma ID de recurso do ARM
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
PrivateLinkConnectionState	O estado de uma conexão de link privado
RemotePrivateEndpointConnectionARMResource	Recurso ARM de conexão de ponto de extremidade privado remoto.

ArmIdWrapper

Objeto

Um wrapper para uma ID de recurso do ARM

Nome	Tipo	Description
id	string

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Error

Objeto

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

PrivateLinkConnectionState

Objeto

O estado de uma conexão de link privado

Nome	Tipo	Description
actionsRequired	string	ActionsRequired para uma conexão de link privado
description	string	Descrição de uma conexão de link privado
status	string	Status de uma conexão de link privado

RemotePrivateEndpointConnectionARMResource

Objeto

Recurso ARM de conexão de ponto de extremidade privado remoto.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de recurso.
name	string	Nome do recurso.
properties.ipAddresses	string[]	IPAddresses privados mapeados para o ponto de extremidade privado remoto
properties.privateEndpoint	ArmIdWrapper	PrivateEndpoint de uma conexão de ponto de extremidade privado remoto
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	O estado de uma conexão de link privado
properties.provisioningState	string
type	string	Tipo de recurso.