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

Private Link Services - Update Private Endpoint Connection

参考

服务:: Virtual Networks

API 版本:: 2024-05-01

批准或拒绝订阅中专用链接服务的专用终结点连接。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}?api-version=2024-05-01

URI 参数

名称	在	必需	类型	说明
peConnectionName	path	True	string	专用终结点连接的名称。
resourceGroupName	path	True	string	资源组的名称。
serviceName	path	True	string	专用链接服务的名称。
subscriptionId	path	True	string	唯一标识 Azure 订阅Microsoft的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

请求正文

名称	类型	说明
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。

响应

名称	类型	说明
200 OK	PrivateEndpointConnection	更新成功。该操作返回生成的 PrivateEndpointConnection 资源。
Other Status Codes	Error	错误。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

approve or reject private end point connection for a private link service

示例请求

PUT https://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls/privateEndpointConnections/testPlePeConnection?api-version=2024-05-01

{
  "name": "testPlePeConnection",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "approved it for some reason."
    }
  }
}


import com.azure.resourcemanager.network.fluent.models.PrivateEndpointConnectionInner;
import com.azure.resourcemanager.network.models.PrivateLinkServiceConnectionState;

/**
 * Samples for PrivateLinkServices UpdatePrivateEndpointConnection.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * PrivateLinkServiceUpdatePrivateEndpointConnection.json
     */
    /**
     * Sample code: approve or reject private end point connection for a private link service.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void approveOrRejectPrivateEndPointConnectionForAPrivateLinkService(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPrivateLinkServices()
            .updatePrivateEndpointConnectionWithResponse("rg1", "testPls", "testPlePeConnection",
                new PrivateEndpointConnectionInner().withName("testPlePeConnection")
                    .withPrivateLinkServiceConnectionState(new PrivateLinkServiceConnectionState()
                        .withStatus("Approved").withDescription("approved it for some reason.")),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python private_link_service_update_private_endpoint_connection.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subId",
    )

    response = client.private_link_services.update_private_endpoint_connection(
        resource_group_name="rg1",
        service_name="testPls",
        pe_connection_name="testPlePeConnection",
        parameters={
            "name": "testPlePeConnection",
            "properties": {
                "privateEndpoint": {
                    "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe"
                },
                "privateLinkServiceConnectionState": {
                    "description": "approved it for some reason.",
                    "status": "Approved",
                },
            },
        },
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json
func ExamplePrivateLinkServicesClient_UpdatePrivateEndpointConnection() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateLinkServicesClient().UpdatePrivateEndpointConnection(ctx, "rg1", "testPls", "testPlePeConnection", armnetwork.PrivateEndpointConnection{
		Name: to.Ptr("testPlePeConnection"),
		Properties: &armnetwork.PrivateEndpointConnectionProperties{
			PrivateEndpoint: &armnetwork.PrivateEndpoint{
				ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe"),
			},
			PrivateLinkServiceConnectionState: &armnetwork.PrivateLinkServiceConnectionState{
				Description: to.Ptr("approved it for some reason."),
				Status:      to.Ptr("Approved"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PrivateEndpointConnection = armnetwork.PrivateEndpointConnection{
	// 	ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls/privateEndpointConnections/testPlePeConnection"),
	// 	Name: to.Ptr("testPlePeConnection"),
	// 	Properties: &armnetwork.PrivateEndpointConnectionProperties{
	// 		PrivateEndpoint: &armnetwork.PrivateEndpoint{
	// 			ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe"),
	// 		},
	// 		PrivateLinkServiceConnectionState: &armnetwork.PrivateLinkServiceConnectionState{
	// 			Description: to.Ptr("approved it for some reason."),
	// 			Status: to.Ptr("Approved"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Approve or reject private end point connection for a private link service in a subscription.
 *
 * @summary Approve or reject private end point connection for a private link service in a subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json
 */
async function approveOrRejectPrivateEndPointConnectionForAPrivateLinkService() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const serviceName = "testPls";
  const peConnectionName = "testPlePeConnection";
  const parameters = {
    name: "testPlePeConnection",
    privateEndpoint: {
      id: "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe",
    },
    privateLinkServiceConnectionState: {
      description: "approved it for some reason.",
      status: "Approved",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.privateLinkServices.updatePrivateEndpointConnection(
    resourceGroupName,
    serviceName,
    peConnectionName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "name": "testPlePeConnection",
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls/privateEndpointConnections/testPlePeConnection",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "approved it for some reason."
    }
  }
}

定义

