您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

NetworkInterfaces In CloudService - List Cloud Service Role Instance Network Interfaces

获取有关云服务中角色实例中所有网络接口的信息。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces?api-version=2021-02-01

URI 参数

Name In Required Type Description
cloudServiceName
path True
  • string

云服务的名称。

resourceGroupName
path True
  • string

资源组的名称。

roleInstanceName
path True
  • string

角色实例的名称。

subscriptionId
path True
  • string

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

api-version
query True

客户端 API 版本。

响应

Name Type Description
200 OK

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

Other Status Codes

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

安全性

azure_auth

Azure Active DirectoryOAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

List cloud service role instance network interfaces

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces?api-version=2021-02-01

Sample Response

{
  "value": [
    {
      "name": "nic1",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1",
      "properties": {
        "provisioningState": "Succeeded",
        "ipConfigurations": [
          {
            "name": "ip1",
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1",
            "properties": {
              "provisioningState": "Succeeded",
              "privateIPAddress": "10.0.0.5",
              "privateIPAllocationMethod": "Dynamic",
              "publicIPAddress": {
                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1"
              },
              "subnet": {
                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"
              },
              "primary": true,
              "privateIPAddressVersion": "IPv4",
              "loadBalancerBackendAddressPools": [
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1"
                }
              ],
              "loadBalancerInboundNatRules": [
                {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1"
                }
              ]
            }
          }
        ],
        "dnsSettings": {
          "dnsServers": [],
          "appliedDnsServers": [],
          "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net"
        },
        "macAddress": "00-00-00-00-00-00",
        "enableAcceleratedNetworking": false,
        "enableIPForwarding": false,
        "networkSecurityGroup": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"
        },
        "primary": true,
        "roleInstance": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0"
        }
      }
    }
  ]
}

定义

ApiVersion

客户端 API 版本。

ApplicationGatewayBackendAddress

应用程序网关的后端地址。

ApplicationGatewayBackendAddressPool

应用程序网关的后端地址池。

ApplicationGatewayIPConfiguration

应用程序网关的 IP 配置。 目前允许 1 个公共和 1 个专用 IP 配置。

ApplicationSecurityGroup

资源组中的应用程序安全组。

AutoApproval

专用链接服务的自动批准列表。

BackendAddressPool

后端 IP 地址池。

CloudError

来自服务的错误响应。

CloudErrorBody

来自服务的错误响应。

CustomDnsConfigPropertiesFormat

包含来自客户的自定义 Dns 解析配置。

DdosSettings

包含公共 IP 的 DDoS 保护设置。

DdosSettingsProtectionCoverage

公共 IP 的 DDoS 防护策略可定制性。 只有标准覆盖范围才能自定义。

Delegation

详细说明将子网委托给的服务。

DeleteOptions

指定在删除使用的 VM 时公共 IP 地址会发生什么情况

ExtendedLocation

ExtendedLocation 复杂类型。

ExtendedLocationTypes

扩展位置的类型。

FlowLog

流日志资源。

FlowLogFormatParameters

定义流日志格式的参数。

FlowLogFormatType

流日志的文件类型。

FrontendIPConfiguration

负载均衡器的前端 IP 地址。

GatewayLoadBalancerTunnelInterface

负载均衡器后端地址池的网关负载均衡器隧道接口。

GatewayLoadBalancerTunnelInterfaceType

网关负载均衡器隧道接口的流量类型。

GatewayLoadBalancerTunnelProtocol

网关负载均衡器隧道接口的协议。

InboundNatRule

负载均衡器入站 NAT 规则。

IPAllocationMethod

IP 地址分配方法。

IPConfiguration

IP 配置。

IPConfigurationProfile

IP 配置文件子资源。

IpTag

包含与对象关联的 IpTag。

IPVersion

IP 地址版本。

LoadBalancerBackendAddress

负载均衡器后端地址。

NatGateway

Nat 网关资源。

NatGatewaySku

Nat 网关的 SKU。

NatGatewaySkuName

Nat 网关 SKU 的名称。

NetworkInterface

资源组中网络接口。

NetworkInterfaceDnsSettings

网络接口的 DNS 设置。

NetworkInterfaceIPConfiguration

网络接口中的 IPConfiguration。

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

网络接口的 PrivateLinkConnection 属性。

NetworkInterfaceListResult

ListNetworkInterface API 服务调用的响应。

NetworkInterfaceMigrationPhase

网络接口资源的迁移阶段。

NetworkInterfaceNicType

网络接口资源的类型。

NetworkInterfaceTapConfiguration

点击网络接口中的配置。

NetworkSecurityGroup

NetworkSecurityGroup 资源。

PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

PrivateEndpointConnection 资源。

PrivateLinkService

专用链接服务资源。

PrivateLinkServiceConnection

PrivateLinkServiceConnection 资源。

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

PrivateLinkServiceIpConfiguration

