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

Microsoft.Network publicIPPrefixes

Bicep 资源定义

publicIPPrefixes 资源类型可以使用面向以下对象的操作进行部署:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/publicIPPrefixes 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Network/publicIPPrefixes@2023-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'Standard'
    tier: 'string'
  }
  extendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  properties: {
    customIPPrefix: {
      id: 'string'
    }
    ipTags: [
      {
        ipTagType: 'string'
        tag: 'string'
      }
    ]
    natGateway: {
      id: 'string'
      location: 'string'
      properties: {
        idleTimeoutInMinutes: int
        publicIpAddresses: [
          {
            id: 'string'
          }
        ]
        publicIpPrefixes: [
          {
            id: 'string'
          }
        ]
      }
      sku: {
        name: 'Standard'
      }
      tags: {}
      zones: [
        'string'
      ]
    }
    prefixLength: int
    publicIPAddressVersion: 'string'
  }
  zones: [
    'string'
  ]
}

属性值

publicIPPrefixes

名称 说明
name 资源名称 字符串 (必需)

字符限制:1-80

有效字符:
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
location 资源位置。 字符串
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 公共 IP 前缀 SKU。 PublicIPPrefixSku
extendedLocation 公共 IP 地址的扩展位置。 ExtendedLocation
properties 公共 IP 前缀属性。 PublicIPPrefixPropertiesFormat
zones 一个可用性区域列表,指示为资源分配的 IP 需要来自。 string[]

ExtendedLocation

名称 说明
name 扩展位置的名称。 字符串
type 扩展位置的类型。 “EdgeZone”

PublicIPPrefixPropertiesFormat

名称 说明
customIPPrefix 与此前缀关联的 customIpPrefix。 对象 (object)
ipTags 与公共 IP 前缀关联的标记列表。 IpTag[]
natGateway 公共 IP 前缀的 NatGateway。 NatGateway
prefixLength 公共 IP 前缀的长度。 int
publicIPAddressVersion 公共 IP 地址版本。 “IPv4”
“IPv6”

SubResource

名称 说明 Value
id 资源 ID。 字符串

IpTag

名称 说明
ipTagType IP 标记类型。 示例:FirstPartyUsage。 字符串
标记 与公共 IP 关联的 IP 标记的值。 示例:SQL。 字符串

NatGateway

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties Nat 网关属性。 NatGatewayPropertiesFormat
sku nat 网关 SKU。 NatGatewaySku
标记 资源标记。 对象 (object)
zones 指示应在其中部署 Nat 网关的区域的可用性区域列表。 string[]

NatGatewayPropertiesFormat

名称 说明
idleTimeoutInMinutes nat 网关的空闲超时。 int
publicIpAddresses 与 nat 网关资源关联的公共 IP 地址数组。 SubResource[]
publicIpPrefixes 与 nat 网关资源关联的公共 IP 前缀数组。 SubResource[]

NatGatewaySku

名称 说明
name Nat 网关 SKU 的名称。 'Standard'

PublicIPPrefixSku

名称 说明
name 公共 IP 前缀 SKU 的名称。 'Standard'
公共 IP 前缀 SKU 的层。 'Global'
'Regional'

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
具有 NAT 网关和应用程序网关的 AKS 群集

部署到 Azure
此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接,为入站连接部署应用程序网关。
具有公共 IP 前缀的 VMSS

部署到 Azure
用于部署具有公共 IP 前缀的 VMSS 的模板
创建具有多个 IP 公共地址的 Azure 防火墙

部署到 Azure
此模板创建一个Azure 防火墙,其中包含两个公共 IP 地址和两个要测试的 Windows Server 2019 服务器。

ARM 模板资源定义

publicIPPrefixes 资源类型可以使用面向以下对象的操作进行部署:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/publicIPPrefixes 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Network/publicIPPrefixes",
  "apiVersion": "2023-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "Standard",
    "tier": "string"
  },
  "extendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "properties": {
    "customIPPrefix": {
      "id": "string"
    },
    "ipTags": [
      {
        "ipTagType": "string",
        "tag": "string"
      }
    ],
    "natGateway": {
      "id": "string",
      "location": "string",
      "properties": {
        "idleTimeoutInMinutes": "int",
        "publicIpAddresses": [
          {
            "id": "string"
          }
        ],
        "publicIpPrefixes": [
          {
            "id": "string"
          }
        ]
      },
      "sku": {
        "name": "Standard"
      },
      "tags": {},
      "zones": [ "string" ]
    },
    "prefixLength": "int",
    "publicIPAddressVersion": "string"
  },
  "zones": [ "string" ]
}

属性值

publicIPPrefixes

名称 说明 Value
type 资源类型 “Microsoft.Network/publicIPPrefixes”
apiVersion 资源 API 版本 '2023-11-01'
name 资源名称 字符串 (必需)

字符限制:1-80

有效字符:
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
location 资源位置。 字符串
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 公共 IP 前缀 SKU。 PublicIPPrefixSku
extendedLocation 公共 IP 地址的扩展位置。 ExtendedLocation
properties 公共 IP 前缀属性。 PublicIPPrefixPropertiesFormat
zones 一个可用性区域列表,指示为资源分配的 IP 需要来自。 string[]

ExtendedLocation

名称 说明
name 扩展位置的名称。 字符串
type 扩展位置的类型。 “EdgeZone”

PublicIPPrefixPropertiesFormat