名称	说明
ApplicationGatewayBackendAddress	应用程序网关的后端地址。
ApplicationGatewayBackendAddressPool	应用程序网关的后端地址池。
ApplicationGatewayIPConfiguration	应用程序网关的 IP 配置。目前允许 1 个公共 IP 和 1 个专用 IP 配置。
ApplicationSecurityGroup	资源组中的应用程序安全组。
AutoApproval	专用链接服务的自动审批列表。
BackendAddressPool	后端 IP 地址池。
CustomDnsConfigPropertiesFormat	包含来自客户的自定义 Dns 解析配置。
DdosSettings	包含公共 IP 的 DDoS 保护设置。
DdosSettingsProtectionMode	公共 IP 的 DDoS 保护模式
Delegation	详细说明将子网委托到的服务。
DeleteOptions	指定删除 VM 时公共 IP 地址会发生什么情况
Error	常见的错误表示形式。
ErrorDetails	常见的错误详细信息表示形式。
ExtendedLocation	ExtendedLocation 复杂类型。
ExtendedLocationTypes	扩展位置的类型。
FlowLog	流日志资源。
FlowLogFormatParameters	定义流日志格式的参数。
FlowLogFormatType	流日志的文件类型。
FrontendIPConfiguration	负载均衡器的前端 IP 地址。
GatewayLoadBalancerTunnelInterface	负载均衡器后端地址池的网关负载均衡器隧道接口。
GatewayLoadBalancerTunnelInterfaceType	网关负载均衡器隧道接口的流量类型。
GatewayLoadBalancerTunnelProtocol	网关负载均衡器隧道接口的协议。
InboundNatRule	负载均衡器的入站 NAT 规则。
IPAllocationMethod	IP 地址分配方法。
IpamPoolPrefixAllocation	IpamPool 前缀分配引用。
IPConfiguration	IP 配置。
IPConfigurationProfile	IP 配置文件子资源。
IpTag	包含与对象关联的 IpTag。
IPVersion	IP 地址版本。
LoadBalancerBackendAddress	负载均衡器后端地址。
LoadBalancerBackendAddressAdminState	一个管理状态列表，一旦设置即可替代运行状况探测，以便负载均衡器始终将新连接转发到后端，或拒绝新连接并重置现有连接。
ManagedServiceIdentity	资源的标识。
NatGateway	Nat 网关资源。
NatGatewaySku	NAT 网关的 SKU。
NatGatewaySkuName	Nat 网关 SKU 的名称。
NatRulePortMapping	为后端池创建的入站 NAT 规则的单个端口映射。
NetworkInterface	资源组中的网络接口。
NetworkInterfaceAuxiliaryMode	网络接口资源的辅助模式。
NetworkInterfaceAuxiliarySku	网络接口资源的辅助 SKU。
NetworkInterfaceDnsSettings	网络接口的 DNS 设置。
NetworkInterfaceIPConfiguration	网络接口中的 IPConfiguration。
NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties	网络接口的 PrivateLinkConnection 属性。
NetworkInterfaceMigrationPhase	网络接口资源的迁移阶段。
NetworkInterfaceNicType	网络接口资源的类型。
NetworkInterfaceTapConfiguration	点击网络接口中的配置。
NetworkSecurityGroup	NetworkSecurityGroup 资源。
PrivateEndpoint	专用终结点资源。
PrivateEndpointConnection	PrivateEndpointConnection 资源。
PrivateEndpointIPConfiguration	专用终结点的 IP 配置。
PrivateLinkService	专用链接服务资源。
PrivateLinkServiceConnection	PrivateLinkServiceConnection 资源。
PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
PrivateLinkServiceIpConfiguration	专用链接服务 IP 配置。
ProvisioningState	当前预配状态。
PublicIPAddress	公共 IP 地址资源。
PublicIPAddressDnsSettings	包含与公共 IP 地址关联的 DNS 记录的 FQDN。
PublicIpAddressDnsSettingsDomainNameLabelScope	域名标签范围。如果指定了域名标签和域名标签范围，则会为 Microsoft Azure DNS 系统中的公共 IP 创建一条 DNS 记录，其中包含 FQDN 中的哈希值。
PublicIPAddressMigrationPhase	公共 IP 地址的迁移阶段。
PublicIPAddressSku	公共 IP 地址的 SKU。
PublicIPAddressSkuName	公共 IP 地址 SKU 的名称。
PublicIPAddressSkuTier	公共 IP 地址 SKU 的层。
ResourceIdentityType	用于资源的标识类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将从虚拟机中删除任何标识。
ResourceNavigationLink	ResourceNavigationLink 资源。
RetentionPolicyParameters	定义流日志保留策略的参数。
Route	路由资源。
RouteNextHopType	应将数据包发送到的 Azure 跃点的类型。
RouteTable	路由表资源。
SecurityRule	网络安全规则。
SecurityRuleAccess	是允许还是拒绝网络流量。
SecurityRuleDirection	规则的方向。该方向指定在传入或传出流量上是否评估规则。
SecurityRuleProtocol	此规则适用于的网络协议。
ServiceAssociationLink	ServiceAssociationLink 资源。
ServiceEndpointPolicy	服务终结点策略资源。
ServiceEndpointPolicyDefinition	服务终结点策略定义。
ServiceEndpointPropertiesFormat	服务终结点属性。
SharingScope	将此属性设置为“租户”，以允许与 AAD 租户中的其他订阅共享子网。仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性，仅当子网为空时，才能设置这两个属性。
Subnet	虚拟网络资源中的子网。
SubResource	对另一个子资源的引用。
SyncMode	后端池的后端地址同步模式
TrafficAnalyticsConfigurationProperties	定义流量分析配置的参数。
TrafficAnalyticsProperties	定义流量分析配置的参数。
TransportProtocol	终结点的传输协议。
UserAssignedIdentities	与资源关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
VirtualNetworkPrivateEndpointNetworkPolicies	在子网中的专用终结点上启用或禁用应用网络策略。
VirtualNetworkPrivateLinkServiceNetworkPolicies	在子网中的专用链接服务上启用或禁用应用网络策略。
VirtualNetworkTap	虚拟网络点击资源。
Visibility	专用链接服务的可见性列表。

ApplicationGatewayBackendAddress

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

名称	类型	说明
fqdn	string	完全限定的域名（FQDN）。
ipAddress	string	IP地址。

ApplicationGatewayBackendAddressPool

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的后端地址池的名称。
properties.backendAddresses	ApplicationGatewayBackendAddress[]	后端地址。
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	对网络接口中定义的 IP 的引用集合。
properties.provisioningState	ProvisioningState	后端地址池资源的预配状态。
type	string	资源的类型。

ApplicationGatewayIPConfiguration

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	应用程序网关中唯一的 IP 配置的名称。
properties.provisioningState	ProvisioningState	应用程序网关 IP 配置资源的预配状态。
properties.subnet	SubResource	对子网资源的引用。应用程序网关从中获取其专用地址的子网。
type	string	资源的类型。

ApplicationSecurityGroup

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.provisioningState	ProvisioningState	应用程序安全组资源的预配状态。
properties.resourceGuid	string	应用程序安全组资源的资源 GUID 属性。它唯一标识资源，即使用户更改了其名称或跨订阅或资源组迁移资源。
tags	object	资源标记。
type	string	资源类型。

AutoApproval

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

名称	类型	说明
subscriptions	string[]	订阅列表。

BackendAddressPool

后端 IP 地址池。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	负载均衡器使用的后端地址池集中唯一的资源的名称。此名称可用于访问资源。
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	对网络接口中定义的 IP 地址的引用数组。
properties.drainPeriodInSeconds	integer	将 RESET 发送到客户端和后端地址之前，负载均衡器等待的秒数。
properties.inboundNatRules	SubResource[]	对使用此后端地址池的入站 NAT 规则的引用数组。
properties.loadBalancerBackendAddresses	LoadBalancerBackendAddress[]	后端地址数组。
properties.loadBalancingRules	SubResource[]	对使用此后端地址池的负载均衡规则的引用数组。
properties.location	string	后端地址池的位置。
properties.outboundRule	SubResource	对使用此后端地址池的出站规则的引用。
properties.outboundRules	SubResource[]	对使用此后端地址池的出站规则的引用数组。
properties.provisioningState	ProvisioningState	后端地址池资源的预配状态。
properties.syncMode	SyncMode	后端池的后端地址同步模式
properties.tunnelInterfaces	GatewayLoadBalancerTunnelInterface[]	网关负载均衡器隧道接口的数组。
properties.virtualNetwork	SubResource	对虚拟网络的引用。
type	string	资源的类型。

CustomDnsConfigPropertiesFormat

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

名称	类型	说明
fqdn	string	解析为专用终结点 IP 地址的 Fqdn。
ipAddresses	string[]	专用终结点的专用 IP 地址列表。