专用链接服务 ip 配置。

ProvisioningState

当前预配状态。

PublicIPAddress

公共 IP 地址资源。

PublicIPAddressDnsSettings

包含与公共 IP 地址关联的 DNS 记录的 FQDN。

PublicIPAddressMigrationPhase

公共 IP 地址的迁移阶段。

PublicIPAddressSku

公共 IP 地址的 SKU。

PublicIPAddressSkuName

公共 IP 地址 SKU 的名称。

PublicIPAddressSkuTier

公共 IP 地址 SKU 的层。

ResourceNavigationLink

ResourceNavigationLink 资源。

RetentionPolicyParameters

定义流日志保留策略的参数。

Route

路由资源。

RouteNextHopType

数据包应发送到的 Azure 跃点的类型。

RouteTable

路由表资源。

SecurityRule

网络安全规则。

SecurityRuleAccess

是否允许或拒绝网络流量。

SecurityRuleDirection

规则的方向。 direction 指定是要针对传入流量还是传出流量评估该规则。

SecurityRuleProtocol

此规则应用到的网络协议。

ServiceAssociationLink

ServiceAssociationLink 资源。

ServiceEndpointPolicy

服务终点策略资源。

ServiceEndpointPolicyDefinition

服务终结点策略定义。

ServiceEndpointPropertiesFormat

服务终结点属性。

Subnet

虚拟网络资源中的子网。

SubResource

对另一个子资源的引用。

TrafficAnalyticsConfigurationProperties

定义流量分析配置的参数。

TrafficAnalyticsProperties

定义流量分析配置的参数。

TransportProtocol

终结点的传输协议。

VirtualNetworkPrivateEndpointNetworkPolicies

启用或禁用在子网中的专用终点应用网络策略。

VirtualNetworkPrivateLinkServiceNetworkPolicies

启用或禁用对子网中的专用链接服务应用网络策略。

VirtualNetworkTap

虚拟网络点击资源。

Visibility

专用链接服务的可见性列表。

ApiVersion

客户端 API 版本。

Name Type Description
2017-03-30
  • string

ApplicationGatewayBackendAddress

应用程序网关的后端地址。

Name Type Description
fqdn
  • string

完全限定的域名 (FQDN)。

ipAddress
  • string

IP 地址。

ApplicationGatewayBackendAddressPool

应用程序网关的后端地址池。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

应用程序网关中唯一的后端地址池的名称。

properties.backendAddresses

后端地址。

properties.backendIPConfigurations

对网络接口中定义的 IP 的引用集合。

properties.provisioningState

后端地址池资源的预配状态。

type
  • string

资源的类型。

ApplicationGatewayIPConfiguration

应用程序网关的 IP 配置。 目前允许 1 个公共和 1 个专用 IP 配置。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

应用程序网关中唯一的 IP 配置的名称。

properties.provisioningState

应用程序网关 IP 配置资源的预配状态。

properties.subnet

对子网资源的引用。 应用程序网关从其中获取其专用地址的子网。

type
  • string

资源的类型。

ApplicationSecurityGroup

资源组中的应用程序安全组。

Name Type Description
etag
  • string

每当更新资源时,将更改唯一的只读字符串。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.provisioningState

应用程序安全组资源的设置状态。

properties.resourceGuid
  • string

应用程序安全组资源的资源 GUID 属性。 它唯一地标识资源,即使用户在订阅或资源组中更改其名称或迁移资源。

tags
  • object

资源标记。

type
  • string

资源类型。

AutoApproval

专用链接服务的自动批准列表。

Name Type Description
subscriptions
  • string[]

订阅列表。

BackendAddressPool

后端 IP 地址池。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

在负载均衡器使用的后端地址池集内唯一的资源的名称。 此名称可用于访问资源。

properties.backendIPConfigurations

对网络接口中定义的 IP 地址的引用数组。

properties.loadBalancerBackendAddresses

后端地址的数组。

properties.loadBalancingRules

对此后端地址池的负载均衡规则的引用数组。

properties.location
  • string

后端地址池的位置。

properties.outboundRule

对此后端地址池的出站规则的引用。

properties.outboundRules

对此后端地址池的出站规则的引用数组。

properties.provisioningState

后端地址池资源的预配状态。

properties.tunnelInterfaces

网关负载均衡器隧道接口的数组。

type
  • string

资源的类型。

CloudError

来自服务的错误响应。

Name Type Description
error

云错误正文。

CloudErrorBody

来自服务的错误响应。

Name Type Description
code
  • string

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

details

有关错误的更多详细信息的列表。

message
  • string

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

target
  • string

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

CustomDnsConfigPropertiesFormat

包含来自客户的自定义 Dns 解析配置。

Name Type Description
fqdn
  • string

解析为专用终结点 IP 地址的 Fqdn。

ipAddresses
  • string[]

专用终结点的专用 IP 地址列表。

DdosSettings

