Prefixes - List By Peering Service

Serviço:: Peering

Versão da API:: 2025-05-01

Lista todos os prefixos sob a assinatura, grupo de recursos e serviço de emparelhamento fornecidos.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
peeringServiceName	path	True	string pattern: [A-Za-z0-9_.-]{1,63}	O nome do emparelhamento.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
$expand	query		string	As propriedades a serem expandidas.

Respostas

Name	Tipo	Description
200 OK	PeeringServicePrefixListResult	Operação do Azure concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar 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=2025-05-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.peering import PeeringManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-peering
# USAGE
    python list_prefixes_by_peering_service.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 = PeeringManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.prefixes.list_by_peering_service(
        resource_group_name="rgName",
        peering_service_name="peeringServiceName",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-05-01/ListPrefixesByPeeringService.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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
LearnedType	O prefixo aprendido tipo
PeeringServicePrefix	A classe de prefixo do serviço de emparelhamento.
PeeringServicePrefixEvent	Os detalhes do evento associado a um prefixo.
PeeringServicePrefixListResult	A resposta de uma operação de lista PeeringServicePrefix.
PrefixValidationState	O estado de validação do prefixo.
ProvisioningState	O estado de provisionamento do recurso.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

LearnedType

Enumeração

O prefixo aprendido tipo

Valor	Description
None
ViaServiceProvider
ViaSession

PeeringServicePrefix

Object

A classe de prefixo do serviço de emparelhamento.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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 emparelhamento
properties.learnedType	LearnedType	O prefixo aprendido tipo
properties.peeringServicePrefixKey	string	A chave de prefixo do serviço de emparelhamento
properties.prefix	string	O prefixo do qual o tráfego se origina.
properties.prefixValidationState	PrefixValidationState	O estado de validação do prefixo
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PeeringServicePrefixEvent

Object

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 (date-time)	O carimbo de data/hora do evento associado a um prefixo.
eventType	string	O tipo de evento associado a um prefixo.

PeeringServicePrefixListResult

Object

A resposta de uma operação de lista PeeringServicePrefix.

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	PeeringServicePrefix[]	Os itens PeeringServicePrefix nesta página

PrefixValidationState

Enumeração

O estado de validação do prefixo.

Valor	Description
None
Invalid
Verified
Failed
Pending
Warning
Unknown

ProvisioningState

Enumeração

O estado de provisionamento do recurso.

Valor	Description
Succeeded
Updating
Deleting
Failed
Canceled

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.