DdosSettings

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

名称	类型	说明
ddosProtectionPlan	SubResource	与公共 IP 关联的 DDoS 保护计划。仅当 ProtectionMode 已启用时才能设置
protectionMode	DdosSettingsProtectionMode	公共 IP 的 DDoS 保护模式

DdosSettingsProtectionMode

公共 IP 的 DDoS 保护模式

名称	类型	说明
Disabled	string
Enabled	string
VirtualNetworkInherited	string

Delegation

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	子网中唯一的资源的名称。此名称可用于访问资源。
properties.actions	string[]	委派后允许对服务执行的操作。
properties.provisioningState	ProvisioningState	服务委派资源的预配状态。
properties.serviceName	string	应向其委托子网的服务的名称（例如Microsoft.Sql/servers）。
type	string	资源类型。

DeleteOptions

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

名称	类型	说明
Delete	string
Detach	string

Error

常见的错误表示形式。

名称	类型	说明
code	string	错误代码。
details	ErrorDetails[]	错误详细信息。
innerError	string	内部错误消息。
message	string	错误信息。
target	string	错误目标。

ErrorDetails

常见的错误详细信息表示形式。

名称	类型	说明
code	string	错误代码。
message	string	错误信息。
target	string	错误目标。

ExtendedLocation

ExtendedLocation 复杂类型。

名称	类型	说明
name	string	扩展位置的名称。
type	ExtendedLocationTypes	扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

名称	类型	说明
EdgeZone	string

FlowLog

流日志资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
identity	ManagedServiceIdentity	FlowLog 资源托管标识
location	string	资源位置。
name	string	资源名称。
properties.enabled	boolean	用于启用/禁用流日志记录的标志。
properties.enabledFilteringCriteria	string	可选字段，用于根据 SrcIP、SrcPort、DstIP、DstPort、协议、加密、方向和操作筛选网络流量日志。如果未指定，将记录所有网络流量。
properties.flowAnalyticsConfiguration	TrafficAnalyticsProperties	定义流量分析配置的参数。
properties.format	FlowLogFormatParameters	定义流日志格式的参数。
properties.provisioningState	ProvisioningState	流日志的预配状态。
properties.retentionPolicy	RetentionPolicyParameters	定义流日志保留策略的参数。
properties.storageId	string	用于存储流日志的存储帐户的 ID。
properties.targetResourceGuid	string	将向其应用流日志的网络安全组的 Guid。
properties.targetResourceId	string	将向其应用流日志的网络安全组的 ID。
tags	object	资源标记。
type	string	资源类型。

FlowLogFormatParameters

定义流日志格式的参数。

名称	类型	默认值	说明
type	FlowLogFormatType		流日志的文件类型。
version	integer	0	流日志的版本（修订版）。

FlowLogFormatType

流日志的文件类型。

名称	类型	说明
JSON	string

FrontendIPConfiguration

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

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	负载均衡器使用的前端 IP 配置集中唯一的资源的名称。此名称可用于访问资源。
properties.gatewayLoadBalancer	SubResource	对网关负载均衡器前端 IP 的引用。
properties.inboundNatPools	SubResource[]	对使用此前端 IP 的入站池的引用数组。
properties.inboundNatRules	SubResource[]	对使用此前端 IP 的入站规则的引用数组。
properties.loadBalancingRules	SubResource[]	对使用此前端 IP 的负载均衡规则的引用数组。
properties.outboundRules	SubResource[]	对使用此前端 IP 的出站规则的引用数组。
properties.privateIPAddress	string	IP 配置的专用 IP 地址。
properties.privateIPAddressVersion	IPVersion	特定 ipconfiguration 是 IPv4 还是 IPv6。默认值被视为 IPv4。
properties.privateIPAllocationMethod	IPAllocationMethod	专用 IP 分配方法。
properties.provisioningState	ProvisioningState	前端 IP 配置资源的预配状态。
properties.publicIPAddress	PublicIPAddress	对公共 IP 资源的引用。
properties.publicIPPrefix	SubResource	对公共 IP 前缀资源的引用。
properties.subnet	Subnet	对子网资源的引用。
type	string	资源的类型。
zones	string[]	表示为资源分配的 IP 需要来自的可用性区域列表。

GatewayLoadBalancerTunnelInterface

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

名称	类型	说明
identifier	integer	网关负载均衡器隧道接口的标识符。
port	integer	网关负载均衡器隧道接口的端口。
protocol	GatewayLoadBalancerTunnelProtocol	网关负载均衡器隧道接口的协议。
type	GatewayLoadBalancerTunnelInterfaceType	网关负载均衡器隧道接口的流量类型。

GatewayLoadBalancerTunnelInterfaceType

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

名称	类型	说明
External	string
Internal	string
None	string

GatewayLoadBalancerTunnelProtocol

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

名称	类型	说明
Native	string
None	string
VXLAN	string

InboundNatRule

负载均衡器的入站 NAT 规则。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	负载均衡器使用的入站 NAT 规则集中唯一的资源的名称。此名称可用于访问资源。
properties.backendAddressPool	SubResource	对 backendAddressPool 资源的引用。
properties.backendIPConfiguration	NetworkInterfaceIPConfiguration	对 VM 网络接口上定义的专用 IP 地址的引用。发送到每个前端 IP 配置的前端端口的流量将转发到后端 IP。
properties.backendPort	integer	用于内部终结点的端口。可接受的值范围为 1 到 65535。
properties.enableFloatingIP	boolean	为配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能配置虚拟机的终结点。在 SQL Server 中使用 SQL AlwaysOn 可用性组时，需要此设置。创建终结点后，无法更改此设置。
properties.enableTcpReset	boolean	在 TCP 流空闲超时或意外的连接终止时接收双向 TCP 重置。仅当协议设置为 TCP 时，才使用此元素。
properties.frontendIPConfiguration	SubResource	对前端 IP 地址的引用。
properties.frontendPort	integer	外部终结点的端口。每个规则的端口号在负载均衡器中必须是唯一的。可接受的值范围为 1 到 65534。
properties.frontendPortRangeEnd	integer	外部终结点的端口范围结束。此属性与 BackendAddressPool 和 FrontendPortRangeStart 一起使用。将为 BackendAddressPool 中的每个后端地址创建单个入站 NAT 规则端口映射。可接受的值范围为 1 到 65534。
properties.frontendPortRangeStart	integer	端口范围从外部终结点开始。此属性与 BackendAddressPool 和 FrontendPortRangeEnd 一起使用。将为 BackendAddressPool 中的每个后端地址创建单个入站 NAT 规则端口映射。可接受的值范围为 1 到 65534。
properties.idleTimeoutInMinutes	integer	TCP 空闲连接的超时。该值可以设置为 4 到 30 分钟。默认值为 4 分钟。仅当协议设置为 TCP 时，才使用此元素。
properties.protocol	TransportProtocol	对负载均衡规则使用的传输协议的引用。
properties.provisioningState	ProvisioningState	入站 NAT 规则资源的预配状态。
type	string	资源的类型。