包含公共 IP 的 DDoS 保护设置。

Name Type Description
ddosCustomPolicy

与公共 IP 关联的 DDoS 自定义策略。

protectedIP
  • boolean

对公共 IP 启用 DDoS 保护。

protectionCoverage

公共 IP 的 DDoS 防护策略可定制性。 只有标准覆盖范围才能自定义。

DdosSettingsProtectionCoverage

公共 IP 的 DDoS 防护策略可定制性。 只有标准覆盖范围才能自定义。

Name Type Description
Basic
  • string
Standard
  • string

Delegation

详细说明将子网委托给的服务。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

子网中唯一的资源的名称。 此名称可用于访问资源。

properties.actions
  • string[]

委派时允许对服务的操作。

properties.provisioningState

服务委派资源的预配状态。

properties.serviceName
  • string

子网应委派给的服务的名称 (例如 Microsoft.Sql/servers) 。

type
  • string

资源类型。

DeleteOptions

指定在删除使用的 VM 时公共 IP 地址会发生什么情况

Name Type Description
Delete
  • string
Detach
  • string

ExtendedLocation

ExtendedLocation 复杂类型。

Name Type Description
name
  • string

扩展位置的名称。

type

扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

Name Type Description
EdgeZone
  • string

FlowLog

流日志资源。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.enabled
  • boolean

要启用/禁用流日志记录的标志。

properties.flowAnalyticsConfiguration

定义流量分析配置的参数。

properties.format

定义流日志格式的参数。

properties.provisioningState

流日志的预配状态。

properties.retentionPolicy

定义流日志保留策略的参数。

properties.storageId
  • string

用于存储流日志的存储帐户的 ID。

properties.targetResourceGuid
  • string

将应用流日志的网络安全组的 Guid。

properties.targetResourceId
  • string

将应用流日志的网络安全组的 ID。

tags
  • object

资源标记。

type
  • string

资源类型。

FlowLogFormatParameters

定义流日志格式的参数。

Name Type Description
type

流日志的文件类型。

version
  • integer

版本 (流) 的修订版本。

FlowLogFormatType

流日志的文件类型。

Name Type Description
JSON
  • string

FrontendIPConfiguration

负载均衡器的前端 IP 地址。

Name Type Description
etag
  • string

每当更新资源时,将更改唯一的只读字符串。

id
  • string

资源 ID。

name
  • string

在负载均衡器使用的前端 IP 配置集中唯一的资源名称。 此名称可用于访问资源。

properties.gatewayLoadBalancer

对网关负载均衡器前端 IP 的引用。

properties.inboundNatPools

对使用此前端 IP 的入站池的引用数组。

properties.inboundNatRules

对使用此前端 IP 的入站规则的引用数组。

properties.loadBalancingRules

对使用此前端 IP 的负载均衡规则的引用数组。

properties.outboundRules

对使用此前端 IP 的出站规则的引用数组。

properties.privateIPAddress
  • string

IP 配置的专用 IP 地址。

properties.privateIPAddressVersion

特定 ipconfiguration 是 IPv4 还是 IPv6。 默认值为 IPv4。

properties.privateIPAllocationMethod

专用 IP 分配方法。

properties.provisioningState

前端 IP 配置资源的设置状态。

properties.publicIPAddress

对公共 IP 资源的引用。

properties.publicIPPrefix

对公共 IP 前缀资源的引用。

properties.subnet

对子网资源的引用。

type
  • string

资源的类型。

zones
  • string[]

表明为资源分配的 IP 需要来自的可用性区域列表。

GatewayLoadBalancerTunnelInterface

负载均衡器后端地址池的网关负载均衡器隧道接口。

Name Type Description
identifier
  • integer

网关负载均衡器隧道接口的标识符。

port
  • integer

网关负载均衡器隧道接口的端口。

protocol

网关负载均衡器隧道接口的协议。

type

网关负载均衡器隧道接口的流量类型。

GatewayLoadBalancerTunnelInterfaceType

网关负载均衡器隧道接口的流量类型。

Name Type Description
External
  • string
Internal
  • string
None
  • string

GatewayLoadBalancerTunnelProtocol

网关负载均衡器隧道接口的协议。

Name Type Description
Native
  • string
None
  • string
VXLAN
  • string

InboundNatRule

负载均衡器入站 NAT 规则。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

在负载均衡器使用的入站 NAT 规则集内唯一的资源的名称。 此名称可用于访问资源。

properties.backendIPConfiguration

对在 VM 的网络接口上定义的专用 IP 地址的引用。 发送到每个前端 IP 配置的前端端口的流量将转发到后端 IP。

properties.backendPort
  • integer

用于内部终结点的端口。 可接受的值范围为 1 到 65535。

properties.enableFloatingIP
  • boolean

为配置 AlwaysOn 可用性组所需的浮动 IP 功能配置SQL终结点。 在服务器服务器中SQL AlwaysOn 可用性组时SQL此设置。 创建终结点后无法更改此设置。