名称 说明
customIPPrefix 与此前缀关联的 customIpPrefix。 对象 (object)
ipTags 与公共 IP 前缀关联的标记列表。 IpTag[]
natGateway 公共 IP 前缀的 NatGateway。 NatGateway
prefixLength 公共 IP 前缀的长度。 int
publicIPAddressVersion 公共 IP 地址版本。 “IPv4”
“IPv6”

SubResource

名称 说明 Value
id 资源 ID。 字符串

IpTag

名称 说明
ipTagType IP 标记类型。 示例:FirstPartyUsage。 字符串
标记 与公共 IP 关联的 IP 标记的值。 示例:SQL。 字符串

NatGateway

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties Nat 网关属性。 NatGatewayPropertiesFormat
sku NAT 网关 SKU。 NatGatewaySku
标记 资源标记。 对象 (object)
zones 一个可用性区域列表,指示应在其中部署 Nat 网关的区域。 string[]

NatGatewayPropertiesFormat

名称 说明
idleTimeoutInMinutes nat 网关的空闲超时。 int
publicIpAddresses 与 nat 网关资源关联的公共 IP 地址数组。 SubResource[]
publicIpPrefixes 与 nat 网关资源关联的公共 IP 前缀数组。 SubResource[]

NatGatewaySku

名称 说明
name Nat 网关 SKU 的名称。 “Standard”

PublicIPPrefixSku

名称 说明
name 公共 IP 前缀 SKU 的名称。 “Standard”
公共 IP 前缀 SKU 的层。 “Global”
“区域”

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
具有 NAT 网关和应用程序网关的 AKS 群集

部署到 Azure
此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接,为入站连接部署应用程序网关。
具有公共 IP 前缀的 VMSS

部署到 Azure
用于部署具有公共 IP 前缀的 VMSS 的模板
创建具有多个 IP 公共地址的 Azure 防火墙

部署到 Azure
此模板创建一个Azure 防火墙,其中包含两个公共 IP 地址和两个要测试的 Windows Server 2019 服务器。

Terraform (AzAPI 提供程序) 资源定义

publicIPPrefixes 资源类型可以通过针对以下操作进行部署:

  • 资源组

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Network/publicIPPrefixes 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/publicIPPrefixes@2023-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      customIPPrefix = {
        id = "string"
      }
      ipTags = [
        {
          ipTagType = "string"
          tag = "string"
        }
      ]
      natGateway = {
        id = "string"
        location = "string"
        properties = {
          idleTimeoutInMinutes = int
          publicIpAddresses = [
            {
              id = "string"
            }
          ]
          publicIpPrefixes = [
            {
              id = "string"
            }
          ]
        }
        sku = {
          name = "Standard"
        }
        tags = {}
        zones = [
          "string"
        ]
      }
      prefixLength = int
      publicIPAddressVersion = "string"
    }
    zones = [
      "string"
    ]
    sku = {
      name = "Standard"
      tier = "string"
    }
    extendedLocation = {
      name = "string"
      type = "EdgeZone"
    }
  })
}

属性值

publicIPPrefixes

名称 说明 Value
type 资源类型 “Microsoft.Network/publicIPPrefixes@2023-11-01”
name 资源名称 字符串 (必需)

字符限制:1-80

有效字符:
字母数字、下划线字符、句点和连字符。

以字母数字开头。 以字母数字或下划线结尾。
location 资源位置。 字符串
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
sku 公共 IP 前缀 SKU。 PublicIPPrefixSku
extendedLocation 公共 IP 地址的扩展位置。 ExtendedLocation
properties 公共 IP 前缀属性。 PublicIPPrefixPropertiesFormat
zones 一个可用性区域列表,指示为资源分配的 IP 需要来自。 string[]

ExtendedLocation

名称 说明
name 扩展位置的名称。 字符串
type 扩展位置的类型。 “EdgeZone”

PublicIPPrefixPropertiesFormat

名称 说明
customIPPrefix 与此前缀关联的 customIpPrefix。 对象 (object)
ipTags 与公共 IP 前缀关联的标记列表。 IpTag[]
natGateway 公共 IP 前缀的 NatGateway。 NatGateway
prefixLength 公共 IP 前缀的长度。 int
publicIPAddressVersion 公共 IP 地址版本。 “IPv4”
“IPv6”

SubResource

名称 说明 Value
id 资源 ID。 字符串

IpTag

名称 说明
ipTagType IP 标记类型。 示例:FirstPartyUsage。 字符串
标记 与公共 IP 关联的 IP 标记的值。 示例:SQL。 字符串

NatGateway

名称 说明 Value
id 资源 ID。 字符串
location 资源位置。 string
properties Nat 网关属性。 NatGatewayPropertiesFormat
sku nat 网关 SKU。 NatGatewaySku
标记 资源标记。 对象 (object)
zones 指示应在其中部署 Nat 网关的区域的可用性区域列表。 string[]

NatGatewayPropertiesFormat

名称 说明
idleTimeoutInMinutes nat 网关的空闲超时。 int
publicIpAddresses 与 nat 网关资源关联的公共 IP 地址数组。 SubResource[]
publicIpPrefixes 与 nat 网关资源关联的公共 IP 前缀数组。 SubResource[]

NatGatewaySku

名称 说明
name Nat 网关 SKU 的名称。 “Standard”

PublicIPPrefixSku

名称 说明
name 公共 IP 前缀 SKU 的名称。 “Standard”
公共 IP 前缀 SKU 的层。 “Global”
“区域”