IPAllocationMethod

IP 地址分配方法。

名称	类型	说明
Dynamic	string
Static	string

IpamPoolPrefixAllocation

IpamPool 前缀分配引用。

名称	类型	说明
allocatedAddressPrefixes	string[]	关联资源的 IpamPool 中分配的 IP 地址前缀列表。
numberOfIpAddresses	string	要分配的 IP 地址数。
pool.id	string	关联的 Azure IpamPool 资源的资源 ID。

IPConfiguration

IP 配置。

名称	类型	默认值	说明
etag	string		一个唯一的只读字符串，每当更新资源时更改。
id	string		资源 ID。
name	string		资源组中唯一的资源的名称。此名称可用于访问资源。
properties.privateIPAddress	string		IP 配置的专用 IP 地址。
properties.privateIPAllocationMethod	IPAllocationMethod	Dynamic	专用 IP 地址分配方法。
properties.provisioningState	ProvisioningState		IP 配置资源的预配状态。
properties.publicIPAddress	PublicIPAddress		对公共 IP 资源的引用。
properties.subnet	Subnet		对子网资源的引用。

IPConfigurationProfile

IP 配置文件子资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源的名称。此名称可用于访问资源。
properties.provisioningState	ProvisioningState	IP 配置文件资源的预配状态。
properties.subnet	Subnet	对用于创建容器网络接口 IP 配置的子网资源的引用。
type	string	子资源类型。

IpTag

包含与对象关联的 IpTag。

名称	类型	说明
ipTagType	string	IP 标记类型。示例：FirstPartyUsage。
tag	string	与公共 IP 关联的 IP 标记的值。示例：SQL。

IPVersion

IP 地址版本。

名称	类型	说明
IPv4	string
IPv6	string

LoadBalancerBackendAddress

负载均衡器后端地址。

名称	类型	说明
name	string	后端地址的名称。
properties.adminState	LoadBalancerBackendAddressAdminState	一个管理状态列表，一旦设置即可替代运行状况探测，以便负载均衡器始终将新连接转发到后端，或拒绝新连接并重置现有连接。
properties.inboundNatRulesPortMapping	NatRulePortMapping[]	入站 NAT 规则端口映射的集合。
properties.ipAddress	string	属于所引用虚拟网络的 IP 地址。
properties.loadBalancerFrontendIPConfiguration	SubResource	对区域负载均衡器中定义的前端 IP 地址配置的引用。
properties.networkInterfaceIPConfiguration	SubResource	对网络接口中定义的 IP 地址的引用。
properties.subnet	SubResource	对现有子网的引用。
properties.virtualNetwork	SubResource	对现有虚拟网络的引用。

LoadBalancerBackendAddressAdminState

一个管理状态列表，一旦设置即可替代运行状况探测，以便负载均衡器始终将新连接转发到后端，或拒绝新连接并重置现有连接。

名称	类型	说明
Down	string
None	string
Up	string

ManagedServiceIdentity

资源的标识。

名称	类型	说明
principalId	string	系统分配标识的主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string	系统分配标识的租户 ID。此属性仅针对系统分配的标识提供。
type	ResourceIdentityType	用于资源的标识类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将从虚拟机中删除任何标识。
userAssignedIdentities	UserAssignedIdentities	与资源关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

NatGateway

Nat 网关资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.idleTimeoutInMinutes	integer	nat 网关的空闲超时。
properties.provisioningState	ProvisioningState	NAT 网关资源的预配状态。
properties.publicIpAddresses	SubResource[]	与 nat 网关资源关联的公共 IP 地址数组。
properties.publicIpPrefixes	SubResource[]	与 nat 网关资源关联的公共 IP 前缀数组。
properties.resourceGuid	string	NAT 网关资源的资源 GUID 属性。
properties.subnets	SubResource[]	使用此 nat 网关资源引用子网的数组。
sku	NatGatewaySku	nat 网关 SKU。
tags	object	资源标记。
type	string	资源类型。
zones	string[]	表示应在其中部署 Nat 网关的区域的可用性区域的列表。

NatGatewaySku

NAT 网关的 SKU。

名称	类型	说明
name	NatGatewaySkuName	Nat 网关 SKU 的名称。

NatGatewaySkuName

Nat 网关 SKU 的名称。

名称	类型	说明
Standard	string

NatRulePortMapping

为后端池创建的入站 NAT 规则的单个端口映射。

名称	类型	说明
backendPort	integer	后端端口。
frontendPort	integer	前端端口。
inboundNatRuleName	string	入站 NAT 规则的名称。

NetworkInterface

资源组中的网络接口。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
extendedLocation	ExtendedLocation	网络接口的扩展位置。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	网络接口资源的辅助模式。
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	网络接口资源的辅助 SKU。
properties.defaultOutboundConnectivityEnabled	boolean	是否配置了 nic 的默认出站连接。
properties.disableTcpStateTracking	boolean	指示是否禁用 tcp 状态跟踪。
properties.dnsSettings	NetworkInterfaceDnsSettings	网络接口中的 DNS 设置。
properties.dscpConfiguration	SubResource	对网络接口链接到的 dscp 配置的引用。
properties.enableAcceleratedNetworking	boolean	如果将网络接口配置为加速网络。不适用于需要加速网络的 VM 大小。
properties.enableIPForwarding	boolean	指示是否在此网络接口上启用 IP 转发。
properties.hostedWorkloads	string[]	对链接 BareMetal 资源的引用列表。
properties.ipConfigurations	NetworkInterfaceIPConfiguration[]	网络接口的 IPConfiguration 列表。
properties.macAddress	string	网络接口的 MAC 地址。
properties.migrationPhase	NetworkInterfaceMigrationPhase	网络接口资源的迁移阶段。
properties.networkSecurityGroup	NetworkSecurityGroup	对 NetworkSecurityGroup 资源的引用。
properties.nicType	NetworkInterfaceNicType	网络接口资源的类型。
properties.primary	boolean	这是否是虚拟机上的主网络接口。
properties.privateEndpoint	PrivateEndpoint	对网络接口链接到的专用终结点的引用。
properties.privateLinkService	PrivateLinkService	网络接口资源的 Privatelinkservice。
properties.provisioningState	ProvisioningState	网络接口资源的预配状态。
properties.resourceGuid	string	网络接口资源的资源 GUID 属性。
properties.tapConfigurations	NetworkInterfaceTapConfiguration[]	网络接口的 TapConfiguration 列表。
properties.virtualMachine	SubResource	对虚拟机的引用。
properties.vnetEncryptionSupported	boolean	此 nic 是否附加到虚拟机，以支持加密。
properties.workloadType	string	BareMetal 资源的 NetworkInterface 的 WorkloadType
tags	object	资源标记。
type	string	资源类型。

