Prefixes - List By Peering Service

Referência

Service:: Peering

API Version:: 2021-01-01

Listas todos os prefixos na subscrição, grupo de recursos e serviço de peering 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 do URI

Name	Em	Necessário	Tipo	Description
peeringServiceName	path	True	string	O nome do serviço de peering.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	O ID da subscrição do Azure.
api-version	query	True	string	A versão da API de cliente.
$expand	query		string	As propriedades a expandir.

Respostas

Name	Tipo	Description
200 OK	PeeringServicePrefixListResult	OK
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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"
    }
  ]
}

Definições

Name	Description
ErrorDetail	O detalhe do erro que descreve o motivo pelo qual uma operação falhou.
ErrorResponse	A resposta de erro que indica a razão pela qual uma operação falhou.
learnedType	O tipo de prefixo aprendido
PeeringServicePrefix	A classe de prefixo do serviço de peering.
PeeringServicePrefixEvent	Os detalhes do evento associado a um prefixo.
PeeringServicePrefixListResult	A lista paginada de prefixos do serviço de peering.
prefixValidationState	O estado de validação do prefixo.
provisioningState	O estado de aprovisionamento do recurso.

ErrorDetail

O detalhe do erro que descreve o motivo pelo qual uma operação falhou.

Name	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.

ErrorResponse

A resposta de erro que indica a razão pela qual uma operação falhou.

Name	Tipo	Description
error	ErrorDetail	O detalhe do erro que descreve o motivo pelo qual uma operação falhou.

learnedType

O tipo de prefixo aprendido

Name	Tipo	Description
None	string
ViaServiceProvider	string
ViaSession	string

PeeringServicePrefix

A classe de prefixo do serviço de peering.

Name	Tipo	Description
id	string	O ID do recurso.
name	string	O nome do recurso.
properties.errorMessage	string	A mensagem de erro para o estado de validação
properties.events	PeeringServicePrefixEvent[]	A lista de eventos para o prefixo do serviço de peering
properties.learnedType	learnedType	O tipo de prefixo aprendido
properties.peeringServicePrefixKey	string	A chave de prefixo do serviço de peering
properties.prefix	string	O prefixo a partir do qual o tráfego é originado.
properties.prefixValidationState	prefixValidationState	O estado de validação do prefixo
properties.provisioningState	provisioningState	O estado de aprovisionamento do recurso.
type	string	O tipo de recurso.

PeeringServicePrefixEvent

Os detalhes do evento associado a um prefixo.

Name	Tipo	Description
eventDescription	string	A descrição do evento associado a um prefixo.
eventLevel	string	O nível do evento associado a um prefixo.
eventSummary	string	O resumo do evento associado a um prefixo.
eventTimestamp	string	O carimbo de data/hora do evento associado a um prefixo.
eventType	string	O tipo de evento associado a um prefixo.

PeeringServicePrefixListResult

A lista paginada de prefixos do serviço de peering.

Name	Tipo	Description
nextLink	string	A ligação para obter a página seguinte dos prefixos do serviço de peering.
value	PeeringServicePrefix[]	A lista de prefixos do serviço de peering.

prefixValidationState

O estado de validação do prefixo.

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

provisioningState

O estado de aprovisionamento do recurso.

Name	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string