properties.enableTcpReset
  • boolean

在 TCP 流空闲超时或意外的连接终止时接收双向 TCP 重置。 仅在将协议设置为 TCP 后才使用此元素。

properties.frontendIPConfiguration

对前端 IP 地址的引用。

properties.frontendPort
  • integer

外部终结点的端口。 每个规则的端口号在负载均衡器中必须是唯一的。 可接受的值范围为 1 到 65534。

properties.idleTimeoutInMinutes
  • integer

TCP 空闲连接的超时。 该值可设置为介于 4 和 30 分钟之间。 默认值为 4 分钟。 仅在将协议设置为 TCP 后才使用此元素。

properties.protocol

对负载均衡规则使用的传输协议的引用。

properties.provisioningState

入站 NAT 规则资源的预配状态。

type
  • string

资源的类型。

IPAllocationMethod

IP 地址分配方法。

Name Type Description
Dynamic
  • string
Static
  • string

IPConfiguration

IP 配置。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.privateIPAddress
  • string

IP 配置的专用 IP 地址。

properties.privateIPAllocationMethod

专用 IP 地址分配方法。

properties.provisioningState

IP 配置资源的预配状态。

properties.publicIPAddress

对公共 IP 资源的引用。

properties.subnet

对子网资源的引用。

IPConfigurationProfile

IP 配置文件子资源。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

资源的名称。 此名称可用于访问资源。

properties.provisioningState

IP 配置文件资源的预配状态。

properties.subnet

对子网资源的引用,用于创建容器网络接口 IP 配置。

type
  • string

子资源类型。

IpTag

包含与对象关联的 IpTag。

Name Type Description
ipTagType
  • string

IP 标记类型。 例如: FirstPartyUsage。

tag
  • string

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

IPVersion

IP 地址版本。

Name Type Description
IPv4
  • string
IPv6
  • string

LoadBalancerBackendAddress

负载均衡器后端地址。

Name Type Description
name
  • string

后端地址的名称。

properties.ipAddress
  • string

属于被引用虚拟网络的 IP 地址。

properties.loadBalancerFrontendIPConfiguration

对区域 loadbalancer 中定义的前端 ip 地址配置的引用。

properties.networkInterfaceIPConfiguration

对网络接口中定义的 IP 地址的引用。

properties.subnet

引用现有子网。

properties.virtualNetwork

对现有虚拟网络的引用。

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

NetworkInterface

资源组中网络接口。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

extendedLocation

网络接口的扩展位置。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.dnsSettings

网络接口中的 DNS 设置。

properties.dscpConfiguration

对网络接口链接到的 dscp 配置的引用。

properties.enableAcceleratedNetworking
  • boolean

如果网络接口已启用加速网络。

properties.enableIPForwarding
  • boolean

指示是否在此网络接口上启用 IP 转发。

properties.hostedWorkloads
  • string[]

对链接的 BareMetal 资源的引用列表。

properties.ipConfigurations

网络接口的 IPConfigurations 列表。

properties.macAddress
  • string

网络接口的 MAC 地址。

properties.migrationPhase

网络接口资源的迁移阶段。

properties.networkSecurityGroup

对 NetworkSecurityGroup 资源的引用。

properties.nicType

网络接口资源的类型。

properties.primary
  • boolean

这是否是虚拟机上的主网络接口。

properties.privateEndpoint

对网络接口链接到的专用终结点的引用。

properties.privateLinkService

网络接口资源的 Privatelinkservice。

properties.provisioningState

网络接口资源的预配状态。

properties.resourceGuid
  • string

网络接口资源的资源 GUID 属性。

properties.tapConfigurations

网络接口的 TapConfigurations 列表。

properties.virtualMachine

对虚拟机的引用。

properties.workloadType
  • string

BareMetal 资源的 NetworkInterface 的 WorkloadType

tags
  • object

资源标记。

type
  • string

资源类型。

NetworkInterfaceDnsSettings

网络接口的 DNS 设置。

Name Type Description
appliedDnsServers
  • string[]

如果使用此 NIC 的 VM 是可用性集的一部分,则此列表将包含属于可用性集的所有 NIC 的所有 DNS 服务器的并集。 此属性是在每个 VM 上配置的属性。

dnsServers
  • string[]

DNS 服务器 IP 地址列表。 使用"AzureProvidedDNS"切换到 Azure 提供的 DNS 解析。 "AzureProvidedDNS"值不能与其他 IP 组合,它必须是 dnsServers 集合中的唯一值。

internalDnsNameLabel
  • string

此 NIC 的相对 DNS 名称,用于同一虚拟网络中 VM 之间的内部通信。

internalDomainNameSuffix
  • string

即使未指定 internalDnsNameLabel,也为 VM 的主 NIC 创建 DNS 条目。 可以通过将 VM 名称与 internalDomainNameSuffix 的值相连接来构造此 DNS 名称。

