Microsoft.網路連線 2015-06-15

• 最新
• 2024-05-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
• 2018-06-01
• 2018-04-01
• 2018-02-01
• 2018-01-01
• 2017-11-01
• 2017-10-01
• 2017-09-01
• 2017-08-01
• 2017-06-01
• 2017-03-30
• 2017-03-01
• 2016-12-01
• 2016-09-01
• 2016-06-01
• 2016-03-30
• 2015-06-15
• 2015-05-01-preview

Bicep 資源定義

您可以使用目標作業來部署連線資源類型：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/connections 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Network/connections@2015-06-15' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    authorizationKey: 'string'
    connectionStatus: 'string'
    connectionType: 'string'
    egressBytesTransferred: int
    enableBgp: bool
    ingressBytesTransferred: int
    localNetworkGateway2: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        gatewayIpAddress: 'string'
        localNetworkAddressSpace: {
          addressPrefixes: [
            'string'
          ]
        }
        provisioningState: 'string'
        resourceGuid: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
    peer: {
      id: 'string'
    }
    provisioningState: 'string'
    resourceGuid: 'string'
    routingWeight: int
    sharedKey: 'string'
    virtualNetworkGateway1: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        enableBgp: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              privateIPAddress: 'string'
              privateIPAllocationMethod: 'string'
              provisioningState: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        provisioningState: 'string'
        resourceGuid: 'string'
        sku: {
          capacity: int
          name: 'string'
          tier: 'string'
        }
        vpnClientConfiguration: {
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
          vpnClientRevokedCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                thumbprint: 'string'
              }
            }
          ]
          vpnClientRootCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                publicCertData: 'string'
              }
            }
          ]
        }
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
    virtualNetworkGateway2: {
      etag: 'string'
      id: 'string'
      location: 'string'
      properties: {
        bgpSettings: {
          asn: int
          bgpPeeringAddress: 'string'
          peerWeight: int
        }
        enableBgp: bool
        gatewayDefaultSite: {
          id: 'string'
        }
        gatewayType: 'string'
        ipConfigurations: [
          {
            etag: 'string'
            id: 'string'
            name: 'string'
            properties: {
              privateIPAddress: 'string'
              privateIPAllocationMethod: 'string'
              provisioningState: 'string'
              publicIPAddress: {
                id: 'string'
              }
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        provisioningState: 'string'
        resourceGuid: 'string'
        sku: {
          capacity: int
          name: 'string'
          tier: 'string'
        }
        vpnClientConfiguration: {
          vpnClientAddressPool: {
            addressPrefixes: [
              'string'
            ]
          }
          vpnClientRevokedCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                thumbprint: 'string'
              }
            }
          ]
          vpnClientRootCertificates: [
            {
              etag: 'string'
              id: 'string'
              name: 'string'
              properties: {
                provisioningState: 'string'
                publicCertData: 'string'
              }
            }
          ]
        }
        vpnType: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

AddressSpace

名字	描述	價值
addressPrefixes	以 CIDR 表示法保留給此虛擬網路的位址區塊清單。	string[]

BgpSettings

名字	描述	價值
asn	取得或設定此 BGP 喇叭的 ASN	int
bgpPeeringAddress	取得或設定這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼	字串
peerWeight	取得或設定新增至從這個 BGP 喇叭學習之路由的權數	int

LocalNetworkGateway

名字	描述	價值
etag	取得唯一的唯一	字串
id	資源標識碼。	字串
位置	資源位置。	字串
性能	LocalNetworkGateway 屬性	LocalNetworkGatewayPropertiesFormat
標籤	資源標籤。	ResourceTags

LocalNetworkGatewayPropertiesFormat

名字	描述	價值
bgpSettings	局域網路閘道的 BGP 喇叭設定。	BgpSettings
gatewayIpAddress	局域網路閘道的IP位址。	字串
localNetworkAddressSpace	局域網路網站位址空間。	AddressSpace
provisioningState	取得或設定 LocalNetworkGateway 資源的布建狀態更新/刪除/失敗	字串
resourceGuid	LocalNetworkGateway 資源的資源 GUID 屬性。	字串

Microsoft.Network/connections

名字	描述	價值
etag	取得唯一的唯一	字串
位置	資源位置。	字串
名字	資源名稱	字串 （必要）
性能	VirtualNetworkGatewayConnection 属性	VirtualNetworkGatewayConnectionPropertiesFormat
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤

ResourceTags

名字	描述	價值

ResourceTags

名字	描述	價值

ResourceTags

名字	描述	價值

SubResource

名字	描述	價值
id	資源標識碼。	字串

VirtualNetworkGateway

名字	描述	價值
etag	取得唯一的唯一	字串
id	資源標識碼。	字串
位置	資源位置。	字串
性能	VirtualNetworkGateway 属性	VirtualNetworkGatewayPropertiesFormat
標籤	資源標籤。	ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字	描述	價值
authorizationKey	authorizationKey。	字串
connectionStatus	虛擬網路網關聯機狀態。 可能的值為 'Unknown'、'Connected'、'Connected' 和 'NotConnected'。	'Connected' '聯機' 'NotConnected' 'Unknown'
connectionType	網關聯機類型。 可能的值為：『IPsec』、『Vnet2Vnet』、『ExpressRoute』和 『VPNClient。	'ExpressRoute' 'IPsec' 'Vnet2Vnet' 'VPNClient'
egressBytesTransferred	在此連線中傳輸的輸出位元組。	int
enableBgp	EnableBgp 旗標	bool
ingressBytesTransferred	在此連接中傳輸的輸入位元組。	int
localNetworkGateway2	一般資源資訊的通用類別	LocalNetworkGateway
同輩	對等互連資源的參考。	SubResource
provisioningState	VirtualNetworkGatewayConnection 資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
resourceGuid	VirtualNetworkGatewayConnection 資源的資源 GUID 屬性。	字串
routingWeight	路由權數。	int
sharedKey	IPSec 共用金鑰。	字串
virtualNetworkGateway1	一般資源資訊的通用類別	VirtualNetworkGateway
virtualNetworkGateway2	一般資源資訊的通用類別	VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

名字	描述	價值
etag	每當更新資源時變更的唯一隻讀字串。	字串
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	VirtualNetworkGatewayIPConfiguration 的屬性	VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字	描述	價值
privateIPAddress	取得或設定IP組態的 privateIPAddress	字串
privateIPAllocationMethod	私人IP配置方法。 可能的值為：'Static' 和 'Dynamic'。	'Dynamic' 'Static'
provisioningState	公用IP資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
publicIPAddress	公用IP資源的參考。	SubResource
子	子網資源的參考。	SubResource

VirtualNetworkGatewayPropertiesFormat

名字	描述	價值
bgpSettings	虛擬網路閘道的 BGP 喇叭設定。	BgpSettings
enableBgp	是否為此虛擬網路閘道啟用 BGP。	bool
gatewayDefaultSite	LocalNetworkGateway 資源的參考，代表具有預設路由的局域網路網站。 如果移除現有的默認網站設定，請指派 Null 值。	SubResource
gatewayType	此虛擬網路閘道的類型。 可能的值為：'Vpn' 和 'ExpressRoute'。	'ExpressRoute' 'Vpn'
ipConfigurations	虛擬網路閘道的IP組態。	VirtualNetworkGatewayIPConfiguration[]
provisioningState	VirtualNetworkGateway 資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
resourceGuid	VirtualNetworkGateway 資源的資源 GUID 屬性。	字串
sku	VirtualNetworkGatewaySku 資源的參考，代表為虛擬網路網關選取的 SKU。	VirtualNetworkGatewaySku
vpnClientConfiguration	代表 P2S VpnClient 組態的 VpnClientConfiguration 資源的參考。	VpnClientConfiguration
vpnType	此虛擬網路閘道的類型。 可能的值為：'PolicyBased' 和 'RouteBased'。	'PolicyBased' 'RouteBased'

VirtualNetworkGatewaySku

名字	描述	價值
能力	容量	int
名字	閘道 SKU 名稱 -Basic/HighPerformance/Standard	'Basic' 'HighPerformance' 'Standard'
層	網關 SKU 層 -Basic/HighPerformance/Standard	'Basic' 'HighPerformance' 'Standard'

VpnClientConfiguration

名字	描述	價值
vpnClientAddressPool	取得或設定位址空間資源的參考，代表 P2S VpnClient 的地址空間。	AddressSpace
vpnClientRevokedCertificates	虛擬網路閘道的 VpnClientRevokedCertificate。	VpnClientRevokedCertificate[]
vpnClientRootCertificates	虛擬網路閘道的 VpnClientRootCertificate。	VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字	描述	價值
etag	每當更新資源時變更的唯一隻讀字串。	字串
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	已撤銷之虛擬網路網關 VPN 用戶端憑證的屬性。	VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字	描述	價值
provisioningState	VPN 用戶端的布建狀態已撤銷憑證資源。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
指紋	撤銷的 VPN 用戶端憑證指紋。	字串

VpnClientRootCertificate

名字	描述	價值
etag	每當更新資源時變更的唯一隻讀字串。	字串
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	應用程式閘道的 SSL 憑證屬性	VpnClientRootCertificatePropertiesFormat

VpnClientRootCertificatePropertiesFormat

名字	描述	價值
provisioningState	VPN 用戶端跟證書資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
publicCertData	取得或設定憑證公用數據	字串

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
建立 BGP VNET 對 VNET 連線	此範本可讓您使用虛擬網路閘道和 BGP 連線兩個 VNET
使用 BGP 使用主動 VPN 閘道 站對站 VPN VPN	此範本可讓您在具有 VPN 閘道的兩個 VNet 之間部署站對站 VPN，以使用 BGP 設定主動-主動。 每個 Azure VPN 閘道都會解析遠端對等的 FQDN，以判斷遠端 VPN 閘道的公用 IP。 範本會在具有可用性區域的 Azure 區域中如預期般執行。

ARM 樣本資源定義

您可以使用目標作業來部署連線資源類型：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/connections 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Network/connections",
  "apiVersion": "2015-06-15",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "authorizationKey": "string",
    "connectionStatus": "string",
    "connectionType": "string",
    "egressBytesTransferred": "int",
    "enableBgp": "bool",
    "ingressBytesTransferred": "int",
    "localNetworkGateway2": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "gatewayIpAddress": "string",
        "localNetworkAddressSpace": {
          "addressPrefixes": [ "string" ]
        },
        "provisioningState": "string",
        "resourceGuid": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "peer": {
      "id": "string"
    },
    "provisioningState": "string",
    "resourceGuid": "string",
    "routingWeight": "int",
    "sharedKey": "string",
    "virtualNetworkGateway1": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "enableBgp": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAddress": "string",
              "privateIPAllocationMethod": "string",
              "provisioningState": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "provisioningState": "string",
        "resourceGuid": "string",
        "sku": {
          "capacity": "int",
          "name": "string",
          "tier": "string"
        },
        "vpnClientConfiguration": {
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          },
          "vpnClientRevokedCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "thumbprint": "string"
              }
            }
          ],
          "vpnClientRootCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "publicCertData": "string"
              }
            }
          ]
        },
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    },
    "virtualNetworkGateway2": {
      "etag": "string",
      "id": "string",
      "location": "string",
      "properties": {
        "bgpSettings": {
          "asn": "int",
          "bgpPeeringAddress": "string",
          "peerWeight": "int"
        },
        "enableBgp": "bool",
        "gatewayDefaultSite": {
          "id": "string"
        },
        "gatewayType": "string",
        "ipConfigurations": [
          {
            "etag": "string",
            "id": "string",
            "name": "string",
            "properties": {
              "privateIPAddress": "string",
              "privateIPAllocationMethod": "string",
              "provisioningState": "string",
              "publicIPAddress": {
                "id": "string"
              },
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "provisioningState": "string",
        "resourceGuid": "string",
        "sku": {
          "capacity": "int",
          "name": "string",
          "tier": "string"
        },
        "vpnClientConfiguration": {
          "vpnClientAddressPool": {
            "addressPrefixes": [ "string" ]
          },
          "vpnClientRevokedCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "thumbprint": "string"
              }
            }
          ],
          "vpnClientRootCertificates": [
            {
              "etag": "string",
              "id": "string",
              "name": "string",
              "properties": {
                "provisioningState": "string",
                "publicCertData": "string"
              }
            }
          ]
        },
        "vpnType": "string"
      },
      "tags": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

AddressSpace

名字	描述	價值
addressPrefixes	以 CIDR 表示法保留給此虛擬網路的位址區塊清單。	string[]

BgpSettings

名字	描述	價值
asn	取得或設定此 BGP 喇叭的 ASN	int
bgpPeeringAddress	取得或設定這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼	字串
peerWeight	取得或設定新增至從這個 BGP 喇叭學習之路由的權數	int

LocalNetworkGateway

名字	描述	價值
etag	取得唯一的唯一	字串
id	資源標識碼。	字串
位置	資源位置。	字串
性能	LocalNetworkGateway 屬性	LocalNetworkGatewayPropertiesFormat
標籤	資源標籤。	ResourceTags

LocalNetworkGatewayPropertiesFormat

名字	描述	價值
bgpSettings	局域網路閘道的 BGP 喇叭設定。	BgpSettings
gatewayIpAddress	局域網路閘道的IP位址。	字串
localNetworkAddressSpace	局域網路網站位址空間。	AddressSpace
provisioningState	取得或設定 LocalNetworkGateway 資源的布建狀態更新/刪除/失敗	字串
resourceGuid	LocalNetworkGateway 資源的資源 GUID 屬性。	字串

Microsoft.Network/connections

名字	描述	價值
apiVersion	API 版本	'2015-06-15'
etag	取得唯一的唯一	字串
位置	資源位置。	字串
名字	資源名稱	字串 （必要）
性能	VirtualNetworkGatewayConnection 属性	VirtualNetworkGatewayConnectionPropertiesFormat
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤
類型	資源類型	'Microsoft.Network/connections'

ResourceTags

名字	描述	價值

ResourceTags

名字	描述	價值

ResourceTags

名字	描述	價值

SubResource

名字	描述	價值
id	資源標識碼。	字串

VirtualNetworkGateway

名字	描述	價值
etag	取得唯一的唯一	字串
id	資源標識碼。	字串
位置	資源位置。	字串
性能	VirtualNetworkGateway 属性	VirtualNetworkGatewayPropertiesFormat
標籤	資源標籤。	ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字	描述	價值
authorizationKey	authorizationKey。	字串
connectionStatus	虛擬網路網關聯機狀態。 可能的值為 'Unknown'、'Connected'、'Connected' 和 'NotConnected'。	'Connected' '聯機' 'NotConnected' 'Unknown'
connectionType	網關聯機類型。 可能的值為：『IPsec』、『Vnet2Vnet』、『ExpressRoute』和 『VPNClient。	'ExpressRoute' 'IPsec' 'Vnet2Vnet' 'VPNClient'
egressBytesTransferred	在此連線中傳輸的輸出位元組。	int
enableBgp	EnableBgp 旗標	bool
ingressBytesTransferred	在此連接中傳輸的輸入位元組。	int
localNetworkGateway2	一般資源資訊的通用類別	LocalNetworkGateway
同輩	對等互連資源的參考。	SubResource
provisioningState	VirtualNetworkGatewayConnection 資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
resourceGuid	VirtualNetworkGatewayConnection 資源的資源 GUID 屬性。	字串
routingWeight	路由權數。	int
sharedKey	IPSec 共用金鑰。	字串
virtualNetworkGateway1	一般資源資訊的通用類別	VirtualNetworkGateway
virtualNetworkGateway2	一般資源資訊的通用類別	VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

名字	描述	價值
etag	每當更新資源時變更的唯一隻讀字串。	字串
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	VirtualNetworkGatewayIPConfiguration 的屬性	VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字	描述	價值
privateIPAddress	取得或設定IP組態的 privateIPAddress	字串
privateIPAllocationMethod	私人IP配置方法。 可能的值為：'Static' 和 'Dynamic'。	'Dynamic' 'Static'
provisioningState	公用IP資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
publicIPAddress	公用IP資源的參考。	SubResource
子	子網資源的參考。	SubResource

VirtualNetworkGatewayPropertiesFormat

名字	描述	價值
bgpSettings	虛擬網路閘道的 BGP 喇叭設定。	BgpSettings
enableBgp	是否為此虛擬網路閘道啟用 BGP。	bool
gatewayDefaultSite	LocalNetworkGateway 資源的參考，代表具有預設路由的局域網路網站。 如果移除現有的默認網站設定，請指派 Null 值。	SubResource
gatewayType	此虛擬網路閘道的類型。 可能的值為：'Vpn' 和 'ExpressRoute'。	'ExpressRoute' 'Vpn'
ipConfigurations	虛擬網路閘道的IP組態。	VirtualNetworkGatewayIPConfiguration[]
provisioningState	VirtualNetworkGateway 資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
resourceGuid	VirtualNetworkGateway 資源的資源 GUID 屬性。	字串
sku	VirtualNetworkGatewaySku 資源的參考，代表為虛擬網路網關選取的 SKU。	VirtualNetworkGatewaySku
vpnClientConfiguration	代表 P2S VpnClient 組態的 VpnClientConfiguration 資源的參考。	VpnClientConfiguration
vpnType	此虛擬網路閘道的類型。 可能的值為：'PolicyBased' 和 'RouteBased'。	'PolicyBased' 'RouteBased'

VirtualNetworkGatewaySku

名字	描述	價值
能力	容量	int
名字	閘道 SKU 名稱 -Basic/HighPerformance/Standard	'Basic' 'HighPerformance' 'Standard'
層	網關 SKU 層 -Basic/HighPerformance/Standard	'Basic' 'HighPerformance' 'Standard'

VpnClientConfiguration

名字	描述	價值
vpnClientAddressPool	取得或設定位址空間資源的參考，代表 P2S VpnClient 的地址空間。	AddressSpace
vpnClientRevokedCertificates	虛擬網路閘道的 VpnClientRevokedCertificate。	VpnClientRevokedCertificate[]
vpnClientRootCertificates	虛擬網路閘道的 VpnClientRootCertificate。	VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字	描述	價值
etag	每當更新資源時變更的唯一隻讀字串。	字串
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	已撤銷之虛擬網路網關 VPN 用戶端憑證的屬性。	VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字	描述	價值
provisioningState	VPN 用戶端的布建狀態已撤銷憑證資源。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
指紋	撤銷的 VPN 用戶端憑證指紋。	字串

VpnClientRootCertificate

名字	描述	價值
etag	每當更新資源時變更的唯一隻讀字串。	字串
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	應用程式閘道的 SSL 憑證屬性	VpnClientRootCertificatePropertiesFormat

VpnClientRootCertificatePropertiesFormat

名字	描述	價值
provisioningState	VPN 用戶端跟證書資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
publicCertData	取得或設定憑證公用數據	字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
BOSH CF 跨區域	此範本可協助您設定在 Azure 上兩個區域部署 BOSH 和 Cloud Foundry 所需的資源。
將 ExpressRoute 線路連線至 VNET	此範本會建立 VNET、ExpresRoute 閘道，以及已設定 AzurePrivatePeering 的已佈建和已啟用 ExpressRoute 線路的連線。
建立 BGP VNET 對 VNET 連線	此範本可讓您使用虛擬網路閘道和 BGP 連線兩個 VNET
建立站對站 VPN 連線	此範本可讓您使用虛擬網路閘道建立站對站 VPN 連線
使用 VM 建立站對站 VPN 連線	此範本可讓您使用虛擬網路閘道建立站對站 VPN 連線
跨兩個區域建立 VNET 對 VNET 連線	此範本可讓您使用虛擬網路閘道連接不同區域中的兩個 VNET
建立三個 vNet 來示範可轉移的 BGP 連線	此範本會部署三個使用虛擬網路閘道和已啟用 BGP 連線的 vNet
部署 HBase 異地復寫	此範本可讓您使用 VPN vnet 對 vnet 連線，在兩個不同的區域中設定 HBase 複寫的 Azure 環境。
將現有的 Azure VNET 擴充至多 VNET 組態	此範本可讓您使用 VNET 對 VNET 閘道，將現有的單一 VNET 環境延伸至跨兩個資料中心區域延伸的多 VNET 環境
使用 BGP 使用主動 VPN 閘道 站對站 VPN VPN	此範本可讓您在具有 VPN 閘道的兩個 VNet 之間部署站對站 VPN，以使用 BGP 設定主動-主動。 每個 Azure VPN 閘道都會解析遠端對等的 FQDN，以判斷遠端 VPN 閘道的公用 IP。 範本會在具有可用性區域的 Azure 區域中如預期般執行。
VPN 自訂 IPSec 原則	此自定義IPSec原則允許更細微的IKE參數設定。 這可讓您部署站對站 VPN 原則，以支援 VPN Endpoit 裝置上的特定設定。

Terraform （AzAPI 提供者） 資源定義

您可以使用目標作業來部署連線資源類型：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Network/connections 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/connections@2015-06-15"
  name = "string"
  etag = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authorizationKey = "string"
      connectionStatus = "string"
      connectionType = "string"
      egressBytesTransferred = int
      enableBgp = bool
      ingressBytesTransferred = int
      localNetworkGateway2 = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          gatewayIpAddress = "string"
          localNetworkAddressSpace = {
            addressPrefixes = [
              "string"
            ]
          }
          provisioningState = "string"
          resourceGuid = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
      peer = {
        id = "string"
      }
      provisioningState = "string"
      resourceGuid = "string"
      routingWeight = int
      sharedKey = "string"
      virtualNetworkGateway1 = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          enableBgp = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                privateIPAddress = "string"
                privateIPAllocationMethod = "string"
                provisioningState = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          provisioningState = "string"
          resourceGuid = "string"
          sku = {
            capacity = int
            name = "string"
            tier = "string"
          }
          vpnClientConfiguration = {
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
            vpnClientRevokedCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  thumbprint = "string"
                }
              }
            ]
            vpnClientRootCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  publicCertData = "string"
                }
              }
            ]
          }
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
      virtualNetworkGateway2 = {
        etag = "string"
        id = "string"
        location = "string"
        properties = {
          bgpSettings = {
            asn = int
            bgpPeeringAddress = "string"
            peerWeight = int
          }
          enableBgp = bool
          gatewayDefaultSite = {
            id = "string"
          }
          gatewayType = "string"
          ipConfigurations = [
            {
              etag = "string"
              id = "string"
              name = "string"
              properties = {
                privateIPAddress = "string"
                privateIPAllocationMethod = "string"
                provisioningState = "string"
                publicIPAddress = {
                  id = "string"
                }
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          provisioningState = "string"
          resourceGuid = "string"
          sku = {
            capacity = int
            name = "string"
            tier = "string"
          }
          vpnClientConfiguration = {
            vpnClientAddressPool = {
              addressPrefixes = [
                "string"
              ]
            }
            vpnClientRevokedCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  thumbprint = "string"
                }
              }
            ]
            vpnClientRootCertificates = [
              {
                etag = "string"
                id = "string"
                name = "string"
                properties = {
                  provisioningState = "string"
                  publicCertData = "string"
                }
              }
            ]
          }
          vpnType = "string"
        }
        tags = {
          {customized property} = "string"
        }
      }
    }
  })
}