NetworkInterfaceAuxiliaryMode

网络接口资源的辅助模式。

名称	类型	说明
AcceleratedConnections	string
Floating	string
MaxConnections	string
None	string

NetworkInterfaceAuxiliarySku

网络接口资源的辅助 SKU。

名称	类型	说明
A1	string
A2	string
A4	string
A8	string
None	string

NetworkInterfaceDnsSettings

网络接口的 DNS 设置。

名称	类型	说明
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	完全限定的 DNS 名称支持同一虚拟网络中的 VM 之间的内部通信。

NetworkInterfaceIPConfiguration

网络接口中的 IPConfiguration。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.applicationGatewayBackendAddressPools	ApplicationGatewayBackendAddressPool[]	对 ApplicationGatewayBackendAddressPool 资源的引用。
properties.applicationSecurityGroups	ApplicationSecurityGroup[]	包含 IP 配置的应用程序安全组。
properties.gatewayLoadBalancer	SubResource	对网关负载均衡器前端 IP 的引用。
properties.loadBalancerBackendAddressPools	BackendAddressPool[]	对 LoadBalancerBackendAddressPool 资源的引用。
properties.loadBalancerInboundNatRules	InboundNatRule[]	LoadBalancerInboundNatRules 的引用列表。
properties.primary	boolean	这是否是网络接口上的主要客户地址。
properties.privateIPAddress	string	IP 配置的专用 IP 地址。它可以是采用格式的单个 IP 地址或 CIDR 块 /.
properties.privateIPAddressPrefixLength	integer	专用 IP 地址前缀长度。如果指定且分配方法是动态的，则服务将分配 CIDR 块而不是单个 IP 地址。
properties.privateIPAddressVersion	IPVersion	特定 IP 配置是 IPv4 还是 IPv6。默认值为 IPv4。
properties.privateIPAllocationMethod	IPAllocationMethod	专用 IP 地址分配方法。
properties.privateLinkConnectionProperties	NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties	网络接口的 PrivateLinkConnection 属性。
properties.provisioningState	ProvisioningState	网络接口 IP 配置的预配状态。
properties.publicIPAddress	PublicIPAddress	绑定到 IP 配置的公共 IP 地址。
properties.subnet	Subnet	绑定到 IP 配置的子网。
properties.virtualNetworkTaps	VirtualNetworkTap[]	对虚拟网络点击的引用。
type	string	资源类型。

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

网络接口的 PrivateLinkConnection 属性。

名称	类型	说明
fqdns	string[]	当前专用链接连接的 FQDN 列表。
groupId	string	当前专用链接连接的组 ID。
requiredMemberName	string	当前专用链接连接的必需成员名称。

NetworkInterfaceMigrationPhase

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

名称	类型	说明
Abort	string
Commit	string
Committed	string
None	string
Prepare	string

NetworkInterfaceNicType

网络接口资源的类型。

名称	类型	说明
Elastic	string
Standard	string

NetworkInterfaceTapConfiguration

点击网络接口中的配置。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.provisioningState	ProvisioningState	网络接口点击配置资源的预配状态。
properties.virtualNetworkTap	VirtualNetworkTap	对虚拟网络 Tap 资源的引用。
type	string	子资源类型。

NetworkSecurityGroup

NetworkSecurityGroup 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.defaultSecurityRules	SecurityRule[]	网络安全组的默认安全规则。
properties.flowLogs	FlowLog[]	对流日志资源的引用的集合。
properties.flushConnection	boolean	启用后，当规则更新时，将从网络安全组连接创建的流重新评估。初始启用将触发重新评估。
properties.networkInterfaces	NetworkInterface[]	对网络接口的引用的集合。
properties.provisioningState	ProvisioningState	网络安全组资源的预配状态。
properties.resourceGuid	string	网络安全组资源的资源 GUID 属性。
properties.securityRules	SecurityRule[]	网络安全组的安全规则集合。
properties.subnets	Subnet[]	对子网的引用的集合。
tags	object	资源标记。
type	string	资源类型。

PrivateEndpoint

专用终结点资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
extendedLocation	ExtendedLocation	负载均衡器的扩展位置。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.applicationSecurityGroups	ApplicationSecurityGroup[]	包含专用终结点 IP 配置的应用程序安全组。
properties.customDnsConfigs	CustomDnsConfigPropertiesFormat[]	自定义 DNS 配置的数组。
properties.customNetworkInterfaceName	string	附加到专用终结点的网络接口的自定义名称。
properties.ipConfigurations	PrivateEndpointIPConfiguration[]	专用终结点的 IP 配置列表。这将用于映射到第一方服务的终结点。
properties.manualPrivateLinkServiceConnections	PrivateLinkServiceConnection[]	有关与远程资源的连接的信息的分组。当网络管理员无权批准与远程资源的连接时使用。
properties.networkInterfaces	NetworkInterface[]	对此专用终结点创建的网络接口的引用数组。
properties.privateLinkServiceConnections	PrivateLinkServiceConnection[]	有关与远程资源的连接的信息的分组。
properties.provisioningState	ProvisioningState	专用终结点资源的预配状态。
properties.subnet	Subnet	将从中分配专用 IP 的子网的 ID。
tags	object	资源标记。
type	string	资源类型。

PrivateEndpointConnection

PrivateEndpointConnection 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.linkIdentifier	string	使用者链接 ID。
properties.privateEndpoint	PrivateEndpoint	专用终结点的资源。
properties.privateEndpointLocation	string	专用终结点的位置。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
properties.provisioningState	ProvisioningState	专用终结点连接资源的预配状态。
type	string	资源类型。

PrivateEndpointIPConfiguration

专用终结点的 IP 配置。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
name	string	资源组中唯一的资源的名称。
properties.groupId	string	从此专用终结点应连接到的远程资源获取的组的 ID。
properties.memberName	string	从此专用终结点应连接到的远程资源获取的组的成员名称。
properties.privateIPAddress	string	从专用终结点的子网获取的专用 IP 地址。
type	string	资源类型。

PrivateLinkService

