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

Microsoft.Network publicIPPrefixes 2023-06-01

• 最新
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01

Bicep 资源定义

可以使用目标操作部署 publicIPPrefixes 资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.Network/publicIPPrefixes@2023-06-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  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: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
      zones: [
        'string'
      ]
    }
    prefixLength: int
    publicIPAddressVersion: 'string'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

属性值

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	字符串
类型	扩展位置的类型。	“EdgeZone”

IpTag

名字	描述	价值
ipTagType	IP 标记类型。 示例：FirstPartyUsage。	字符串
标记	与公共 IP 关联的 IP 标记的值。 示例：SQL。	字符串

Microsoft.Network/publicIPPrefixes

名字	描述	价值
extendedLocation	公共 IP 地址的扩展位置。	ExtendedLocation
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	公共 IP 前缀属性。	PublicIPPrefixPropertiesFormat
sku	公共 IP 前缀 SKU。	PublicIPPrefixSku
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
区	表示为资源分配的 IP 需要来自的可用性区域列表。	string[]

NatGateway

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	Nat 网关属性。	NatGatewayPropertiesFormat
sku	nat 网关 SKU。	NatGatewaySku
标签	资源标记。	ResourceTags
区	表示应在其中部署 Nat 网关的区域的可用性区域的列表。	string[]

NatGatewayPropertiesFormat

名字	描述	价值
idleTimeoutInMinutes	nat 网关的空闲超时。	int
publicIpAddresses	与 nat 网关资源关联的公共 IP 地址数组。	SubResource[]
publicIpPrefixes	与 nat 网关资源关联的公共 IP 前缀数组。	SubResource[]

NatGatewaySku

名字	描述	价值
名字	Nat 网关 SKU 的名称。	“Standard”

PublicIPPrefixPropertiesFormat

名字	描述	价值
customIPPrefix	此前缀与之关联的 customIpPrefix。	SubResource
ipTags	与公共 IP 前缀关联的标记列表。	IpTag[]
natGateway	公共 IP 前缀的 NatGateway。	NatGateway
prefixLength	公共 IP 前缀的长度。	int
publicIPAddressVersion	公共 IP 地址版本。	“IPv4” “IPv6”

PublicIPPrefixSku

名字	描述	价值
名字	公共 IP 前缀 SKU 的名称。	“Standard”
层	公共 IP 前缀 SKU 的层。	“Global” “区域”

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

SubResource

名字	描述	价值
id	资源 ID。	字符串

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
使用 NAT 网关和应用程序网关 AKS 群集	此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，以及如何为入站连接部署应用程序网关。
创建具有多个 IP 公共地址的 Azure 防火墙	此模板创建一个 Azure 防火墙，其中包含两个公共 IP 地址和两台要测试的 Windows Server 2019 服务器。
使用公共 IP 前缀 VMSS	用于部署具有公共 IP 前缀的 VMSS 的模板

ARM 模板资源定义

可以使用目标操作部署 publicIPPrefixes 资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.Network/publicIPPrefixes",
  "apiVersion": "2023-06-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "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": "string"
      },
      "tags": {
        "{customized property}": "string"
      },
      "zones": [ "string" ]
    },
    "prefixLength": "int",
    "publicIPAddressVersion": "string"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

属性值

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	字符串
类型	扩展位置的类型。	“EdgeZone”

IpTag

名字	描述	价值
ipTagType	IP 标记类型。 示例：FirstPartyUsage。	字符串
标记	与公共 IP 关联的 IP 标记的值。 示例：SQL。	字符串

Microsoft.Network/publicIPPrefixes

名字	描述	价值
apiVersion	API 版本	'2023-06-01'
extendedLocation	公共 IP 地址的扩展位置。	ExtendedLocation
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	公共 IP 前缀属性。	PublicIPPrefixPropertiesFormat
sku	公共 IP 前缀 SKU。	PublicIPPrefixSku
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.Network/publicIPPrefixes”
区	表示为资源分配的 IP 需要来自的可用性区域列表。	string[]

NatGateway

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	Nat 网关属性。	NatGatewayPropertiesFormat
sku	nat 网关 SKU。	NatGatewaySku
标签	资源标记。	ResourceTags
区	表示应在其中部署 Nat 网关的区域的可用性区域的列表。	string[]

NatGatewayPropertiesFormat

