你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Network expressRouteCircuits 2015-05-01-preview
- 最新
- 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 资源定义
可以使用目标操作部署 expressRouteCircuits 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/expressRouteCircuits 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Network/expressRouteCircuits@2015-05-01-preview' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
authorizations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
authorizationKey: 'string'
authorizationUseStatus: 'string'
provisioningState: 'string'
}
}
]
circuitProvisioningState: 'string'
peerings: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
azureASN: int
microsoftPeeringConfig: {
advertisedPublicPrefixes: [
'string'
]
advertisedPublicPrefixesState: 'string'
customerASN: int
routingRegistryName: 'string'
}
peerASN: int
peeringType: 'string'
primaryAzurePort: 'string'
primaryPeerAddressPrefix: 'string'
provisioningState: 'string'
secondaryAzurePort: 'string'
secondaryPeerAddressPrefix: 'string'
sharedKey: 'string'
state: 'string'
stats: {
bytesIn: int
bytesOut: int
}
vlanId: int
}
}
]
provisioningState: 'string'
serviceKey: 'string'
serviceProviderNotes: 'string'
serviceProviderProperties: {
bandwidthInMbps: int
peeringLocation: 'string'
serviceProviderName: 'string'
}
serviceProviderProvisioningState: 'string'
}
sku: {
family: 'string'
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
属性值
AuthorizationPropertiesFormat
| 名字 | 描述 | 价值 |
|---|---|---|
| authorizationKey | 获取或设置授权密钥 | 字符串 |
| authorizationUseStatus | 获取或设置 AuthorizationUseStatus | “Available” “InUse” |
| provisioningState | 获取或设置 PublicIP 资源更新/删除/失败的预配状态 | 字符串 |
ExpressRouteCircuitAuthorization
| 名字 | 描述 | 价值 |
|---|---|---|
| etag | 每当更新资源时更改的唯一只读字符串 | 字符串 |
| id | 资源 ID | 字符串 |
| 名字 | 获取资源组中唯一的资源的名称。 此名称可用于访问资源 | 字符串 |
| 性能 | AuthorizationPropertiesFormat |
ExpressRouteCircuitPeering
| 名字 | 描述 | 价值 |
|---|---|---|
| etag | 每当更新资源时更改的唯一只读字符串 | 字符串 |
| id | 资源 ID | 字符串 |
| 名字 | 获取资源组中唯一的资源的名称。 此名称可用于访问资源 | 字符串 |
| 性能 | ExpressRouteCircuitPeeringPropertiesFormat |
ExpressRouteCircuitPeeringConfig
| 名字 | 描述 | 价值 |
|---|---|---|
| advertisedPublicPrefixes | 获取或设置 AdvertisedPublicPrefixes 的引用 | string[] |
| advertisedPublicPrefixesState | 获取或设置对等互连资源的 AdvertisedPublicPrefixState | “已配置” “配置” “NotConfigured” “ValidationNeeded” |
| customerASN | 获取或设置对等互连的 CustomerAsn。 | int |
| routingRegistryName | 获取或设置配置的 RoutingRegistryName。 | 字符串 |
ExpressRouteCircuitPeeringPropertiesFormat
| 名字 | 描述 | 价值 |
|---|---|---|
| azureASN | 获取或设置 Azure ASN | int |
| microsoftPeeringConfig | 获取或设置Microsoft对等互连配置 | ExpressRouteCircuitPeeringConfig |
| peerASN | 获取或设置对等 ASN | int |
| peeringType | 获取或设置 PeeringType | “AzurePrivatePeering” “AzurePublicPeering” “MicrosoftPeering” |
| primaryAzurePort | 获取或设置主端口 | 字符串 |
| primaryPeerAddressPrefix | 获取或设置主地址前缀 | 字符串 |
| provisioningState | 获取或设置 PublicIP 资源更新/删除/失败的预配状态 | 字符串 |
| secondaryAzurePort | 获取或设置辅助端口 | 字符串 |
| secondaryPeerAddressPrefix | 获取或设置辅助地址前缀 | 字符串 |
| sharedKey | 获取或设置共享密钥 | 字符串 |
| 州 | 获取或设置对等互连的状态 | “Disabled” “Enabled” |
| 统计 | 获取或对等互连统计信息 | ExpressRouteCircuitStats |
| vlanId | 获取或设置 vlan ID | int |
ExpressRouteCircuitPropertiesFormat
| 名字 | 描述 | 价值 |
|---|---|---|
| 授权 | 获取或设置授权列表 | ExpressRouteCircuitAuthorization[] |
| circuitProvisioningState | 获取或设置资源的 CircuitProvisioningState 状态 | 字符串 |
| 对等互连 | 获取或设置对等互连的列表 | ExpressRouteCircuitPeering[] |
| provisioningState | 获取或设置 PublicIP 资源更新/删除/失败的预配状态 | 字符串 |
| serviceKey | 获取或设置 ServiceKey | 字符串 |
| serviceProviderNotes | 获取或设置 ServiceProviderNotes | 字符串 |
| serviceProviderProperties | 获取或设置 ServiceProviderProperties | ExpressRouteCircuitServiceProviderProperties |
| serviceProviderProvisioningState | 获取或设置资源的 ServiceProviderProvisioningState 状态 | “取消预配” “NotProvisioned” “Provisioned” “预配” |
ExpressRouteCircuitServiceProviderProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| bandwidthInMbps | 获取或设置 BandwidthInMbps。 | int |
| peeringLocation | 获取或设置对等互连位置。 | 字符串 |
| serviceProviderName | 获取或设置 serviceProviderName。 | 字符串 |
ExpressRouteCircuitSku
| 名字 | 描述 | 价值 |
|---|---|---|
| 家庭 | 获取或设置 SKU 的系列。 | “MeteredData” “UnlimitedData” |
| 名字 | 获取或设置 SKU 的名称。 | 字符串 |
| 层 | 获取或设置 SKU 的层。 | “Premium” “Standard” |
ExpressRouteCircuitStats
| 名字 | 描述 | 价值 |
|---|---|---|
| bytesIn | 获取对等互连的 BytesIn。 | int |
| bytesOut | 获取对等互连的 BytesOut。 | int |
Microsoft.Network/expressRouteCircuits
| 名字 | 描述 | 价值 |
|---|---|---|
| etag | 获取在更新资源时更改的唯一只读字符串 | 字符串 |
| 位置 | 资源位置 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | ExpressRouteCircuit 的属性 | ExpressRouteCircuitPropertiesFormat |
| sku | 获取或设置 sku | ExpressRouteCircuitSku |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
快速入门示例
以下快速入门示例部署此资源类型。
| Bicep 文件 | 描述 |
|---|---|
| 创建 ExpressRoute 线路 | 此模板为指定的服务提供商和 SKU 创建 ExpressRoute 线路 |
| 使用专用对等互连和 Azure VNet |
此模板配置 ExpressRoute Microsoft对等互连，部署包含 Expressroute 网关的 Azure VNet，并将 VNet 链接到 ExpressRoute 线路 |
ARM 模板资源定义
可以使用目标操作部署 expressRouteCircuits 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/expressRouteCircuits 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Network/expressRouteCircuits",
"apiVersion": "2015-05-01-preview",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"authorizations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"authorizationKey": "string",
"authorizationUseStatus": "string",
"provisioningState": "string"
}
}
],
"circuitProvisioningState": "string",
"peerings": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"azureASN": "int",
"microsoftPeeringConfig": {
"advertisedPublicPrefixes": [ "string" ],
"advertisedPublicPrefixesState": "string",
"customerASN": "int",
"routingRegistryName": "string"
},
"peerASN": "int",
"peeringType": "string",
"primaryAzurePort": "string",
"primaryPeerAddressPrefix": "string",
"provisioningState": "string",
"secondaryAzurePort": "string",
"secondaryPeerAddressPrefix": "string",
"sharedKey": "string",
"state": "string",
"stats": {
"bytesIn": "int",
"bytesOut": "int"
},
"vlanId": "int"
}
}
],
"provisioningState": "string",
"serviceKey": "string",
"serviceProviderNotes": "string",
"serviceProviderProperties": {
"bandwidthInMbps": "int",
"peeringLocation": "string",
"serviceProviderName": "string"
},
"serviceProviderProvisioningState": "string"
},
"sku": {
"family": "string",
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
属性值
AuthorizationPropertiesFormat
| 名字 | 描述 | 价值 |
|---|---|---|
| authorizationKey | 获取或设置授权密钥 | 字符串 |
| authorizationUseStatus | 获取或设置 AuthorizationUseStatus | “Available” “InUse” |
| provisioningState | 获取或设置 PublicIP 资源更新/删除/失败的预配状态 | 字符串 |
ExpressRouteCircuitAuthorization
| 名字 | 描述 | 价值 |
|---|---|---|
| etag | 每当更新资源时更改的唯一只读字符串 | 字符串 |
| id | 资源 ID | 字符串 |
| 名字 | 获取资源组中唯一的资源的名称。 此名称可用于访问资源 | 字符串 |
| 性能 | AuthorizationPropertiesFormat |
ExpressRouteCircuitPeering
| 名字 | 描述 | 价值 |
|---|---|---|
| etag | 每当更新资源时更改的唯一只读字符串 | 字符串 |
| id | 资源 ID | 字符串 |
| 名字 | 获取资源组中唯一的资源的名称。 此名称可用于访问资源 | 字符串 |
| 性能 | ExpressRouteCircuitPeeringPropertiesFormat |
ExpressRouteCircuitPeeringConfig
| 名字 | 描述 | 价值 |
|---|---|---|
| advertisedPublicPrefixes | 获取或设置 AdvertisedPublicPrefixes 的引用 | string[] |
| advertisedPublicPrefixesState | 获取或设置对等互连资源的 AdvertisedPublicPrefixState | “已配置” “配置” “NotConfigured” “ValidationNeeded” |
| customerASN | 获取或设置对等互连的 CustomerAsn。 | int |
| routingRegistryName | 获取或设置配置的 RoutingRegistryName。 | 字符串 |
ExpressRouteCircuitPeeringPropertiesFormat
| 名字 | 描述 | 价值 |
|---|---|---|
| azureASN | 获取或设置 Azure ASN | int |
| microsoftPeeringConfig | 获取或设置Microsoft对等互连配置 | ExpressRouteCircuitPeeringConfig |
| peerASN | 获取或设置对等 ASN | int |
| peeringType | 获取或设置 PeeringType | “AzurePrivatePeering” “AzurePublicPeering” “MicrosoftPeering” |
| primaryAzurePort | 获取或设置主端口 | 字符串 |
| primaryPeerAddressPrefix | 获取或设置主地址前缀 | 字符串 |
| provisioningState | 获取或设置 PublicIP 资源更新/删除/失败的预配状态 | 字符串 |
| secondaryAzurePort | 获取或设置辅助端口 | 字符串 |
| secondaryPeerAddressPrefix | 获取或设置辅助地址前缀 | 字符串 |
| sharedKey | 获取或设置共享密钥 | 字符串 |
| 州 | 获取或设置对等互连的状态 | “Disabled” “Enabled” |
| 统计 | 获取或对等互连统计信息 | ExpressRouteCircuitStats |
| vlanId | 获取或设置 vlan ID | int |
ExpressRouteCircuitPropertiesFormat
| 名字 | 描述 | 价值 |
|---|---|---|
| 授权 | 获取或设置授权列表 | ExpressRouteCircuitAuthorization[] |
| circuitProvisioningState | 获取或设置资源的 CircuitProvisioningState 状态 | 字符串 |
| 对等互连 | 获取或设置对等互连的列表 | ExpressRouteCircuitPeering[] |
| provisioningState | 获取或设置 PublicIP 资源更新/删除/失败的预配状态 | 字符串 |
| serviceKey | 获取或设置 ServiceKey | 字符串 |
| serviceProviderNotes | 获取或设置 ServiceProviderNotes | 字符串 |
| serviceProviderProperties | 获取或设置 ServiceProviderProperties | ExpressRouteCircuitServiceProviderProperties |
| serviceProviderProvisioningState | 获取或设置资源的 ServiceProviderProvisioningState 状态 | “取消预配” “NotProvisioned” “Provisioned” “预配” |
ExpressRouteCircuitServiceProviderProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| bandwidthInMbps | 获取或设置 BandwidthInMbps。 | int |
| peeringLocation | 获取或设置对等互连位置。 | 字符串 |
| serviceProviderName | 获取或设置 serviceProviderName。 | 字符串 |
ExpressRouteCircuitSku
| 名字 | 描述 | 价值 |
|---|---|---|
| 家庭 | 获取或设置 SKU 的系列。 | “MeteredData” “UnlimitedData” |
| 名字 | 获取或设置 SKU 的名称。 | 字符串 |
| 层 | 获取或设置 SKU 的层。 | “Premium” “Standard” |
ExpressRouteCircuitStats
| 名字 | 描述 | 价值 |
|---|---|---|
| bytesIn | 获取对等互连的 BytesIn。 | int |
| bytesOut | 获取对等互连的 BytesOut。 | int |
Microsoft.Network/expressRouteCircuits
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2015-05-01-preview' |
| etag | 获取在更新资源时更改的唯一只读字符串 | 字符串 |
| 位置 | 资源位置 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | ExpressRouteCircuit 的属性 | ExpressRouteCircuitPropertiesFormat |
| sku | 获取或设置 sku | ExpressRouteCircuitSku |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.Network/expressRouteCircuits” |
ResourceTags
| 名字 | 描述 | 价值 |
|---|
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
创建 ExpressRoute 线路
|
此模板为指定的服务提供商和 SKU 创建 ExpressRoute 线路 |
|
使用 BGP 对等互连创建 ExpressRoute 线路
|
此模板为指定的服务提供商和 SKU 创建 ExpressRoute 线路和 AzurePrublicPeering BGP 对等互连 |
| 使用专用对等互连和 Azure VNet
|
此模板配置 ExpressRoute Microsoft对等互连，部署包含 Expressroute 网关的 Azure VNet，并将 VNet 链接到 ExpressRoute 线路 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署 expressRouteCircuits 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Network/expressRouteCircuits 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/expressRouteCircuits@2015-05-01-preview"
name = "string"
etag = "string"
location = "string"
sku = {
family = "string"
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
authorizations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
authorizationKey = "string"
authorizationUseStatus = "string"
provisioningState = "string"
}
}
]
circuitProvisioningState = "string"
peerings = [
{
etag = "string"
id = "string"
name = "string"
properties = {
azureASN = int
microsoftPeeringConfig = {
advertisedPublicPrefixes = [
"string"
]
advertisedPublicPrefixesState = "string"
customerASN = int
routingRegistryName = "string"
}
peerASN = int
peeringType = "string"
primaryAzurePort = "string"
primaryPeerAddressPrefix = "string"
provisioningState = "string"
secondaryAzurePort = "string"
secondaryPeerAddressPrefix = "string"
sharedKey = "string"
state = "string"
stats = {
bytesIn = int
bytesOut = int
}
vlanId = int
}
}
]
provisioningState = "string"
serviceKey = "string"
serviceProviderNotes = "string"
serviceProviderProperties = {
bandwidthInMbps = int
peeringLocation = "string"
serviceProviderName = "string"
}
serviceProviderProvisioningState = "string"
}
})
}
属性值
AuthorizationPropertiesFormat
| 名字 | 描述 | 价值 |
|---|---|---|
| authorizationKey | 获取或设置授权密钥 | 字符串 |
| authorizationUseStatus | 获取或设置 AuthorizationUseStatus | “Available” “InUse” |
| provisioningState | 获取或设置 PublicIP 资源更新/删除/失败的预配状态 | 字符串 |
ExpressRouteCircuitAuthorization
| 名字 | 描述 | 价值 |
|---|---|---|
| etag | 每当更新资源时更改的唯一只读字符串 | 字符串 |
| id | 资源 ID | 字符串 |
| 名字 | 获取资源组中唯一的资源的名称。 此名称可用于访问资源 | 字符串 |
| 性能 | AuthorizationPropertiesFormat |
ExpressRouteCircuitPeering
| 名字 | 描述 | 价值 |
|---|---|---|
| etag | 每当更新资源时更改的唯一只读字符串 | 字符串 |
| id | 资源 ID | 字符串 |
| 名字 | 获取资源组中唯一的资源的名称。 此名称可用于访问资源 | 字符串 |
| 性能 | ExpressRouteCircuitPeeringPropertiesFormat |
ExpressRouteCircuitPeeringConfig
| 名字 | 描述 | 价值 |
|---|---|---|
| advertisedPublicPrefixes | 获取或设置 AdvertisedPublicPrefixes 的引用 | string[] |
| advertisedPublicPrefixesState | 获取或设置对等互连资源的 AdvertisedPublicPrefixState | “已配置” “配置” “NotConfigured” “ValidationNeeded” |
| customerASN | 获取或设置对等互连的 CustomerAsn。 | int |
| routingRegistryName | 获取或设置配置的 RoutingRegistryName。 | 字符串 |
ExpressRouteCircuitPeeringPropertiesFormat
| 名字 | 描述 | 价值 |
|---|---|---|
| azureASN | 获取或设置 Azure ASN | int |
| microsoftPeeringConfig | 获取或设置Microsoft对等互连配置 | ExpressRouteCircuitPeeringConfig |
| peerASN | 获取或设置对等 ASN | int |
| peeringType | 获取或设置 PeeringType | “AzurePrivatePeering” “AzurePublicPeering” “MicrosoftPeering” |
| primaryAzurePort | 获取或设置主端口 | 字符串 |
| primaryPeerAddressPrefix | 获取或设置主地址前缀 | 字符串 |
| provisioningState | 获取或设置 PublicIP 资源更新/删除/失败的预配状态 | 字符串 |
| secondaryAzurePort | 获取或设置辅助端口 | 字符串 |
| secondaryPeerAddressPrefix | 获取或设置辅助地址前缀 | 字符串 |
| sharedKey | 获取或设置共享密钥 | 字符串 |
| 州 | 获取或设置对等互连的状态 | “Disabled” “Enabled” |
| 统计 | 获取或对等互连统计信息 | ExpressRouteCircuitStats |
| vlanId | 获取或设置 vlan ID | int |
ExpressRouteCircuitPropertiesFormat
| 名字 | 描述 | 价值 |
|---|---|---|
| 授权 | 获取或设置授权列表 | ExpressRouteCircuitAuthorization[] |
| circuitProvisioningState | 获取或设置资源的 CircuitProvisioningState 状态 | 字符串 |
| 对等互连 | 获取或设置对等互连的列表 | ExpressRouteCircuitPeering[] |
| provisioningState | 获取或设置 PublicIP 资源更新/删除/失败的预配状态 | 字符串 |
| serviceKey | 获取或设置 ServiceKey | 字符串 |
| serviceProviderNotes | 获取或设置 ServiceProviderNotes | 字符串 |
| serviceProviderProperties | 获取或设置 ServiceProviderProperties | ExpressRouteCircuitServiceProviderProperties |
| serviceProviderProvisioningState | 获取或设置资源的 ServiceProviderProvisioningState 状态 | “取消预配” “NotProvisioned” “Provisioned” “预配” |
ExpressRouteCircuitServiceProviderProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| bandwidthInMbps | 获取或设置 BandwidthInMbps。 | int |
| peeringLocation | 获取或设置对等互连位置。 | 字符串 |
| serviceProviderName | 获取或设置 serviceProviderName。 | 字符串 |
ExpressRouteCircuitSku
| 名字 | 描述 | 价值 |
|---|---|---|
| 家庭 | 获取或设置 SKU 的系列。 | “MeteredData” “UnlimitedData” |
| 名字 | 获取或设置 SKU 的名称。 | 字符串 |
| 层 | 获取或设置 SKU 的层。 | “Premium” “Standard” |
ExpressRouteCircuitStats
| 名字 | 描述 | 价值 |
|---|---|---|
| bytesIn | 获取对等互连的 BytesIn。 | int |
| bytesOut | 获取对等互连的 BytesOut。 | int |
Microsoft.Network/expressRouteCircuits
| 名字 | 描述 | 价值 |
|---|---|---|
| etag | 获取在更新资源时更改的唯一只读字符串 | 字符串 |
| 位置 | 资源位置 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | ExpressRouteCircuit 的属性 | ExpressRouteCircuitPropertiesFormat |
| sku | 获取或设置 sku | ExpressRouteCircuitSku |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.Network/expressRouteCircuits@2015-05-01-preview” |
ResourceTags
| 名字 | 描述 | 价值 |
|---|