Prefixes - List By Peering Service

Referencia

Service:: Peering

API Version:: 2021-01-01

Listas todos los prefijos de la suscripción, el grupo de recursos y el servicio de emparejamiento especificados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes?api-version=2021-01-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName}/prefixes?$expand={$expand}&api-version=2021-01-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
peeringServiceName	path	True	string	Nombre del servicio de emparejamiento.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	El identificador de la suscripción de Azure.
api-version	query	True	string	La versión de la API de cliente.
$expand	query		string	Propiedades que se van a expandir.

Respuestas

Nombre	Tipo	Description
200 OK	PeeringServicePrefixListResult	Aceptar
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

List all the prefixes associated with the peering service

GET https://management.azure.com/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes?api-version=2021-01-01

/** Samples for Prefixes ListByPeeringService. */
public final class Main {
    /*
     * x-ms-original-file: specification/peering/resource-manager/Microsoft.Peering/stable/2021-01-01/examples/ListPrefixesByPeeringService.json
     */
    /**
     * Sample code: List all the prefixes associated with the peering service.
     *
     * @param manager Entry point to PeeringManager.
     */
    public static void listAllThePrefixesAssociatedWithThePeeringService(
        com.azure.resourcemanager.peering.PeeringManager manager) {
        manager.prefixes().listByPeeringService("rgName", "peeringServiceName", null, 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

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "prefix": "192.168.1.0/24",
        "prefixValidationState": "Verified",
        "learnedType": "ViaServiceProvider",
        "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000",
        "provisioningState": "Succeeded"
      },
      "name": "peeringServicePrefixName1",
      "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes/peeringServicePrefixName1"
    },
    {
      "properties": {
        "prefix": "192.168.2.0/24",
        "prefixValidationState": "Verified",
        "learnedType": "ViaServiceProvider",
        "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000",
        "provisioningState": "Succeeded"
      },
      "name": "peeringServicePrefixName2",
      "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peeringServices/peeringServiceName/prefixes/peeringServicePrefixName2"
    }
  ]
}

Definiciones

Nombre	Description
ErrorDetail	El detalle del error que describe por qué se ha producido un error en una operación.
ErrorResponse	Respuesta de error que indica por qué se ha producido un error en una operación.
learnedType	Tipo de prefijo aprendido
PeeringServicePrefix	La clase de prefijo del servicio de emparejamiento.
PeeringServicePrefixEvent	Detalles del evento asociado a un prefijo.
PeeringServicePrefixListResult	Lista paginada de prefijos del servicio de emparejamiento.
prefixValidationState	Estado de validación de prefijo.
provisioningState	Estado de aprovisionamiento del recurso.

ErrorDetail

El detalle del error que describe por qué se ha producido un error en una operación.

Nombre	Tipo	Description
code	string	Código de error.
message	string	El mensaje de error.

ErrorResponse

Respuesta de error que indica por qué se ha producido un error en una operación.

Nombre	Tipo	Description
error	ErrorDetail	El detalle del error que describe por qué se ha producido un error en una operación.

learnedType

Tipo de prefijo aprendido

Nombre	Tipo	Description
None	string
ViaServiceProvider	string
ViaSession	string

PeeringServicePrefix

La clase de prefijo del servicio de emparejamiento.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.errorMessage	string	Mensaje de error para el estado de validación
properties.events	PeeringServicePrefixEvent[]	Lista de eventos para el prefijo del servicio de emparejamiento
properties.learnedType	learnedType	Tipo de prefijo aprendido
properties.peeringServicePrefixKey	string	Clave de prefijo del servicio de emparejamiento
properties.prefix	string	Prefijo desde el que se origina el tráfico.
properties.prefixValidationState	prefixValidationState	Estado de validación de prefijo
properties.provisioningState	provisioningState	Estado de aprovisionamiento del recurso.
type	string	Tipo de recurso.

PeeringServicePrefixEvent

Detalles del evento asociado a un prefijo.

Nombre	Tipo	Description
eventDescription	string	Descripción del evento asociado a un prefijo.
eventLevel	string	Nivel del evento asociado a un prefijo.
eventSummary	string	Resumen del evento asociado a un prefijo.
eventTimestamp	string	Marca de tiempo del evento asociado a un prefijo.
eventType	string	Tipo del evento asociado a un prefijo.

PeeringServicePrefixListResult

Lista paginada de prefijos del servicio de emparejamiento.

Nombre	Tipo	Description
nextLink	string	Vínculo para capturar la página siguiente de prefijos del servicio de emparejamiento.
value	PeeringServicePrefix[]	Lista de prefijos del servicio de emparejamiento.

prefixValidationState

Estado de validación de prefijo.

Nombre	Tipo	Description
Failed	string
Invalid	string
None	string
Pending	string
Unknown	string
Verified	string
Warning	string

provisioningState

Estado de aprovisionamiento del recurso.

Nombre	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string