Prefixes - Get

服务:

Peering

API 版本:

2025-05-01

获取具有给定订阅、资源组和对等互连服务下指定名称的现有前缀。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
peeringServiceName	path	True	string pattern: [A-Za-z0-9_.-]{1,63}	对等互连的名称。
prefixName	path	True	string pattern: [A-Za-z0-9_.-]{1,63}	前缀的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
$expand	query		string	要展开的属性。

响应

名称	类型	说明
200 OK	PeeringServicePrefix	Azure 操作已成功完成。
Other Status Codes	ErrorResponse	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get a prefix associated with the peering service

示例请求

HTTP

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.peering import PeeringManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-peering
# USAGE
    python get_peering_service_prefix.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.get(
        resource_group_name="rgName",
        peering_service_name="peeringServiceName",
        prefix_name="peeringServicePrefixName",
    )
    print(response)


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

示例响应

状态代码:

200

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

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
LearnedType	前缀已学习类型
PeeringServicePrefix	对等互连服务前缀类。
PeeringServicePrefixEvent	与前缀关联的事件的详细信息。
PrefixValidationState	前缀验证状态。
ProvisioningState	资源的预配状态。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

LearnedType

枚举

前缀已学习类型

值	说明
None
ViaServiceProvider
ViaSession

PeeringServicePrefix

对象

对等互连服务前缀类。

名称	类型	说明
id	string	资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.errorMessage	string	验证状态的错误消息
properties.events	PeeringServicePrefixEvent[]	对等互连服务前缀的事件列表
properties.learnedType	LearnedType	前缀已学习类型
properties.peeringServicePrefixKey	string	对等互连服务前缀密钥
properties.prefix	string	流量源自的前缀。
properties.prefixValidationState	PrefixValidationState	前缀验证状态
properties.provisioningState	ProvisioningState	资源的预配状态。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PeeringServicePrefixEvent

对象

与前缀关联的事件的详细信息。

名称	类型	说明
eventDescription	string	与前缀关联的事件的描述。
eventLevel	string	与前缀关联的事件级别。
eventSummary	string	与前缀关联的事件摘要。
eventTimestamp	string (date-time)	与前缀关联的事件的时间戳。
eventType	string	与前缀关联的事件类型。

PrefixValidationState

枚举

前缀验证状态。

值	说明
None
Invalid
Verified
Failed
Pending
Warning
Unknown

ProvisioningState

枚举

资源的预配状态。

值	说明
Succeeded
Updating
Deleting
Failed
Canceled

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳 （UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。