名字	描述	价值
idleTimeoutInMinutes	nat 网关的空闲超时。	int
publicIpAddresses	与 nat 网关资源关联的公共 IP 地址数组。	SubResource[]
publicIpPrefixes	与 nat 网关资源关联的公共 IP 前缀数组。	SubResource[]

NatGatewaySku

名字	描述	价值
名字	Nat 网关 SKU 的名称。	“Standard”

PublicIPPrefixPropertiesFormat

名字	描述	价值
customIPPrefix	此前缀与之关联的 customIpPrefix。	SubResource
ipTags	与公共 IP 前缀关联的标记列表。	IpTag[]
natGateway	公共 IP 前缀的 NatGateway。	NatGateway
prefixLength	公共 IP 前缀的长度。	int
publicIPAddressVersion	公共 IP 地址版本。	“IPv4” “IPv6”

PublicIPPrefixSku

名字	描述	价值
名字	公共 IP 前缀 SKU 的名称。	“Standard”
层	公共 IP 前缀 SKU 的层。	“Global” “区域”

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

SubResource

名字	描述	价值
id	资源 ID。	字符串

快速入门模板

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

模板	描述
使用 NAT 网关和应用程序网关 AKS 群集	此示例演示如何使用 NAT 网关部署 AKS 群集进行出站连接，以及如何为入站连接部署应用程序网关。
创建具有多个 IP 公共地址的 Azure 防火墙	此模板创建一个 Azure 防火墙，其中包含两个公共 IP 地址和两台要测试的 Windows Server 2019 服务器。
使用公共 IP 前缀 VMSS	用于部署具有公共 IP 前缀的 VMSS 的模板

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 publicIPPrefixes 资源类型：

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/publicIPPrefixes@2023-06-01"
  name = "string"
  extendedLocation = {
    name = "string"
    type = "string"
  }
  location = "string"
  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 = "string"
        }
        tags = {
          {customized property} = "string"
        }
        zones = [
          "string"
        ]
      }
      prefixLength = int
      publicIPAddressVersion = "string"
    }
  })
  sku = {
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
}

属性值

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	字符串
类型	扩展位置的类型。	“EdgeZone”

IpTag

名字	描述	价值
ipTagType	IP 标记类型。 示例：FirstPartyUsage。	字符串
标记	与公共 IP 关联的 IP 标记的值。 示例：SQL。	字符串

Microsoft.Network/publicIPPrefixes

名字	描述	价值
extendedLocation	公共 IP 地址的扩展位置。	ExtendedLocation
位置	资源位置。	字符串
名字	资源名称	string （必需）
性能	公共 IP 前缀属性。	PublicIPPrefixPropertiesFormat
sku	公共 IP 前缀 SKU。	PublicIPPrefixSku
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Network/publicIPPrefixes@2023-06-01”
区	表示为资源分配的 IP 需要来自的可用性区域列表。	string[]

NatGateway

名字	描述	价值
id	资源 ID。	字符串
位置	资源位置。	字符串
性能	Nat 网关属性。	NatGatewayPropertiesFormat
sku	nat 网关 SKU。	NatGatewaySku
标签	资源标记。	ResourceTags
区	表示应在其中部署 Nat 网关的区域的可用性区域的列表。	string[]

NatGatewayPropertiesFormat

名字	描述	价值
idleTimeoutInMinutes	nat 网关的空闲超时。	int
publicIpAddresses	与 nat 网关资源关联的公共 IP 地址数组。	SubResource[]
publicIpPrefixes	与 nat 网关资源关联的公共 IP 前缀数组。	SubResource[]

NatGatewaySku

名字	描述	价值
名字	Nat 网关 SKU 的名称。	“Standard”

PublicIPPrefixPropertiesFormat

名字	描述	价值
customIPPrefix	此前缀与之关联的 customIpPrefix。	SubResource
ipTags	与公共 IP 前缀关联的标记列表。	IpTag[]
natGateway	公共 IP 前缀的 NatGateway。	NatGateway
prefixLength	公共 IP 前缀的长度。	int
publicIPAddressVersion	公共 IP 地址版本。	“IPv4” “IPv6”

PublicIPPrefixSku

名字	描述	价值
名字	公共 IP 前缀 SKU 的名称。	“Standard”
层	公共 IP 前缀 SKU 的层。	“Global” “区域”

ResourceTags

名字	描述	价值

ResourceTags

名字	描述	价值

SubResource

名字	描述	价值
id	资源 ID。	字符串