屬性值

AddressSpace

名字	描述	價值
addressPrefixes	以 CIDR 表示法保留給此虛擬網路的位址區塊清單。	string[]

BgpSettings

名字	描述	價值
asn	取得或設定此 BGP 喇叭的 ASN	int
bgpPeeringAddress	取得或設定這個 BGP 說話者的 BGP 對等互連位址和 BGP 識別碼	字串
peerWeight	取得或設定新增至從這個 BGP 喇叭學習之路由的權數	int

LocalNetworkGateway

名字	描述	價值
etag	取得唯一的唯一	字串
id	資源標識碼。	字串
位置	資源位置。	字串
性能	LocalNetworkGateway 屬性	LocalNetworkGatewayPropertiesFormat
標籤	資源標籤。	ResourceTags

LocalNetworkGatewayPropertiesFormat

名字	描述	價值
bgpSettings	局域網路閘道的 BGP 喇叭設定。	BgpSettings
gatewayIpAddress	局域網路閘道的IP位址。	字串
localNetworkAddressSpace	局域網路網站位址空間。	AddressSpace
provisioningState	取得或設定 LocalNetworkGateway 資源的布建狀態更新/刪除/失敗	字串
resourceGuid	LocalNetworkGateway 資源的資源 GUID 屬性。	字串