internalFqdn
  • string

支持同一虚拟网络中 VM 之间的内部通信的完全限定 DNS 名称。

NetworkInterfaceIPConfiguration

网络接口中的 IPConfiguration。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.applicationGatewayBackendAddressPools

对 ApplicationGatewayBackendAddressPool 资源的引用。

properties.applicationSecurityGroups

包含 IP 配置的应用程序安全组。

properties.gatewayLoadBalancer

对网关负载均衡器前端 IP 的引用。

properties.loadBalancerBackendAddressPools

对 LoadBalancerBackendAddressPool 资源的引用。

properties.loadBalancerInboundNatRules

LoadBalancerInboundNatRules 的引用列表。

properties.primary
  • boolean

这是否是网络接口上的主要客户地址。

properties.privateIPAddress
  • string

IP 配置的专用 IP 地址。

properties.privateIPAddressVersion

特定 IP 配置是 IPv4 还是 IPv6。 默认值为 IPv4。

properties.privateIPAllocationMethod

专用 IP 地址分配方法。

properties.privateLinkConnectionProperties

网络接口的 PrivateLinkConnection 属性。

properties.provisioningState

网络接口 IP 配置的预配状态。

properties.publicIPAddress

绑定到 IP 配置的公共 IP 地址。

properties.subnet

绑定到 IP 配置的子网。

properties.virtualNetworkTaps

对虚拟网络点击的引用。

type
  • string

资源类型。

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

网络接口的 PrivateLinkConnection 属性。

Name Type Description
fqdns
  • string[]

当前专用链接连接的 Fqdn 列表。

groupId
  • string

当前专用链接连接的组 ID。

requiredMemberName
  • string

当前专用链接连接所需的成员名称。

NetworkInterfaceListResult

ListNetworkInterface API 服务调用的响应。

Name Type Description
nextLink
  • string

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

value

资源组中网络接口的列表。

NetworkInterfaceMigrationPhase

网络接口资源的迁移阶段。

Name Type Description
Abort
  • string
Commit
  • string
Committed
  • string
None
  • string
Prepare
  • string

NetworkInterfaceNicType

网络接口资源的类型。

Name Type Description
Elastic
  • string
Standard
  • string

NetworkInterfaceTapConfiguration

点击网络接口中的配置。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.provisioningState

网络接口点击配置资源的预配状态。

properties.virtualNetworkTap

对虚拟网络点击资源的引用。

type
  • string

子资源类型。

NetworkSecurityGroup

NetworkSecurityGroup 资源。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.defaultSecurityRules

网络安全组的默认安全规则。

properties.flowLogs

对流日志资源的引用的集合。

properties.networkInterfaces

对网络接口的引用的集合。

properties.provisioningState

网络安全组资源的预配状态。

properties.resourceGuid
  • string

网络安全组资源的资源 GUID 属性。

properties.securityRules

网络安全组的安全规则的集合。

properties.subnets

对子网的引用的集合。

tags
  • object

资源标记。

type
  • string

资源类型。

PrivateEndpoint

专用终结点资源。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

extendedLocation

负载均衡器扩展的位置。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.customDnsConfigs

自定义 dns 配置的数组。

properties.manualPrivateLinkServiceConnections

有关与远程资源的连接的信息的分组。 当网络管理员没有权限批准与远程资源的连接时使用。

properties.networkInterfaces

对此专用终结点创建的网络接口的引用数组。

properties.privateLinkServiceConnections

有关与远程资源的连接的信息的分组。

properties.provisioningState

专用终结点资源的预配状态。

properties.subnet

将分配专用 IP 的子网的 ID。

tags
  • object

资源标记。

type
  • string

资源类型。

PrivateEndpointConnection

PrivateEndpointConnection 资源。

Name Type Description
etag
  • string

每当更新资源时,将更改唯一的只读字符串。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.linkIdentifier
  • string

使用者链接 id。

properties.privateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

properties.provisioningState

专用终结点连接资源的设置状态。

type
  • string

资源类型。

PrivateLinkService

专用链接服务资源。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

extendedLocation

负载均衡器扩展的位置。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.alias
  • string

专用链接服务的别名。

properties.autoApproval

专用链接服务的自动批准列表。

properties.enableProxyProtocol
  • boolean

是否为代理协议启用了专用链接服务。

properties.fqdns
  • string[]

Fqdn 的列表。

properties.ipConfigurations

专用链接服务 IP 配置的数组。

properties.loadBalancerFrontendIpConfigurations

对负载均衡器 IP 配置的引用数组。

properties.networkInterfaces

对此专用链接服务创建的网络接口的引用数组。

properties.privateEndpointConnections

有关与专用终结点的连接的列表的数组。

properties.provisioningState

专用链接服务资源的预配状态。

properties.visibility