专用链接服务资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
extendedLocation	ExtendedLocation	负载均衡器的扩展位置。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.alias	string	专用链接服务的别名。
properties.autoApproval	AutoApproval	专用链接服务的自动审批列表。
properties.destinationIPAddress	string	专用链接服务的目标 IP 地址。
properties.enableProxyProtocol	boolean	是否为代理协议启用了专用链接服务。
properties.fqdns	string[]	Fqdn 的列表。
properties.ipConfigurations	PrivateLinkServiceIpConfiguration[]	专用链接服务 IP 配置的数组。
properties.loadBalancerFrontendIpConfigurations	FrontendIPConfiguration[]	对负载均衡器 IP 配置的引用数组。
properties.networkInterfaces	NetworkInterface[]	对此专用链接服务创建的网络接口的引用数组。
properties.privateEndpointConnections	PrivateEndpointConnection[]	有关与专用终结点的连接的列表数组。
properties.provisioningState	ProvisioningState	专用链接服务资源的预配状态。
properties.visibility	Visibility	专用链接服务的可见性列表。
tags	object	资源标记。
type	string	资源类型。

PrivateLinkServiceConnection

PrivateLinkServiceConnection 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.groupIds	string[]	从此专用终结点应连接到的远程资源获取的组的 ID（s）。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	有关与远程资源的连接状态的只读信息的集合。
properties.privateLinkServiceId	string	专用链接服务的资源 ID。
properties.provisioningState	ProvisioningState	专用链接服务连接资源的预配状态。
properties.requestMessage	string	使用此连接请求传递给远程资源的所有者的消息。限制为 140 个字符。
type	string	资源类型。

PrivateLinkServiceConnectionState

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

名称	类型	说明
actionsRequired	string	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
description	string	批准/拒绝连接的原因。
status	string	指示连接是否已被服务的所有者批准/拒绝/删除。

PrivateLinkServiceIpConfiguration

专用链接服务 IP 配置。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	专用链接服务 IP 配置的名称。
properties.primary	boolean	IP 配置是否为主要配置。
properties.privateIPAddress	string	IP 配置的专用 IP 地址。
properties.privateIPAddressVersion	IPVersion	特定 IP 配置是 IPv4 还是 IPv6。默认值为 IPv4。
properties.privateIPAllocationMethod	IPAllocationMethod	专用 IP 地址分配方法。
properties.provisioningState	ProvisioningState	专用链接服务 IP 配置资源的预配状态。
properties.subnet	Subnet	对子网资源的引用。
type	string	资源类型。

ProvisioningState

当前预配状态。

名称	类型	说明
Deleting	string
Failed	string
Succeeded	string
Updating	string

PublicIPAddress

公共 IP 地址资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
extendedLocation	ExtendedLocation	公共 IP 地址的扩展位置。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.ddosSettings	DdosSettings	与公共 IP 地址关联的 DDoS 保护自定义策略。
properties.deleteOption	DeleteOptions	指定删除 VM 时公共 IP 地址会发生什么情况
properties.dnsSettings	PublicIPAddressDnsSettings	与公共 IP 地址关联的 DNS 记录的 FQDN。
properties.idleTimeoutInMinutes	integer	公共 IP 地址的空闲超时。
properties.ipAddress	string	与公共 IP 地址资源关联的 IP 地址。
properties.ipConfiguration	IPConfiguration	与公共 IP 地址关联的 IP 配置。
properties.ipTags	IpTag[]	与公共 IP 地址关联的标记列表。
properties.linkedPublicIPAddress	PublicIPAddress	公共 IP 地址资源的链接公共 IP 地址。
properties.migrationPhase	PublicIPAddressMigrationPhase	公共 IP 地址的迁移阶段。
properties.natGateway	NatGateway	公共 IP 地址的 NatGateway。
properties.provisioningState	ProvisioningState	公共 IP 地址资源的预配状态。
properties.publicIPAddressVersion	IPVersion	公共 IP 地址版本。
properties.publicIPAllocationMethod	IPAllocationMethod	公共 IP 地址分配方法。
properties.publicIPPrefix	SubResource	应从中分配此公共 IP 地址的公共 IP 前缀。
properties.resourceGuid	string	公共 IP 地址资源的资源 GUID 属性。
properties.servicePublicIPAddress	PublicIPAddress	公共 IP 地址资源的服务公共 IP 地址。
sku	PublicIPAddressSku	公共 IP 地址 SKU。
tags	object	资源标记。
type	string	资源类型。
zones	string[]	表示为资源分配的 IP 需要来自的可用性区域列表。

PublicIPAddressDnsSettings

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

名称	类型	说明
domainNameLabel	string	域名标签。域名标签和区域化 DNS 区域的串联构成了与公共 IP 地址关联的完全限定域名。如果指定了域名标签，则会为 Microsoft Azure DNS 系统中的公共 IP 创建 A DNS 记录。
domainNameLabelScope	PublicIpAddressDnsSettingsDomainNameLabelScope	域名标签范围。如果指定了域名标签和域名标签范围，则会为 Microsoft Azure DNS 系统中的公共 IP 创建一条 DNS 记录，其中包含 FQDN 中的哈希值。
fqdn	string	与公共 IP 关联的 A DNS 记录的完全限定域名。这是 domainNameLabel 和区域化 DNS 区域的串联。
reverseFqdn	string	反向 FQDN。解析为此公共 IP 地址的用户可见完全限定域名。如果指定了 reverseFqdn，则会创建 PTR DNS 记录，该记录从 in-addr.arpa 域中的 IP 地址指向反向 FQDN。

PublicIpAddressDnsSettingsDomainNameLabelScope

域名标签范围。如果指定了域名标签和域名标签范围，则会为 Microsoft Azure DNS 系统中的公共 IP 创建一条 DNS 记录，其中包含 FQDN 中的哈希值。

名称	类型	说明
NoReuse	string
ResourceGroupReuse	string
SubscriptionReuse	string
TenantReuse	string

PublicIPAddressMigrationPhase

公共 IP 地址的迁移阶段。

名称	类型	说明
Abort	string
Commit	string
Committed	string
None	string
Prepare	string

PublicIPAddressSku

公共 IP 地址的 SKU。

名称	类型	说明
name	PublicIPAddressSkuName	公共 IP 地址 SKU 的名称。
tier	PublicIPAddressSkuTier	公共 IP 地址 SKU 的层。

PublicIPAddressSkuName

公共 IP 地址 SKU 的名称。

名称	类型	说明
Basic	string
Standard	string

PublicIPAddressSkuTier

公共 IP 地址 SKU 的层。

名称	类型	说明
Global	string
Regional	string

ResourceIdentityType

用于资源的标识类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将从虚拟机中删除任何标识。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ResourceNavigationLink