Microsoft.Network/connections

名字	描述	價值
etag	取得唯一的唯一	字串
位置	資源位置。	字串
名字	資源名稱	字串 （必要）
性能	VirtualNetworkGatewayConnection 属性	VirtualNetworkGatewayConnectionPropertiesFormat
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.Network/connections@2015-06-15”

ResourceTags

名字	描述	價值

ResourceTags

名字	描述	價值

ResourceTags

名字	描述	價值

SubResource

名字	描述	價值
id	資源標識碼。	字串

VirtualNetworkGateway

名字	描述	價值
etag	取得唯一的唯一	字串
id	資源標識碼。	字串
位置	資源位置。	字串
性能	VirtualNetworkGateway 属性	VirtualNetworkGatewayPropertiesFormat
標籤	資源標籤。	ResourceTags

VirtualNetworkGatewayConnectionPropertiesFormat

名字	描述	價值
authorizationKey	authorizationKey。	字串
connectionStatus	虛擬網路網關聯機狀態。 可能的值為 'Unknown'、'Connected'、'Connected' 和 'NotConnected'。	'Connected' '聯機' 'NotConnected' 'Unknown'
connectionType	網關聯機類型。 可能的值為：『IPsec』、『Vnet2Vnet』、『ExpressRoute』和 『VPNClient。	'ExpressRoute' 'IPsec' 'Vnet2Vnet' 'VPNClient'
egressBytesTransferred	在此連線中傳輸的輸出位元組。	int
enableBgp	EnableBgp 旗標	bool
ingressBytesTransferred	在此連接中傳輸的輸入位元組。	int
localNetworkGateway2	一般資源資訊的通用類別	LocalNetworkGateway
同輩	對等互連資源的參考。	SubResource
provisioningState	VirtualNetworkGatewayConnection 資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
resourceGuid	VirtualNetworkGatewayConnection 資源的資源 GUID 屬性。	字串
routingWeight	路由權數。	int
sharedKey	IPSec 共用金鑰。	字串
virtualNetworkGateway1	一般資源資訊的通用類別	VirtualNetworkGateway
virtualNetworkGateway2	一般資源資訊的通用類別	VirtualNetworkGateway