专用链接服务的可见性列表。

tags
  • object

资源标记。

type
  • string

资源类型。

PrivateLinkServiceConnection

PrivateLinkServiceConnection 资源。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.groupIds
  • string[]

ID () 从 (终结点) 的远程资源获取的组名称。

properties.privateLinkServiceConnectionState

与远程资源的连接状态有关的只读信息的集合。

properties.privateLinkServiceId
  • string

专用链接服务的资源 ID。

properties.provisioningState

专用链接服务连接资源的预配状态。

properties.requestMessage
  • string

通过此连接请求传递给远程资源所有者的消息。 限制为 140 个字符。

type
  • string

资源类型。

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

Name Type Description
actionsRequired
  • string

一条消息,指示服务提供程序上的更改是否需要对使用者进行任何更新。

description
  • string

连接批准/拒绝的原因。

status
  • string

指示连接是否已由服务所有者批准/拒绝/删除。

PrivateLinkServiceIpConfiguration

专用链接服务 ip 配置。

Name Type Description
etag
  • string

每当更新资源时,将更改唯一的只读字符串。

id
  • string

资源 ID。

name
  • string

专用链接服务 ip 配置的名称。

properties.primary
  • boolean

Ip 配置是否为主。

properties.privateIPAddress
  • string

IP 配置的专用 IP 地址。

properties.privateIPAddressVersion

特定 IP 配置是 IPv4 还是 IPv6。 默认值为 IPv4。

properties.privateIPAllocationMethod

专用 IP 地址分配方法。

properties.provisioningState

专用链接服务 IP 配置资源的设置状态。

properties.subnet

对子网资源的引用。

type
  • string

资源类型。

ProvisioningState

当前预配状态。

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

PublicIPAddress

公共 IP 地址资源。

Name Type Description
etag
  • string

每当更新资源时,将更改唯一的只读字符串。

extendedLocation

公共 ip 地址的扩展位置。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.ddosSettings

与公共 IP 地址关联的 DDoS 防护自定义策略。

properties.deleteOption

指定在删除使用的 VM 时公共 IP 地址会发生什么情况

properties.dnsSettings

与公共 IP 地址关联的 DNS 记录的 FQDN。

properties.idleTimeoutInMinutes
  • integer

公共 IP 地址的空闲超时。

properties.ipAddress
  • string

与公共 IP 地址资源关联的 IP 地址。

properties.ipConfiguration

与公共 IP 地址关联的 IP 配置。

properties.ipTags

与公共 IP 地址关联的标记的列表。

properties.linkedPublicIPAddress

公共 IP 地址资源的链接的公共 IP 地址。

properties.migrationPhase

公共 IP 地址的迁移阶段。

properties.natGateway

公共 IP 地址的 NatGateway。

properties.provisioningState

公共 IP 地址资源的设置状态。

properties.publicIPAddressVersion

公共 IP 地址版本。

properties.publicIPAllocationMethod

公共 IP 地址分配方法。

properties.publicIPPrefix

应从其分配此公共 IP 地址的公共 IP 前缀。

properties.resourceGuid
  • string

公共 IP 地址资源的资源 GUID 属性。

properties.servicePublicIPAddress

公共 IP 地址资源的服务公共 IP 地址。

sku

公共 IP 地址 SKU。

tags
  • object

资源标记。

type
  • string

资源类型。

zones
  • string[]

表明为资源分配的 IP 需要来自的可用性区域列表。

PublicIPAddressDnsSettings

包含与公共 IP 地址关联的 DNS 记录的 FQDN。

Name Type Description
domainNameLabel
  • string

域名标签。 域名标签与区域化 DNS 区域的串联形式构成了与公共 IP 地址关联的完全限定域名。 如果指定了域名标签,则会在 Microsoft Azure DNS 系统中为公共 IP 创建 DNS 记录。

fqdn
  • string

与公共 IP 关联的 DNS 记录的完全限定的域名。 这是 domainNameLabel 和区域化 DNS 区域的串联。

reverseFqdn
  • string

反向 FQDN。 解析为此公共 IP 地址的用户可见的完全限定的域名。 如果指定了 reverseFqdn,则会创建从 in-addr.arpa 域中的 IP 地址指向反向 FQDN 的 DNS PTR 记录。

PublicIPAddressMigrationPhase

公共 IP 地址的迁移阶段。

Name Type Description
Abort
  • string
Commit
  • string
Committed
  • string
None
  • string
Prepare
  • string

PublicIPAddressSku

公共 IP 地址的 SKU。

Name Type Description
name

公共 IP 地址 SKU 的名称。

tier

公共 IP 地址 SKU 的层。

PublicIPAddressSkuName

公共 IP 地址 SKU 的名称。

Name Type Description
Basic
  • string
Standard
  • string

PublicIPAddressSkuTier

公共 IP 地址 SKU 的层。

Name Type Description
Global
  • string
Regional
  • string