ResourceNavigationLink 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源导航链接标识符。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.link	string	链接到外部资源。
properties.linkedResourceType	string	链接资源的资源类型。
properties.provisioningState	ProvisioningState	资源导航链接资源的预配状态。
type	string	资源类型。

RetentionPolicyParameters

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

名称	类型	默认值	说明
days	integer	0	保留流日志记录的天数。
enabled	boolean	False	用于启用/禁用保留的标志。

Route

路由资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.addressPrefix	string	路由应用到的目标 CIDR。
properties.hasBgpOverride	boolean	一个值，该值指示此路由是否替代重叠的 BGP 路由，而不考虑 LPM。
properties.nextHopIpAddress	string	IP 地址数据包应转发到。只有在下一跃点类型为 VirtualAppliance 的路由中才允许下一跃点值。
properties.nextHopType	RouteNextHopType	应将数据包发送到的 Azure 跃点的类型。
properties.provisioningState	ProvisioningState	路由资源的预配状态。
type	string	资源的类型。

RouteNextHopType

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

名称	类型	说明
Internet	string
None	string
VirtualAppliance	string
VirtualNetworkGateway	string
VnetLocal	string

RouteTable

路由表资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.disableBgpRoutePropagation	boolean	是否禁用 BGP 在该路由表上学习的路由。 True 表示禁用。
properties.provisioningState	ProvisioningState	路由表资源的预配状态。
properties.resourceGuid	string	路由表的资源 GUID 属性。
properties.routes	Route[]	路由表中包含的路由的集合。
properties.subnets	Subnet[]	对子网的引用的集合。
tags	object	资源标记。
type	string	资源类型。

SecurityRule

网络安全规则。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.access	SecurityRuleAccess	允许或拒绝网络流量。
properties.description	string	此规则的说明。限制为 140 个字符。
properties.destinationAddressPrefix	string	目标地址前缀。 CIDR 或目标 IP 范围。星号“*”还可用于匹配所有源 IP。也可以使用默认标记，例如“VirtualNetwork”、“AzureLoadBalancer”和“Internet”。
properties.destinationAddressPrefixes	string[]	目标地址前缀。 CIDR 或目标 IP 范围。
properties.destinationApplicationSecurityGroups	ApplicationSecurityGroup[]	指定为目标的应用程序安全组。
properties.destinationPortRange	string	目标端口或范围。介于 0 和 65535 之间的整数或范围。星号“*”也可用于匹配所有端口。
properties.destinationPortRanges	string[]	目标端口范围。
properties.direction	SecurityRuleDirection	规则的方向。该方向指定在传入或传出流量上是否评估规则。
properties.priority	integer	规则的优先级。该值可以介于 100 和 4096 之间。对于集合中的每个规则，优先级编号必须是唯一的。优先级编号越低，规则优先级越高。
properties.protocol	SecurityRuleProtocol	此规则适用于的网络协议。
properties.provisioningState	ProvisioningState	安全规则资源的预配状态。
properties.sourceAddressPrefix	string	CIDR 或源 IP 范围。星号“*”还可用于匹配所有源 IP。也可以使用默认标记，例如“VirtualNetwork”、“AzureLoadBalancer”和“Internet”。如果这是入口规则，则指定网络流量的来源。
properties.sourceAddressPrefixes	string[]	CIDR 或源 IP 范围。
properties.sourceApplicationSecurityGroups	ApplicationSecurityGroup[]	指定为源的应用程序安全组。
properties.sourcePortRange	string	源端口或范围。介于 0 和 65535 之间的整数或范围。星号“*”也可用于匹配所有端口。
properties.sourcePortRanges	string[]	源端口范围。
type	string	资源的类型。

SecurityRuleAccess

是允许还是拒绝网络流量。

名称	类型	说明
Allow	string
Deny	string

SecurityRuleDirection

规则的方向。该方向指定在传入或传出流量上是否评估规则。

名称	类型	说明
Inbound	string
Outbound	string

SecurityRuleProtocol

此规则适用于的网络协议。

名称	类型	说明
*	string
Ah	string
Esp	string
Icmp	string
Tcp	string
Udp	string

ServiceAssociationLink

ServiceAssociationLink 资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.allowDelete	boolean	如果为 true，则可以删除资源。
properties.link	string	链接到外部资源。
properties.linkedResourceType	string	链接资源的资源类型。
properties.locations	string[]	位置列表。
properties.provisioningState	ProvisioningState	服务关联链接资源的预配状态。
type	string	资源类型。

ServiceEndpointPolicy

服务终结点策略资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
kind	string	服务终结点策略的类型。这是用于 Azure 门户体验的元数据。
location	string	资源位置。
name	string	资源名称。
properties.contextualServiceEndpointPolicies	string[]	上下文服务终结点策略的集合。
properties.provisioningState	ProvisioningState	服务终结点策略资源的预配状态。
properties.resourceGuid	string	服务终结点策略资源的资源 GUID 属性。
properties.serviceAlias	string	指示策略是否属于服务的别名
properties.serviceEndpointPolicyDefinitions	ServiceEndpointPolicyDefinition[]	服务终结点策略的服务终结点策略定义的集合。
properties.subnets	Subnet[]	对子网的引用的集合。
tags	object	资源标记。
type	string	资源类型。

ServiceEndpointPolicyDefinition

服务终结点策略定义。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
name	string	资源组中唯一的资源的名称。此名称可用于访问资源。
properties.description	string	此规则的说明。限制为 140 个字符。
properties.provisioningState	ProvisioningState	服务终结点策略定义资源的预配状态。
properties.service	string	服务终结点名称。
properties.serviceResources	string[]	服务资源列表。
type	string	资源的类型。

ServiceEndpointPropertiesFormat

服务终结点属性。

名称	类型	说明
locations	string[]	位置列表。
networkIdentifier	SubResource	SubResource 作为网络标识符。
provisioningState	ProvisioningState	服务终结点资源的预配状态。
service	string	终结点服务的类型。

SharingScope

将此属性设置为“租户”，以允许与 AAD 租户中的其他订阅共享子网。仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性，仅当子网为空时，才能设置这两个属性。

名称	类型	说明
DelegatedServices	string
Tenant	string

Subnet

虚拟网络资源中的子网。

