Répertorie toutes les connexions de point de terminaison privé du instance de service Gestion des API.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections?api-version=2022-08-01
Paramètres URI
Nom |
Dans |
Obligatoire |
Type |
Description |
resourceGroupName
|
path |
True
|
string
|
Nom du groupe de ressources. Le nom ne respecte pas la casse.
|
serviceName
|
path |
True
|
string
|
Nom du service Gestion des API.
Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
subscriptionId
|
path |
True
|
string
|
ID de l’abonnement cible.
|
api-version
|
query |
True
|
string
|
Version de l’API à utiliser pour cette opération.
|
Réponses
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom |
Description |
user_impersonation
|
Emprunter l’identité de votre compte d’utilisateur
|
Exemples
ApiManagementListPrivateEndpointConnections
Exemple de requête
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections?api-version=2022-08-01
/** Samples for PrivateEndpointConnection ListByService. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPrivateEndpointConnections.json
*/
/**
* Sample code: ApiManagementListPrivateEndpointConnections.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementListPrivateEndpointConnections(
com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
manager.privateEndpointConnections().listByService("rg1", "apimService1", 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
from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-apimanagement
# USAGE
python api_management_list_private_endpoint_connections.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 = ApiManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.private_endpoint_connection.list_by_service(
resource_group_name="rg1",
service_name="apimService1",
)
for item in response:
print(item)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPrivateEndpointConnections.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 armapimanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPrivateEndpointConnections.json
func ExamplePrivateEndpointConnectionClient_NewListByServicePager() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateEndpointConnectionClient().NewListByServicePager("rg1", "apimService1", nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.PrivateEndpointConnectionListResult = armapimanagement.PrivateEndpointConnectionListResult{
// Value: []*armapimanagement.PrivateEndpointConnection{
// {
// Name: to.Ptr("privateEndpointProxyName"),
// Type: to.Ptr("Microsoft.ApiManagement/service/privateEndpointConnections"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName"),
// Properties: &armapimanagement.PrivateEndpointConnectionProperties{
// PrivateEndpoint: &armapimanagement.PrivateEndpoint{
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"),
// },
// PrivateLinkServiceConnectionState: &armapimanagement.PrivateLinkServiceConnectionState{
// Description: to.Ptr("Please approve my request, thanks"),
// ActionsRequired: to.Ptr("None"),
// Status: to.Ptr(armapimanagement.PrivateEndpointServiceConnectionStatusPending),
// },
// ProvisioningState: to.Ptr(armapimanagement.PrivateEndpointConnectionProvisioningStateSucceeded),
// },
// },
// {
// Name: to.Ptr("privateEndpointProxyName2"),
// Type: to.Ptr("Microsoft.ApiManagement/service/privateEndpointConnections"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName2"),
// Properties: &armapimanagement.PrivateEndpointConnectionProperties{
// PrivateEndpoint: &armapimanagement.PrivateEndpoint{
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName2"),
// },
// PrivateLinkServiceConnectionState: &armapimanagement.PrivateLinkServiceConnectionState{
// Description: to.Ptr("Please approve my request, thanks"),
// ActionsRequired: to.Ptr("None"),
// Status: to.Ptr(armapimanagement.PrivateEndpointServiceConnectionStatusPending),
// },
// ProvisioningState: to.Ptr(armapimanagement.PrivateEndpointConnectionProvisioningStateSucceeded),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists all private endpoint connections of the API Management service instance.
*
* @summary Lists all private endpoint connections of the API Management service instance.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPrivateEndpointConnections.json
*/
async function apiManagementListPrivateEndpointConnections() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.privateEndpointConnectionOperations.listByService(
resourceGroupName,
serviceName
)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;
// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListPrivateEndpointConnections.json
// this example is just showing the usage of "PrivateEndpointConnection_ListByService" 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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);
// get the collection of this ApiManagementPrivateEndpointConnectionResource
ApiManagementPrivateEndpointConnectionCollection collection = apiManagementService.GetApiManagementPrivateEndpointConnections();
// invoke the operation and iterate over the result
await foreach (ApiManagementPrivateEndpointConnectionResource item in collection.GetAllAsync())
{
// the variable item 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
ApiManagementPrivateEndpointConnectionData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Exemple de réponse
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"name": "privateEndpointProxyName",
"properties": {
"provisioningState": "Pending",
"privateEndpoint": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
},
"privateLinkServiceConnectionState": {
"status": "Pending",
"description": "Please approve my request, thanks",
"actionsRequired": "None"
}
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName2",
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"name": "privateEndpointProxyName2",
"properties": {
"provisioningState": "Pending",
"privateEndpoint": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName2"
},
"privateLinkServiceConnectionState": {
"status": "Pending",
"description": "Please approve my request, thanks",
"actionsRequired": "None"
}
}
}
]
}
Définitions
ErrorFieldContract
Contrat de champ d’erreur.
Nom |
Type |
Description |
code
|
string
|
Code d'erreur de niveau propriété.
|
message
|
string
|
Représentation lisible par l’homme de l’erreur au niveau des propriétés.
|
target
|
string
|
Nom de propriété.
|
ErrorResponse
Réponse d’erreur.
Nom |
Type |
Description |
error.code
|
string
|
Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.
|
error.details
|
ErrorFieldContract[]
|
Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.
|
error.message
|
string
|
Représentation contrôlable de visu de l’erreur.
|
PrivateEndpoint
Ressource de point de terminaison privé.
Nom |
Type |
Description |
id
|
string
|
Identificateur ARM pour le point de terminaison privé
|
PrivateEndpointConnection
Ressource de connexion de point de terminaison privé.
Nom |
Type |
Description |
id
|
string
|
ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
name
|
string
|
nom de la ressource.
|
properties.privateEndpoint
|
PrivateEndpoint
|
Ressource du point de terminaison privé.
|
properties.privateLinkServiceConnectionState
|
PrivateLinkServiceConnectionState
|
Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.
|
properties.provisioningState
|
PrivateEndpointConnectionProvisioningState
|
État d’approvisionnement de la ressource de connexion de point de terminaison privé.
|
type
|
string
|
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »
|
PrivateEndpointConnectionListResult
Liste des connexions de point de terminaison privé associées au compte de stockage spécifié
PrivateEndpointConnectionProvisioningState
État d’approvisionnement actuel.
Nom |
Type |
Description |
Creating
|
string
|
|
Deleting
|
string
|
|
Failed
|
string
|
|
Succeeded
|
string
|
|
PrivateEndpointServiceConnectionStatus
La connexion de point de terminaison privé status.
Nom |
Type |
Description |
Approved
|
string
|
|
Pending
|
string
|
|
Rejected
|
string
|
|
PrivateLinkServiceConnectionState
Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.
Nom |
Type |
Description |
actionsRequired
|
string
|
Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.
|
description
|
string
|
Motif de l’approbation/du rejet de la connexion.
|
status
|
PrivateEndpointServiceConnectionStatus
|
Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.
|