ResourceNavigationLink 资源。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源导航链接标识符。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.link
  • string

链接到外部资源。

properties.linkedResourceType
  • string

链接资源的资源类型。

properties.provisioningState

资源导航链接资源的预配状态。

type
  • string

资源类型。

RetentionPolicyParameters

定义流日志保留策略的参数。

Name Type Description
days
  • integer

保留流日志记录的天数。

enabled
  • boolean

要启用/禁用保留的标志。

Route

路由资源。

Name Type Description
etag
  • string

每当更新资源时,将更改唯一的只读字符串。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.addressPrefix
  • string

路由应用到的目标 CIDR。

properties.hasBgpOverride
  • boolean

一个值,该值指示此路由是否覆盖与 LPM 无关的重叠 BGP 路由。

properties.nextHopIpAddress
  • string

应将 IP 地址转发到。 下一跃点值只允许在下一跃点类型为 VirtualAppliance 的路由中使用。

properties.nextHopType

数据包应发送到的 Azure 跃点的类型。

properties.provisioningState

路由资源的设置状态。

type
  • string

资源类型。

RouteNextHopType

数据包应发送到的 Azure 跃点的类型。

Name Type Description
Internet
  • string
None
  • string
VirtualAppliance
  • string
VirtualNetworkGateway
  • string
VnetLocal
  • string

RouteTable

路由表资源。

Name Type Description
etag
  • string

每当更新资源时,将更改唯一的只读字符串。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.disableBgpRoutePropagation
  • boolean

是否禁用 BGP 在该路由表上获知的路由。 如果为 True,则表示禁用。

properties.provisioningState

路由表资源的设置状态。

properties.resourceGuid
  • string

路由表的资源 GUID 属性。

properties.routes

包含在路由表中的路由的集合。

properties.subnets

对子网的引用的集合。

tags
  • object

资源标记。

type
  • string

资源类型。

SecurityRule

网络安全规则。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.access

允许或拒绝网络流量。

properties.description
  • string

此规则的说明。 限制为 140 个字符。

properties.destinationAddressPrefix
  • string

目标地址前缀。 CIDR 或目标 IP 范围。 星号"*"还可用于匹配所有源 IP。 也可使用默认标记,例如"VirtualNetwork"、"AzureLoadBalancer"和"Internet"。

properties.destinationAddressPrefixes
  • string[]

目标地址前缀。 CIDR 或目标 IP 范围。

properties.destinationApplicationSecurityGroups

指定为目标的应用程序安全组。

properties.destinationPortRange
  • string

目标端口或范围。 介于 0 和 65535 之间的整数或范围。 星号"*"还可用于匹配所有端口。

properties.destinationPortRanges
  • string[]

目标端口范围。

properties.direction

规则的方向。 direction 指定是要针对传入流量还是传出流量评估该规则。

properties.priority
  • integer

规则的优先级。 该值可以介于 100 和 4096 之间。 对于集合中每个规则,优先级编号必须是唯一的。 优先级编号越低,规则优先级越高。

properties.protocol

此规则应用到的网络协议。

properties.provisioningState

安全规则资源的预配状态。

properties.sourceAddressPrefix
  • string

CIDR 或源 IP 范围。 星号"*"还可用于匹配所有源 IP。 也可使用默认标记,例如"VirtualNetwork"、"AzureLoadBalancer"和"Internet"。 如果这是入口规则,则指定网络流量的来源。

properties.sourceAddressPrefixes
  • string[]

CIDR 或源 IP 范围。

properties.sourceApplicationSecurityGroups

指定为源的应用程序安全组。

properties.sourcePortRange
  • string

源端口或范围。 介于 0 和 65535 之间的整数或范围。 星号"*"还可用于匹配所有端口。

properties.sourcePortRanges
  • string[]

源端口范围。

type
  • string

资源类型。

SecurityRuleAccess

是否允许或拒绝网络流量。

Name Type Description
Allow
  • string
Deny
  • string

SecurityRuleDirection

规则的方向。 direction 指定是要针对传入流量还是传出流量评估该规则。

Name Type Description
Inbound
  • string
Outbound
  • string

SecurityRuleProtocol

此规则应用到的网络协议。

Name Type Description
*
  • string
Ah
  • string
Esp
  • string
Icmp
  • string
Tcp
  • string
Udp
  • string

ServiceAssociationLink 资源。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.allowDelete
  • boolean

如果为 true,可以删除资源。

properties.link
  • string

链接到外部资源。

properties.linkedResourceType
  • string

链接资源的资源类型。

properties.locations
  • string[]

位置列表。

properties.provisioningState

服务关联链接资源的预配状态。

type
  • string

资源类型。

ServiceEndpointPolicy

服务终点策略资源。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

kind
  • string

服务终结点策略类型。 这是用于体验体验Azure 门户元数据。

location
  • string

资源位置。

name
  • string

资源名称。