名称	类型	默认值	说明
etag	string		一个唯一的只读字符串，每当更新资源时更改。
id	string		资源 ID。
name	string		资源组中唯一的资源的名称。此名称可用于访问资源。
properties.addressPrefix	string		子网的地址前缀。
properties.addressPrefixes	string[]		子网的地址前缀列表。
properties.applicationGatewayIPConfigurations	ApplicationGatewayIPConfiguration[]		虚拟网络资源的应用程序网关 IP 配置。
properties.defaultOutboundAccess	boolean		将此属性设置为 false，以禁用子网中所有 VM 的默认出站连接。此属性只能在创建子网时设置，并且不能为现有子网更新。
properties.delegations	Delegation[]		对子网上的委派的引用数组。
properties.ipAllocations	SubResource[]		引用此子网的 IpAllocation 数组。
properties.ipConfigurationProfiles	IPConfigurationProfile[]		引用此子网的 IP 配置文件数组。
properties.ipConfigurations	IPConfiguration[]		使用子网引用网络接口 IP 配置的数组。
properties.ipamPoolPrefixAllocations	IpamPoolPrefixAllocation[]		用于分配 IP 地址前缀的 IPAM 池列表。
properties.natGateway	SubResource		与此子网关联的 Nat 网关。
properties.networkSecurityGroup	NetworkSecurityGroup		对 NetworkSecurityGroup 资源的引用。
properties.privateEndpointNetworkPolicies	VirtualNetworkPrivateEndpointNetworkPolicies	Disabled	在子网中的专用终结点上启用或禁用应用网络策略。
properties.privateEndpoints	PrivateEndpoint[]		对专用终结点的引用数组。
properties.privateLinkServiceNetworkPolicies	VirtualNetworkPrivateLinkServiceNetworkPolicies	Enabled	在子网中的专用链接服务上启用或禁用应用网络策略。
properties.provisioningState	ProvisioningState		子网资源的预配状态。
properties.purpose	string		一个只读字符串，用于根据委派和其他用户定义的属性标识此子网的使用意图。
properties.resourceNavigationLinks	ResourceNavigationLink[]		使用子网引用外部资源的数组。
properties.routeTable	RouteTable		对 RouteTable 资源的引用。
properties.serviceAssociationLinks	ServiceAssociationLink[]		对注入此子网的服务的引用数组。
properties.serviceEndpointPolicies	ServiceEndpointPolicy[]		服务终结点策略数组。
properties.serviceEndpoints	ServiceEndpointPropertiesFormat[]		服务终结点数组。
properties.sharingScope	SharingScope		将此属性设置为“租户”，以允许与 AAD 租户中的其他订阅共享子网。仅当 defaultOutboundAccess 设置为 false 时，才能设置此属性，仅当子网为空时，才能设置这两个属性。
type	string		资源类型。

SubResource

对另一个子资源的引用。

名称	类型	说明
id	string	资源 ID。

SyncMode

后端池的后端地址同步模式

名称	类型	说明
Automatic	string
Manual	string

TrafficAnalyticsConfigurationProperties

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

名称	类型	说明
enabled	boolean	用于启用/禁用流量分析的标志。
trafficAnalyticsInterval	integer	以分钟为单位的时间间隔，决定 TA 服务应执行流分析的频率。
workspaceId	string	附加工作区的资源 GUID。
workspaceRegion	string	附加工作区的位置。
workspaceResourceId	string	附加工作区的资源 ID。

TrafficAnalyticsProperties

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

名称	类型	说明
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	定义流量分析配置的参数。

TransportProtocol

终结点的传输协议。

名称	类型	说明
All	string
Tcp	string
Udp	string

UserAssignedIdentities

与资源关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

名称	类型	说明

VirtualNetworkPrivateEndpointNetworkPolicies

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

名称	类型	说明
Disabled	string
Enabled	string
NetworkSecurityGroupEnabled	string
RouteTableEnabled	string

VirtualNetworkPrivateLinkServiceNetworkPolicies

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

名称	类型	说明
Disabled	string
Enabled	string

VirtualNetworkTap

虚拟网络点击资源。

名称	类型	说明
etag	string	一个唯一的只读字符串，每当更新资源时更改。
id	string	资源 ID。
location	string	资源位置。
name	string	资源名称。
properties.destinationLoadBalancerFrontEndIPConfiguration	FrontendIPConfiguration	对内部负载均衡器上将接收点击的专用 IP 地址的引用。
properties.destinationNetworkInterfaceIPConfiguration	NetworkInterfaceIPConfiguration	对将接收点击的收集器 nic 的专用 IP 地址的引用。
properties.destinationPort	integer	将接收点击流量的 VXLAN 目标端口。
properties.networkInterfaceTapConfigurations	NetworkInterfaceTapConfiguration[]	指定需要点击的网络接口 IP 配置的资源 ID 列表。
properties.provisioningState	ProvisioningState	虚拟网络点击资源的预配状态。
properties.resourceGuid	string	虚拟网络点击资源的资源 GUID 属性。
tags	object	资源标记。
type	string	资源类型。

Visibility

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

名称	类型	说明
subscriptions	string[]	订阅列表。

通过

Private Link Services - Update Private Endpoint Connection

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

approve or reject private end point connection for a private link service

示例请求

示例响应

定义

ApplicationGatewayBackendAddress

ApplicationGatewayBackendAddressPool

ApplicationGatewayIPConfiguration

ApplicationSecurityGroup

AutoApproval

BackendAddressPool

CustomDnsConfigPropertiesFormat

DdosSettings

DdosSettingsProtectionMode

Delegation

DeleteOptions

Error

ErrorDetails

ExtendedLocation

ExtendedLocationTypes

FlowLog

FlowLogFormatParameters

FlowLogFormatType

FrontendIPConfiguration

GatewayLoadBalancerTunnelInterface

GatewayLoadBalancerTunnelInterfaceType

GatewayLoadBalancerTunnelProtocol

InboundNatRule

IPAllocationMethod

IpamPoolPrefixAllocation

IPConfiguration

IPConfigurationProfile

IpTag

IPVersion

LoadBalancerBackendAddress

LoadBalancerBackendAddressAdminState

ManagedServiceIdentity

NatGateway

NatGatewaySku

NatGatewaySkuName

NatRulePortMapping

NetworkInterface

NetworkInterfaceAuxiliaryMode

NetworkInterfaceAuxiliarySku

NetworkInterfaceDnsSettings

NetworkInterfaceIPConfiguration

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

NetworkInterfaceMigrationPhase

NetworkInterfaceNicType

NetworkInterfaceTapConfiguration

NetworkSecurityGroup

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointIPConfiguration

PrivateLinkService

PrivateLinkServiceConnection

PrivateLinkServiceConnectionState

PrivateLinkServiceIpConfiguration

ProvisioningState

PublicIPAddress

PublicIPAddressDnsSettings

PublicIpAddressDnsSettingsDomainNameLabelScope

PublicIPAddressMigrationPhase

PublicIPAddressSku

PublicIPAddressSkuName

PublicIPAddressSkuTier

ResourceIdentityType

ResourceNavigationLink

RetentionPolicyParameters

Route

RouteNextHopType

RouteTable