Preconfigured Endpoints - List

Servicio:

Front Door Service

Versión de la API:

2019-11-01

Obtiene una lista de puntos de conexión preconfigurados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/PreconfiguredEndpoints?api-version=2019-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
profileName	path	True	string pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$	Identificador de perfil asociado al inquilino y al asociado
resourceGroupName	path	True	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$	Nombre del grupo de recursos dentro de la suscripción de Azure.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	PreconfiguredEndpointList	De acuerdo. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Gets a list of Preconfigured Endpoints

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/PreconfiguredEndpoints?api-version=2019-11-01

Java

/**
 * Samples for PreconfiguredEndpoints List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/
     * NetworkExperimentGetPreconfiguredEndpoints.json
     */
    /**
     * Sample code: Gets a list of Preconfigured Endpoints.
     * 
     * @param manager Entry point to FrontDoorManager.
     */
    public static void getsAListOfPreconfiguredEndpoints(com.azure.resourcemanager.frontdoor.FrontDoorManager manager) {
        manager.preconfiguredEndpoints().list("MyResourceGroup", "MyProfile", 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.frontdoor import FrontDoorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-frontdoor
# USAGE
    python network_experiment_get_preconfigured_endpoints.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 = FrontDoorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.preconfigured_endpoints.list(
        resource_group_name="MyResourceGroup",
        profile_name="MyProfile",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentGetPreconfiguredEndpoints.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 armfrontdoor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/frontdoor/armfrontdoor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b54ffc9278eff071455b1dbb4ad2e772afce885d/specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentGetPreconfiguredEndpoints.json
func ExamplePreconfiguredEndpointsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armfrontdoor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPreconfiguredEndpointsClient().NewListPager("MyResourceGroup", "MyProfile", 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.PreconfiguredEndpointList = armfrontdoor.PreconfiguredEndpointList{
		// 	Value: []*armfrontdoor.PreconfiguredEndpoint{
		// 		{
		// 			Name: to.Ptr("Endpoint 1"),
		// 			Properties: &armfrontdoor.PreconfiguredEndpointProperties{
		// 				Description: to.Ptr("this is the endpoint 1 preconfigured endpoint."),
		// 				Backend: to.Ptr("WESTUS"),
		// 				Endpoint: to.Ptr("endpoint1.net"),
		// 				EndpointType: to.Ptr(armfrontdoor.EndpointTypeAFD),
		// 			},
		// 	}},
		// }
	}
}

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 { FrontDoorManagementClient } = require("@azure/arm-frontdoor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a list of Preconfigured Endpoints
 *
 * @summary Gets a list of Preconfigured Endpoints
 * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentGetPreconfiguredEndpoints.json
 */
async function getsAListOfPreconfiguredEndpoints() {
  const subscriptionId = process.env["FRONTDOOR_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["FRONTDOOR_RESOURCE_GROUP"] || "MyResourceGroup";
  const profileName = "MyProfile";
  const credential = new DefaultAzureCredential();
  const client = new FrontDoorManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.preconfiguredEndpoints.list(resourceGroupName, profileName)) {
    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

dotnet

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

// Generated from example definition: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentGetPreconfiguredEndpoints.json
// this example is just showing the usage of "PreconfiguredEndpoints_List" 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 FrontDoorNetworkExperimentProfileResource created on azure
// for more information of creating FrontDoorNetworkExperimentProfileResource, please refer to the document of FrontDoorNetworkExperimentProfileResource
string subscriptionId = "subid";
string resourceGroupName = "MyResourceGroup";
string profileName = "MyProfile";
ResourceIdentifier frontDoorNetworkExperimentProfileResourceId = FrontDoorNetworkExperimentProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
FrontDoorNetworkExperimentProfileResource frontDoorNetworkExperimentProfile = client.GetFrontDoorNetworkExperimentProfileResource(frontDoorNetworkExperimentProfileResourceId);

// invoke the operation and iterate over the result
await foreach (PreconfiguredEndpoint item in frontDoorNetworkExperimentProfile.GetPreconfiguredEndpointsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

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

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "name": "Endpoint 1",
      "properties": {
        "endpoint": "endpoint1.net",
        "description": "this is the endpoint 1 preconfigured endpoint.",
        "endpointType": "AFD",
        "backend": "WESTUS"
      }
    }
  ],
  "nextLink": "string"
}

Definiciones

Nombre	Description
endpointType	Tipo de punto de conexión
ErrorResponse	La respuesta de error indica que el servicio Front Door no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
PreconfiguredEndpoint	Define las propiedades de un punto de conexión preconfigurado.
PreconfiguredEndpointList	Define una lista de puntos de conexión preconfigurados.

endpointType

Enumeración

Tipo de punto de conexión

Valor	Description
AFD
ATM
AzureRegion
CDN

ErrorResponse

Object

La respuesta de error indica que el servicio Front Door no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

PreconfiguredEndpoint

Object

Define las propiedades de un punto de conexión preconfigurado.

Nombre	Tipo	Description
id	string	Identificador de recurso.
location	string	Ubicación del recurso.
name	string	Nombre del punto de conexión
properties.backend	string	Back-end del punto de conexión preconfigurado
properties.description	string	Descripción del punto de conexión
properties.endpoint	string	Punto de conexión preconfigurado
properties.endpointType	endpointType	Tipo de punto de conexión
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

PreconfiguredEndpointList

Object

Define una lista de puntos de conexión preconfigurados.

Nombre	Tipo	Description
nextLink	string	Dirección URL para obtener el siguiente conjunto de PreconfiguredEndpoints si hay alguno.
value	PreconfiguredEndpoint[]	Lista de preconfiguredEndpoints compatibles con NetworkExperiment.