VirtualNetworkGatewayIPConfiguration

名字	描述	價值
etag	每當更新資源時變更的唯一隻讀字串。	字串
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	VirtualNetworkGatewayIPConfiguration 的屬性	VirtualNetworkGatewayIPConfigurationPropertiesFormat

VirtualNetworkGatewayIPConfigurationPropertiesFormat

名字	描述	價值
privateIPAddress	取得或設定IP組態的 privateIPAddress	字串
privateIPAllocationMethod	私人IP配置方法。 可能的值為：'Static' 和 'Dynamic'。	'Dynamic' 'Static'
provisioningState	公用IP資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
publicIPAddress	公用IP資源的參考。	SubResource
子	子網資源的參考。	SubResource

VirtualNetworkGatewayPropertiesFormat

名字	描述	價值
bgpSettings	虛擬網路閘道的 BGP 喇叭設定。	BgpSettings
enableBgp	是否為此虛擬網路閘道啟用 BGP。	bool
gatewayDefaultSite	LocalNetworkGateway 資源的參考，代表具有預設路由的局域網路網站。 如果移除現有的默認網站設定，請指派 Null 值。	SubResource
gatewayType	此虛擬網路閘道的類型。 可能的值為：'Vpn' 和 'ExpressRoute'。	'ExpressRoute' 'Vpn'
ipConfigurations	虛擬網路閘道的IP組態。	VirtualNetworkGatewayIPConfiguration[]
provisioningState	VirtualNetworkGateway 資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
resourceGuid	VirtualNetworkGateway 資源的資源 GUID 屬性。	字串
sku	VirtualNetworkGatewaySku 資源的參考，代表為虛擬網路網關選取的 SKU。	VirtualNetworkGatewaySku
vpnClientConfiguration	代表 P2S VpnClient 組態的 VpnClientConfiguration 資源的參考。	VpnClientConfiguration
vpnType	此虛擬網路閘道的類型。 可能的值為：'PolicyBased' 和 'RouteBased'。	'PolicyBased' 'RouteBased'