properties.provisioningState

服务终结点策略资源的预配状态。

properties.resourceGuid
  • string

服务终结点策略资源的资源 GUID 属性。

properties.serviceEndpointPolicyDefinitions

服务终结点策略的服务终结点策略定义的集合。

properties.subnets

对子网的引用的集合。

tags
  • object

资源标记。

type
  • string

资源类型。

ServiceEndpointPolicyDefinition

服务终结点策略定义。

Name Type Description
etag
  • string

每当更新资源时,将更改唯一的只读字符串。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.description
  • string

此规则的说明。 限制为140个字符。

properties.provisioningState

服务终结点策略定义资源的设置状态。

properties.service
  • string

服务终结点名称。

properties.serviceResources
  • string[]

服务资源的列表。

ServiceEndpointPropertiesFormat

服务终结点属性。

Name Type Description
locations
  • string[]

位置列表。

provisioningState

服务终结点资源的预配状态。

service
  • string

终结点服务的类型。

Subnet

虚拟网络资源中的子网。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

name
  • string

资源组中唯一的资源的名称。 此名称可用于访问资源。

properties.addressPrefix
  • string

子网的地址前缀。

properties.addressPrefixes
  • string[]

子网的地址前缀列表。

properties.applicationGatewayIpConfigurations

虚拟网络资源的应用程序网关 IP 配置。

properties.delegations

对子网上的表示的引用数组。

properties.ipAllocations

引用此子网的 IpAllocation 数组。

properties.ipConfigurationProfiles

引用此子网的 IP 配置文件数组。

properties.ipConfigurations

使用子网对网络接口 IP 配置的引用数组。

properties.natGateway

与此子网关联的 Nat 网关。

properties.networkSecurityGroup

对 NetworkSecurityGroup 资源的引用。

properties.privateEndpointNetworkPolicies

启用或禁用在子网中的专用终点应用网络策略。

properties.privateEndpoints

对专用终结点的引用数组。

properties.privateLinkServiceNetworkPolicies

启用或禁用对子网中的专用链接服务应用网络策略。

properties.provisioningState

子网资源的预配状态。

properties.purpose
  • string

一个只读字符串,用于根据"表示"和其他用户定义属性标识此子网的使用意图。

properties.resourceNavigationLinks

使用子网对外部资源的引用数组。

properties.routeTable

对 RouteTable 资源的引用。

properties.serviceAssociationLinks

注入到此子网的服务的引用数组。

properties.serviceEndpointPolicies

服务终结点策略的数组。

properties.serviceEndpoints

服务终结点的数组。

type
  • string

资源类型。

SubResource

对另一个子资源的引用。

Name Type Description
id
  • string

资源 ID。

TrafficAnalyticsConfigurationProperties

定义流量分析配置的参数。

Name Type Description
enabled
  • boolean

用于启用/禁用流量分析的标志。

trafficAnalyticsInterval
  • integer

间隔时间间隔,以分钟为单位,决定了 TA 服务应进行流分析的频率。

workspaceId
  • string

附加工作区的资源 guid。

workspaceRegion
  • string

附加工作区的位置。

workspaceResourceId
  • string

附加工作区的资源 Id。

TrafficAnalyticsProperties

定义流量分析配置的参数。

Name Type Description
networkWatcherFlowAnalyticsConfiguration

定义流量分析配置的参数。

TransportProtocol

终结点的传输协议。

Name Type Description
All
  • string
Tcp
  • string
Udp
  • string

VirtualNetworkPrivateEndpointNetworkPolicies

启用或禁用在子网中的专用终点应用网络策略。

Name Type Description
Disabled
  • string
Enabled
  • string

VirtualNetworkPrivateLinkServiceNetworkPolicies

启用或禁用对子网中的专用链接服务应用网络策略。

Name Type Description
Disabled
  • string
Enabled
  • string

VirtualNetworkTap

虚拟网络点击资源。

Name Type Description
etag
  • string

一个唯一只读字符串,每当资源更新时都会更改。

id
  • string

资源 ID。

location
  • string

资源位置。

name
  • string

资源名称。

properties.destinationLoadBalancerFrontEndIPConfiguration

对内部负载均衡器上将接收点击的专用 IP 地址的引用。

properties.destinationNetworkInterfaceIPConfiguration

对将接收点击的收集器 nic 的专用 IP 地址的引用。

properties.destinationPort
  • integer

将接收点击流量的 VXLAN 目标端口。

properties.networkInterfaceTapConfigurations

指定需要点击的网络接口 IP 配置的资源 ID 列表。

properties.provisioningState

虚拟网络点击资源的预配状态。

properties.resourceGuid
  • string

虚拟网络点击资源的资源 GUID 属性。

tags
  • object

资源标记。

type
  • string

资源类型。

Visibility

专用链接服务的可见性列表。

Name Type Description
subscriptions
  • string[]

订阅列表。