你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Public IP Prefixes - List

获取资源组中的所有公共 IP 前缀。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes?api-version=2022-01-01

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

客户端 API 版本。

响应

Name Type Description
200 OK

请求成功。 该操作返回 PublicIPPrefix 资源的列表。

Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

List resource group public IP prefixes

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes?api-version=2022-01-01

Sample Response

{
  "value": [
    {
      "name": "test-ipprefix",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix",
      "etag": "W/\"00000000-0000-0000-0000-00000000\"",
      "location": "westus",
      "properties": {
        "provisioningState": "Succeeded",
        "resourceGuid": "00000000-0000-0000-0000-00000000",
        "publicIPAddressVersion": "IPv4",
        "prefixLength": 30,
        "ipPrefix": "40.85.154.2/30",
        "ipTags": [
          {
            "ipTagType": "FirstPartyUsage",
            "tag": "SQL"
          }
        ]
      },
      "sku": {
        "name": "Standard"
      },
      "type": "Microsoft.Network/publicIPPrefixes"
    },
    {
      "name": "ipprefix03",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/ipprefix03",
      "etag": "W/\"00000000-0000-0000-0000-00000000\"",
      "location": "westus",
      "properties": {
        "provisioningState": "Succeeded",
        "resourceGuid": "00000000-0000-0000-0000-00000000",
        "publicIPAddressVersion": "IPv4",
        "prefixLength": 31,
        "ipPrefix": "40.85.153.2/31",
        "ipTags": []
      },
      "sku": {
        "name": "Standard"
      },
      "type": "Microsoft.Network/publicIPPrefixes"
    }
  ]
}

定义

CloudError

服务的错误响应。

CloudErrorBody

服务的错误响应。

ExtendedLocation

ExtendedLocation 复杂类型。

ExtendedLocationTypes

扩展位置的类型。

IpTag

包含与对象关联的 IpTag。

IPVersion

IP 地址版本。

NatGateway

Nat 网关资源。

NatGatewaySku

NAT 网关的 SKU。

NatGatewaySkuName

Nat 网关 SKU 的名称。

ProvisioningState

当前预配状态。

PublicIPPrefix

公共 IP 前缀资源。

PublicIPPrefixListResult

ListPublicIpPrefixes API 服务调用的响应。

PublicIPPrefixSku

公共 IP 前缀的 SKU。

PublicIPPrefixSkuName

公共 IP 前缀 SKU 的名称。

PublicIPPrefixSkuTier

公共 IP 前缀 SKU 的层。

ReferencedPublicIpAddress

对公共 IP 地址的引用。

SubResource

对另一个子资源的引用。

CloudError

服务的错误响应。

Name Type Description
error

云错误正文。

CloudErrorBody

服务的错误响应。

Name Type Description
code
  • string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

有关错误的其他详细信息的列表。

message
  • string

描述错误的消息,旨在适合在用户界面中显示。

target
  • string

特定错误的目标。 例如,错误属性的名称。

ExtendedLocation

ExtendedLocation 复杂类型。

Name Type Description
name
  • string

扩展位置的名称。

type

扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

Name Type Description
EdgeZone
  • string

IpTag

包含与对象关联的 IpTag。

Name Type Description
ipTagType
  • string

IP 标记类型。 示例:FirstPartyUsage。

tag
  • string

与公共 IP 关联的 IP 标记的值。 示例:SQL。

IPVersion

IP 地址版本。

Name Type Description
IPv4
  • string
IPv6
  • string

NatGateway

Nat 网关资源。

Name Type Description
etag
  • string

在更新资源时更改的唯一只读字符串。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.idleTimeoutInMinutes
  • integer

nat 网关的空闲超时。

properties.provisioningState

NAT 网关资源的预配状态。

properties.publicIpAddresses

与 nat 网关资源关联的公共 IP 地址数组。

properties.publicIpPrefixes

与 nat 网关资源关联的公共 IP 前缀数组。

properties.resourceGuid
  • string

NAT 网关资源的资源 GUID 属性。

properties.subnets

使用此 nat 网关资源引用子网的数组。

sku

nat 网关 SKU。

tags
  • object

资源标记。

type
  • string

资源类型。

zones
  • string[]

表示应在其中部署 Nat 网关的区域的可用性区域的列表。

NatGatewaySku

NAT 网关的 SKU。

Name Type Description
name

Nat 网关 SKU 的名称。

NatGatewaySkuName

Nat 网关 SKU 的名称。

Name Type Description
Standard
  • string

ProvisioningState

当前预配状态。

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

PublicIPPrefix

公共 IP 前缀资源。

Name Type Description
etag
  • string

在更新资源时更改的唯一只读字符串。

extendedLocation

公共 IP 地址的扩展位置。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.customIPPrefix

与此前缀关联的 customIpPrefix。

properties.ipPrefix
  • string

分配的前缀。

properties.ipTags

与公共 IP 前缀关联的标记列表。

properties.loadBalancerFrontendIpConfiguration

对与公共 IP 前缀关联的负载均衡器前端 IP 配置的引用。

properties.natGateway

公共 IP 前缀的 NatGateway。

properties.prefixLength
  • integer

公共 IP 前缀的长度。

properties.provisioningState

公共 IP 前缀资源的预配状态。

properties.publicIPAddressVersion

公共 IP 地址版本。

properties.publicIPAddresses

所有引用的 PublicIPAddresses 的列表。

properties.resourceGuid
  • string

公共 IP 前缀资源的资源 GUID 属性。

sku

公共 IP 前缀 SKU。

tags
  • object

资源标记。

type
  • string

资源类型。

zones
  • string[]

表示为资源分配的 IP 的可用性区域列表。

PublicIPPrefixListResult

ListPublicIpPrefixes API 服务调用的响应。

Name Type Description
nextLink
  • string

用于获取下一组结果的 URL。

value

资源组中存在的公共 IP 前缀列表。

PublicIPPrefixSku

公共 IP 前缀的 SKU。

Name Type Description
name

公共 IP 前缀 SKU 的名称。

tier

公共 IP 前缀 SKU 的层。

PublicIPPrefixSkuName

公共 IP 前缀 SKU 的名称。

Name Type Description
Standard
  • string

PublicIPPrefixSkuTier

公共 IP 前缀 SKU 的层。

Name Type Description
Global
  • string
Regional
  • string

ReferencedPublicIpAddress

对公共 IP 地址的引用。

Name Type Description
id
  • string

PublicIPAddress 参考。

SubResource

对另一个子资源的引用。

Name Type Description
id
  • string

资源 ID。