VirtualNetworkGatewaySku

名字	描述	價值
能力	容量	int
名字	閘道 SKU 名稱 -Basic/HighPerformance/Standard	'Basic' 'HighPerformance' 'Standard'
層	網關 SKU 層 -Basic/HighPerformance/Standard	'Basic' 'HighPerformance' 'Standard'

VpnClientConfiguration

名字	描述	價值
vpnClientAddressPool	取得或設定位址空間資源的參考，代表 P2S VpnClient 的地址空間。	AddressSpace
vpnClientRevokedCertificates	虛擬網路閘道的 VpnClientRevokedCertificate。	VpnClientRevokedCertificate[]
vpnClientRootCertificates	虛擬網路閘道的 VpnClientRootCertificate。	VpnClientRootCertificate[]

VpnClientRevokedCertificate

名字	描述	價值
etag	每當更新資源時變更的唯一隻讀字串。	字串
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	已撤銷之虛擬網路網關 VPN 用戶端憑證的屬性。	VpnClientRevokedCertificatePropertiesFormat

VpnClientRevokedCertificatePropertiesFormat

名字	描述	價值
provisioningState	VPN 用戶端的布建狀態已撤銷憑證資源。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
指紋	撤銷的 VPN 用戶端憑證指紋。	字串

VpnClientRootCertificate

名字	描述	價值
etag	每當更新資源時變更的唯一隻讀字串。	字串
id	資源標識碼。	字串
名字	資源群組內唯一的資源名稱。 此名稱可用來存取資源。	字串
性能	應用程式閘道的 SSL 憑證屬性	VpnClientRootCertificatePropertiesFormat

VpnClientRootCertificatePropertiesFormat

名字	描述	價值
provisioningState	VPN 用戶端跟證書資源的布建狀態。 可能的值為：『Updateing』、『刪除』和『Failed』。	字串
publicCertData	取得或設定憑證公用數據	字串