Private Link Services - List By Subscription

Service:

Virtual Networks

API Version:

2023-09-01

取得訂用帳戶中的所有私人鏈接服務。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateLinkServices?api-version=2023-09-01

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	PrivateLinkServiceListResult	要求成功。 作業會傳回 PrivateLinkService 資源的清單。
Other Status Codes	Error	錯誤。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List all private list service

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subId/providers/Microsoft.Network/privateLinkServices?api-version=2023-09-01

Java

/**
 * Samples for PrivateLinkServices List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PrivateLinkServiceListAll.
     * json
     */
    /**
     * Sample code: List all private list service.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllPrivateListService(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getPrivateLinkServices().list(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

Python

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_list_all.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.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PrivateLinkServiceListAll.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

Go

package armnetwork_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PrivateLinkServiceListAll.json
func ExamplePrivateLinkServicesClient_NewListBySubscriptionPager() {
	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)
	}
	pager := clientFactory.NewPrivateLinkServicesClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PrivateLinkServiceListResult = armnetwork.PrivateLinkServiceListResult{
		// 	Value: []*armnetwork.PrivateLinkService{
		// 		{
		// 			Name: to.Ptr("testPls1"),
		// 			Type: to.Ptr("Microsoft.Network/privateLinkServices"),
		// 			ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1"),
		// 			Location: to.Ptr("eastus"),
		// 			Properties: &armnetwork.PrivateLinkServiceProperties{
		// 				Alias: to.Ptr("ContosoService.{guid}.azure.privatelinkservice"),
		// 				AutoApproval: &armnetwork.PrivateLinkServicePropertiesAutoApproval{
		// 					Subscriptions: []*string{
		// 						to.Ptr("subscription1"),
		// 						to.Ptr("subscription2")},
		// 					},
		// 					Fqdns: []*string{
		// 						to.Ptr("fqdn1"),
		// 						to.Ptr("fqdn2"),
		// 						to.Ptr("fqdn3")},
		// 						IPConfigurations: []*armnetwork.PrivateLinkServiceIPConfiguration{
		// 							{
		// 								Name: to.Ptr("fe-lb1"),
		// 								Properties: &armnetwork.PrivateLinkServiceIPConfigurationProperties{
		// 									PrivateIPAddress: to.Ptr("10.0.1.4"),
		// 									PrivateIPAddressVersion: to.Ptr(armnetwork.IPVersionIPv4),
		// 									PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodStatic),
		// 									Subnet: &armnetwork.Subnet{
		// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb1"),
		// 									},
		// 								},
		// 						}},
		// 						LoadBalancerFrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
		// 							{
		// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb1"),
		// 						}},
		// 						NetworkInterfaces: []*armnetwork.Interface{
		// 							{
		// 								ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls1.nic.abcd1234"),
		// 						}},
		// 						PrivateEndpointConnections: []*armnetwork.PrivateEndpointConnection{
		// 							{
		// 								Name: to.Ptr("pec1"),
		// 								Properties: &armnetwork.PrivateEndpointConnectionProperties{
		// 									PrivateEndpoint: &armnetwork.PrivateEndpoint{
		// 										ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe1"),
		// 									},
		// 									PrivateLinkServiceConnectionState: &armnetwork.PrivateLinkServiceConnectionState{
		// 										Description: to.Ptr("approved it for some reason."),
		// 										Status: to.Ptr("Approved"),
		// 									},
		// 								},
		// 						}},
		// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 						Visibility: &armnetwork.PrivateLinkServicePropertiesVisibility{
		// 							Subscriptions: []*string{
		// 								to.Ptr("subscription1"),
		// 								to.Ptr("subscription2"),
		// 								to.Ptr("subscription3")},
		// 							},
		// 						},
		// 					},
		// 					{
		// 						Name: to.Ptr("testPls2"),
		// 						Type: to.Ptr("Microsoft.Network/privateLinkServices"),
		// 						ID: to.Ptr("/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/testPls2"),
		// 						Location: to.Ptr("eastus"),
		// 						Properties: &armnetwork.PrivateLinkServiceProperties{
		// 							Alias: to.Ptr("ContosoService.{guid}.azure.privatelinkservice"),
		// 							AutoApproval: &armnetwork.PrivateLinkServicePropertiesAutoApproval{
		// 								Subscriptions: []*string{
		// 									to.Ptr("subscription1"),
		// 									to.Ptr("subscription2")},
		// 								},
		// 								Fqdns: []*string{
		// 									to.Ptr("fqdn1"),
		// 									to.Ptr("fqdn2")},
		// 									IPConfigurations: []*armnetwork.PrivateLinkServiceIPConfiguration{
		// 										{
		// 											Name: to.Ptr("fe-lb2"),
		// 											Properties: &armnetwork.PrivateLinkServiceIPConfigurationProperties{
		// 												PrivateIPAddress: to.Ptr("10.0.1.5"),
		// 												PrivateIPAddressVersion: to.Ptr(armnetwork.IPVersionIPv4),
		// 												PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodStatic),
		// 												Subnet: &armnetwork.Subnet{
		// 													ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb2"),
		// 												},
		// 											},
		// 									}},
		// 									LoadBalancerFrontendIPConfigurations: []*armnetwork.FrontendIPConfiguration{
		// 										{
		// 											ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb2"),
		// 									}},
		// 									NetworkInterfaces: []*armnetwork.Interface{
		// 										{
		// 											ID: to.Ptr("/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/testPls2.nic.efgh5678"),
		// 									}},
		// 									PrivateEndpointConnections: []*armnetwork.PrivateEndpointConnection{
		// 										{
		// 											Name: to.Ptr("pec1"),
		// 											Properties: &armnetwork.PrivateEndpointConnectionProperties{
		// 												PrivateEndpoint: &armnetwork.PrivateEndpoint{
		// 													ID: to.Ptr("/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/testPe2"),
		// 												},
		// 												PrivateLinkServiceConnectionState: &armnetwork.PrivateLinkServiceConnectionState{
		// 													Description: to.Ptr("approved it for some reason."),
		// 													Status: to.Ptr("Approved"),
		// 												},
		// 											},
		// 									}},
		// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 									Visibility: &armnetwork.PrivateLinkServicePropertiesVisibility{
		// 										Subscriptions: []*string{
		// 											to.Ptr("subscription1"),
		// 											to.Ptr("subscription2")},
		// 										},
		// 									},
		// 							}},
		// 						}
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Gets all private link service in a subscription.
 *
 * @summary Gets all private link service in a subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PrivateLinkServiceListAll.json
 */
async function listAllPrivateListService() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.privateLinkServices.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/PrivateLinkServiceListAll.json
// this example is just showing the usage of "PrivateLinkServices_ListBySubscription" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subId";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (PrivateLinkServiceResource item in subscriptionResource.GetPrivateLinkServicesAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    PrivateLinkServiceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "testPls1",
      "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1",
      "type": "Microsoft.Network/privateLinkServices",
      "location": "eastus",
      "properties": {
        "provisioningState": "Succeeded",
        "visibility": {
          "subscriptions": [
            "subscription1",
            "subscription2",
            "subscription3"
          ]
        },
        "autoApproval": {
          "subscriptions": [
            "subscription1",
            "subscription2"
          ]
        },
        "fqdns": [
          "fqdn1",
          "fqdn2",
          "fqdn3"
        ],
        "alias": "ContosoService.{guid}.azure.privatelinkservice",
        "loadBalancerFrontendIpConfigurations": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb1"
          }
        ],
        "ipConfigurations": [
          {
            "name": "fe-lb1",
            "properties": {
              "privateIPAddress": "10.0.1.4",
              "privateIPAllocationMethod": "Static",
              "privateIPAddressVersion": "IPv4",
              "subnet": {
                "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb1"
              }
            }
          }
        ],
        "privateEndpointConnections": [
          {
            "name": "pec1",
            "properties": {
              "privateEndpoint": {
                "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe1"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "description": "approved it for some reason."
              }
            }
          }
        ],
        "networkInterfaces": [
          {
            "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls1.nic.abcd1234"
          }
        ]
      }
    },
    {
      "name": "testPls2",
      "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/testPls2",
      "type": "Microsoft.Network/privateLinkServices",
      "location": "eastus",
      "properties": {
        "provisioningState": "Succeeded",
        "visibility": {
          "subscriptions": [
            "subscription1",
            "subscription2"
          ]
        },
        "autoApproval": {
          "subscriptions": [
            "subscription1",
            "subscription2"
          ]
        },
        "fqdns": [
          "fqdn1",
          "fqdn2"
        ],
        "alias": "ContosoService.{guid}.azure.privatelinkservice",
        "loadBalancerFrontendIpConfigurations": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb2"
          }
        ],
        "ipConfigurations": [
          {
            "name": "fe-lb2",
            "properties": {
              "privateIPAddress": "10.0.1.5",
              "privateIPAllocationMethod": "Static",
              "privateIPAddressVersion": "IPv4",
              "subnet": {
                "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb2"
              }
            }
          }
        ],
        "privateEndpointConnections": [
          {
            "name": "pec1",
            "properties": {
              "privateEndpoint": {
                "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/testPe2"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "description": "approved it for some reason."
              }
            }
          }
        ],
        "networkInterfaces": [
          {
            "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/testPls2.nic.efgh5678"
          }
        ]
      }
    }
  ]
}

定義

名稱	Description
ApplicationGatewayBackendAddress	應用程式閘道的後端位址。
ApplicationGatewayBackendAddressPool	應用程式閘道的後端位址池。
ApplicationGatewayIPConfiguration	應用程式閘道的IP組態。 目前允許1個公用和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 位址配置方法。
IPConfiguration	IP 組態。
IPConfigurationProfile	IP 組態配置檔子資源。
IpTag	包含與 對象相關聯的 IpTag。
IPVersion	IP 位址版本。
LoadBalancerBackendAddress	負載平衡器後端位址。
LoadBalancerBackendAddressAdminState	系統管理狀態清單，一旦設定即可覆寫健康狀態探查，讓 Load Balancer 一律會將新的連線轉送至後端，或拒絕新的連線並重設現有的連線。
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組態。
PrivateLinkServiceListResult	ListPrivateLinkService API 服務呼叫的回應。
ProvisioningState	目前的布建狀態。
PublicIPAddress	公用IP位址資源。
PublicIPAddressDnsSettings	包含與公用IP位址相關聯的 DNS 記錄 FQDN。
PublicIpAddressDnsSettingsDomainNameLabelScope	功能變數名稱標籤範圍。 如果指定功能變數名稱標籤和功能變數名稱標籤範圍，則會為 Microsoft Azure DNS 系統中的公用 IP 建立 A DNS 記錄，其中包含 FQDN 中的哈希值。
PublicIPAddressMigrationPhase	公用IP位址的移轉階段。
PublicIPAddressSku	公用IP位址的SKU。
PublicIPAddressSkuName	公用IP位址 SKU 的名稱。
PublicIPAddressSkuTier	公用IP位址SKU的階層。
ResourceNavigationLink	ResourceNavigationLink 資源。
RetentionPolicyParameters	定義流量記錄保留原則的參數。
Route	路由資源。
RouteNextHopType	要接收封包的 Azure 躍點的類型。
RouteTable	路由表資源。
SecurityRule	網路安全性規則。
SecurityRuleAccess	是否允許或拒絕網路流量。
SecurityRuleDirection	規則的方向。 此方向指定是否根據連入或連出的流量評估規則。
SecurityRuleProtocol	此規則適用的網路通訊協定。
ServiceAssociationLink	ServiceAssociationLink 資源。
ServiceEndpointPolicy	服務端點原則資源。
ServiceEndpointPolicyDefinition	服務端點原則定義。
ServiceEndpointPropertiesFormat	服務端點屬性。
Subnet	虛擬網路資源中的子網。
SubResource	另一個子資源的參考。
SyncMode	後端集區的後端位址同步模式
TrafficAnalyticsConfigurationProperties	定義使用分析組態的參數。
TrafficAnalyticsProperties	定義使用分析組態的參數。
TransportProtocol	端點的傳輸通訊協定。
VirtualNetworkPrivateEndpointNetworkPolicies	在子網的私人端點上啟用或停用套用網路原則。
VirtualNetworkPrivateLinkServiceNetworkPolicies	在子網中的私人連結服務上啟用或停用套用網路原則。
VirtualNetworkTap	虛擬網路 點選資源。
Visibility	私人連結服務的可見性清單。

ApplicationGatewayBackendAddress

應用程式閘道的後端位址。

名稱	類型	Description
fqdn	string	完整網域名稱 (FQDN)。
ipAddress	string	IP 位址。

ApplicationGatewayBackendAddressPool

應用程式閘道的後端位址池。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	在 應用程式閘道 內唯一的後端位址池名稱。
properties.backendAddresses	ApplicationGatewayBackendAddress[]	後端位址。
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	網路介面中定義的IP參考集合。
properties.provisioningState	ProvisioningState	後端位址池資源的布建狀態。
type	string	資源類型。

ApplicationGatewayIPConfiguration

應用程式閘道的IP組態。 目前允許1個公用和1個私人IP組態。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	應用程式閘道 內唯一的IP組態名稱。
properties.provisioningState	ProvisioningState	應用程式閘道IP組態資源的布建狀態。
properties.subnet	SubResource	子網資源的參考。 應用程式閘道從其中取得其私人位址的子網。
type	string	資源類型。

ApplicationSecurityGroup

資源群組中的應用程式安全組。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
location	string	資源位置。
name	string	資源名稱。
properties.provisioningState	ProvisioningState	應用程式安全組資源的布建狀態。
properties.resourceGuid	string	應用程式安全組資源的資源 GUID 屬性。 它可唯一識別資源，即使使用者變更其名稱，或跨訂用帳戶或資源群組移轉資源也一樣。
tags	object	資源標籤。
type	string	資源類型。

AutoApproval

私人連結服務的自動核准清單。

名稱	類型	Description
subscriptions	string[]	訂用帳戶清單。

BackendAddressPool

後端IP位址的集區。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	負載平衡器所使用之後端位址池集合內唯一的資源名稱。 此名稱可用來存取資源。
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	網路介面中定義之IP位址的參考數位。
properties.drainPeriodInSeconds	integer	Load Balancer 將 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 解析組態。

名稱	類型	Description
fqdn	string	解析為私人端點 IP 位址的 Fqdn。
ipAddresses	string[]	私人端點的私人IP位址清單。

DdosSettings

包含公用IP的 DDoS 保護設定。

名稱	類型	Description
ddosProtectionPlan	SubResource	與公用IP相關聯的 DDoS 保護計劃。 只有在 ProtectionMode 已啟用時，才能設定
protectionMode	DdosSettingsProtectionMode	公用IP的 DDoS 保護模式

DdosSettingsProtectionMode

公用IP的 DDoS 保護模式

名稱	類型	Description
Disabled	string
Enabled	string
VirtualNetworkInherited	string

Delegation

詳細說明要委派子網的服務。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	子網內唯一的資源名稱。 此名稱可用來存取資源。
properties.actions	string[]	委派時允許對服務執行的動作。
properties.provisioningState	ProvisioningState	服務委派資源的布建狀態。
properties.serviceName	string	子網應委派給的服務名稱 (例如 Microsoft.Sql/servers) 。
type	string	資源類型。

DeleteOptions

指定刪除 VM 時，公用 IP 位址會發生什麼情況

名稱	類型	Description
Delete	string
Detach	string

Error

常見的錯誤表示。

名稱	類型	Description
code	string	錯誤碼。
details	ErrorDetails[]	錯誤詳細數據。
innerError	string	內部錯誤訊息。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorDetails

常見的錯誤詳細數據表示。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息。
target	string	錯誤目標。

ExtendedLocation

ExtendedLocation 複雜類型。

名稱	類型	Description
name	string	擴充位置的名稱。
type	ExtendedLocationTypes	擴充位置的類型。

ExtendedLocationTypes

擴充位置的類型。

名稱	類型	Description
EdgeZone	string

FlowLog

流量記錄資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
location	string	資源位置。
name	string	資源名稱。
properties.enabled	boolean	啟用/停用流量記錄的旗標。
properties.flowAnalyticsConfiguration	TrafficAnalyticsProperties	定義使用分析組態的參數。
properties.format	FlowLogFormatParameters	定義流量記錄格式的參數。
properties.provisioningState	ProvisioningState	流量記錄的布建狀態。
properties.retentionPolicy	RetentionPolicyParameters	定義流量記錄保留原則的參數。
properties.storageId	string	用來儲存流量記錄的記憶體帳戶標識碼。
properties.targetResourceGuid	string	將套用流量記錄之網路安全組的 GUID。
properties.targetResourceId	string	將套用流量記錄的網路安全組標識碼。
tags	object	資源標籤。
type	string	資源類型。

FlowLogFormatParameters

定義流量記錄格式的參數。

名稱	類型	預設值	Description
type	FlowLogFormatType		流量記錄檔的文件類型。
version	integer	0	流程記錄) 版本 (修訂。

FlowLogFormatType

流量記錄檔的文件類型。

名稱	類型	Description
JSON	string

FrontendIPConfiguration

負載平衡器的前端IP位址。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
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

負載平衡器後端位址池的閘道關負載平衡器通道介面。

名稱	類型	Description
identifier	integer	閘道連接平衡器通道介面的識別碼。
port	integer	閘道連接平衡器通道介面的埠。
protocol	GatewayLoadBalancerTunnelProtocol	閘道連接平衡器通道介面的通訊協定。
type	GatewayLoadBalancerTunnelInterfaceType	閘道連接平衡器通道介面的流量類型。

GatewayLoadBalancerTunnelInterfaceType

閘道連接平衡器通道介面的流量類型。

名稱	類型	Description
External	string
Internal	string
None	string

GatewayLoadBalancerTunnelProtocol

閘道連接平衡器通道介面的通訊協定。

名稱	類型	Description
Native	string
None	string
VXLAN	string

InboundNatRule

負載平衡器的輸入NAT規則。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
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	外部端點的連接埠。 每個規則的埠號碼在 Load Balancer 內必須是唯一的。 可接受的值範圍從 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 位址配置方法。

名稱	類型	Description
Dynamic	string
Static	string

IPConfiguration

IP 組態。

名稱	類型	預設值	Description
etag	string		每當更新資源時變更的唯一隻讀字串。
id	string		資源識別碼。
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 組態配置檔子資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	資源名稱。 此名稱可用來存取資源。
properties.provisioningState	ProvisioningState	IP 組態配置檔資源的布建狀態。
properties.subnet	Subnet	要建立容器網路介面IP組態之子網資源的參考。
type	string	子資源類型。

IpTag

包含與 對象相關聯的 IpTag。

名稱	類型	Description
ipTagType	string	IP 標籤類型。 範例：FirstPartyUsage。
tag	string	與公用IP相關聯的IP標籤。 範例：SQL。

IPVersion

IP 位址版本。

名稱	類型	Description
IPv4	string
IPv6	string

LoadBalancerBackendAddress

負載平衡器後端位址。

名稱	類型	Description
name	string	後端位址的名稱。
properties.adminState	LoadBalancerBackendAddressAdminState	系統管理狀態清單，一旦設定即可覆寫健康狀態探查，讓 Load Balancer 一律會將新的連線轉送至後端，或拒絕新的連線並重設現有的連線。
properties.inboundNatRulesPortMapping	NatRulePortMapping[]	輸入 NAT 規則埠對應的集合。
properties.ipAddress	string	屬於參考虛擬網路的IP位址。
properties.loadBalancerFrontendIPConfiguration	SubResource	區域負載平衡器中定義的前端IP位址組態參考。
properties.networkInterfaceIPConfiguration	SubResource	網路介面中定義的IP位址參考。
properties.subnet	SubResource	現有子網的參考。
properties.virtualNetwork	SubResource	現有虛擬網路的參考。

LoadBalancerBackendAddressAdminState

系統管理狀態清單，一旦設定即可覆寫健康狀態探查，讓 Load Balancer 一律會將新的連線轉送至後端，或拒絕新的連線並重設現有的連線。

名稱	類型	Description
Down	string
None	string
Up	string

NatGateway

Nat 閘道資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
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。

名稱	類型	Description
name	NatGatewaySkuName	Nat 閘道 SKU 的名稱。

NatGatewaySkuName

Nat 閘道 SKU 的名稱。

名稱	類型	Description
Standard	string

NatRulePortMapping

針對針對後端集區所建立之輸入NAT規則的個別埠對應。

名稱	類型	Description
backendPort	integer	後埠。
frontendPort	integer	前埠。
inboundNatRuleName	string	輸入 NAT 規則的名稱。

NetworkInterface

資源群組中的網路介面。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
extendedLocation	ExtendedLocation	網路介面的擴充位置。
id	string	資源識別碼。
location	string	資源位置。
name	string	資源名稱。
properties.auxiliaryMode	NetworkInterfaceAuxiliaryMode	網路介面資源的輔助模式。
properties.auxiliarySku	NetworkInterfaceAuxiliarySku	網路介面資源的輔助 SKU。
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[]	網路介面的IPConfigurations清單。
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[]	網路介面的 TapConfigurations 清單。
properties.virtualMachine	SubResource	虛擬機的參考。
properties.vnetEncryptionSupported	boolean	此 nic 所連結的虛擬機是否支援加密。
properties.workloadType	string	BareMetal 資源的 NetworkInterface WorkloadType
tags	object	資源標籤。
type	string	資源類型。

NetworkInterfaceAuxiliaryMode

網路介面資源的輔助模式。

名稱	類型	Description
AcceleratedConnections	string
Floating	string
MaxConnections	string
None	string

NetworkInterfaceAuxiliarySku

網路介面資源的輔助 SKU。

名稱	類型	Description
A1	string
A2	string
A4	string
A8	string
None	string

NetworkInterfaceDnsSettings

網路介面的 DNS 設定。

名稱	類型	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。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
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位址。
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[]	虛擬網路 Taps 的參考。
type	string	資源類型。

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

網路介面的 PrivateLinkConnection 屬性。

名稱	類型	Description
fqdns	string[]	目前私人連結連線的 FQDN 清單。
groupId	string	目前私人連結連線的群組標識碼。
requiredMemberName	string	目前私人連結連線的必要成員名稱。

NetworkInterfaceMigrationPhase

網路介面資源的移轉階段。

名稱	類型	Description
Abort	string
Commit	string
Committed	string
None	string
Prepare	string

NetworkInterfaceNicType

網路介面資源的類型。

名稱	類型	Description
Elastic	string
Standard	string

NetworkInterfaceTapConfiguration

點選網路介面中的組態。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	資源群組內唯一的資源名稱。 此名稱可用來存取資源。
properties.provisioningState	ProvisioningState	網路介面點選組態資源的布建狀態。
properties.virtualNetworkTap	VirtualNetworkTap	虛擬網路 Tap 資源的參考。
type	string	子資源類型。

NetworkSecurityGroup

NetworkSecurityGroup 資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
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

私人端點資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
extendedLocation	ExtendedLocation	負載平衡器的擴充位置。
id	string	資源識別碼。
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的子網標識碼。
tags	object	資源標籤。
type	string	資源類型。

PrivateEndpointConnection

PrivateEndpointConnection 資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	資源群組內唯一的資源名稱。 此名稱可用來存取資源。
properties.linkIdentifier	string	取用者鏈接識別碼。
properties.privateEndpoint	PrivateEndpoint	私人端點的資源。
properties.privateEndpointLocation	string	私人端點的位置。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
properties.provisioningState	ProvisioningState	私人端點聯機資源的布建狀態。
type	string	資源類型。

PrivateEndpointIPConfiguration

私人端點的IP組態。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
name	string	資源群組內唯一的資源名稱。
properties.groupId	string	從此私人端點應該連線之遠端資源取得的群組標識碼。
properties.memberName	string	從此私人端點應該連線的遠端資源取得之群組的成員名稱。
properties.privateIPAddress	string	從私人端點子網取得的私人IP位址。
type	string	資源類型。

PrivateLinkService

私人鏈接服務資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
extendedLocation	ExtendedLocation	負載平衡器的擴充位置。
id	string	資源識別碼。
location	string	資源位置。
name	string	資源名稱。
properties.alias	string	私人鏈接服務的別名。
properties.autoApproval	AutoApproval	私人連結服務的自動核准清單。
properties.enableProxyProtocol	boolean	是否啟用 Proxy 通訊協定的私人連結服務。
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 資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	資源群組內唯一的資源名稱。 此名稱可用來存取資源。
properties.groupIds	string[]	從此私人端點應該連線的遠端資源取得的群組標識碼 () () 。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	與遠端資源連線狀態相關的唯讀資訊集合。
properties.privateLinkServiceId	string	私人鏈接服務的資源識別碼。
properties.provisioningState	ProvisioningState	私人鏈接服務連線資源的布建狀態。
properties.requestMessage	string	傳遞至具有此連線要求之遠端資源擁有者的訊息。 限制為140個字元。
type	string	資源類型。

PrivateLinkServiceConnectionState

服務取用者與提供者之間連線狀態的相關信息集合。

名稱	類型	Description
actionsRequired	string	訊息，指出服務提供者上的變更是否需要在取用者上進行任何更新。
description	string	連接核准/拒絕的原因。
status	string	指出服務擁有者是否已核准/拒絕/移除連線。

PrivateLinkServiceIpConfiguration

私人鏈接服務IP組態。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
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	資源類型。

PrivateLinkServiceListResult

ListPrivateLinkService API 服務呼叫的回應。

名稱	類型	Description
nextLink	string	要取得下一組結果的URL。
value	PrivateLinkService[]	資源群組中的 PrivateLinkService 資源清單。

ProvisioningState

目前的布建狀態。

名稱	類型	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

PublicIPAddress

公用IP位址資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
extendedLocation	ExtendedLocation	公用IP位址的擴充位置。
id	string	資源識別碼。
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。

名稱	類型	Description
domainNameLabel	string	功能變數名稱標籤。 網域名稱標籤和已進行地區設定之 DNS 區域的串連可組成和公用 IP 位址相關聯的完整網域名稱。 如果已指定網域名稱標籤，則會在 Microsoft Azure DNS 系統中為公用 IP 建立 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 建立 A DNS 記錄，其中包含 FQDN 中的哈希值。

名稱	類型	Description
NoReuse	string
ResourceGroupReuse	string
SubscriptionReuse	string
TenantReuse	string

PublicIPAddressMigrationPhase

公用IP位址的移轉階段。

名稱	類型	Description
Abort	string
Commit	string
Committed	string
None	string
Prepare	string

PublicIPAddressSku

公用IP位址的SKU。

名稱	類型	Description
name	PublicIPAddressSkuName	公用IP位址 SKU 的名稱。
tier	PublicIPAddressSkuTier	公用IP位址SKU的階層。

PublicIPAddressSkuName

公用IP位址 SKU 的名稱。

名稱	類型	Description
Basic	string
Standard	string

PublicIPAddressSkuTier

公用IP位址SKU的階層。

名稱	類型	Description
Global	string
Regional	string

ResourceNavigationLink

ResourceNavigationLink 資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源瀏覽連結標識碼。
name	string	資源群組內唯一的資源名稱。 此名稱可用來存取資源。
properties.link	string	連結至外部資源。
properties.linkedResourceType	string	鏈接資源的資源類型。
properties.provisioningState	ProvisioningState	資源導覽鏈接資源的布建狀態。
type	string	資源類型。

RetentionPolicyParameters

定義流量記錄保留原則的參數。

名稱	類型	預設值	Description
days	integer	0	保留流量記錄檔記錄的天數。
enabled	boolean	False	啟用/停用保留的旗標。

Route

路由資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	資源群組內唯一的資源名稱。 此名稱可用來存取資源。
properties.addressPrefix	string	路由套用的目標 CIDR。
properties.hasBgpOverride	boolean	值，指出不論 LPM 為何，此路由是否覆寫重疊的 BGP 路由。
properties.nextHopIpAddress	string	IP 位址封包應轉送至 。 只有在下一個躍點類型為 VirtualAppliance 的路由中，才允許下一個躍點值。
properties.nextHopType	RouteNextHopType	要接收封包的 Azure 躍點的類型。
properties.provisioningState	ProvisioningState	路由資源的布建狀態。
type	string	資源類型。

RouteNextHopType

要接收封包的 Azure 躍點的類型。

名稱	類型	Description
Internet	string
None	string
VirtualAppliance	string
VirtualNetworkGateway	string
VnetLocal	string

RouteTable

路由表資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
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

網路安全性規則。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
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

是否允許或拒絕網路流量。

名稱	類型	Description
Allow	string
Deny	string

SecurityRuleDirection

規則的方向。 此方向指定是否根據連入或連出的流量評估規則。

名稱	類型	Description
Inbound	string
Outbound	string

SecurityRuleProtocol

此規則適用的網路通訊協定。

名稱	類型	Description
*	string
Ah	string
Esp	string
Icmp	string
Tcp	string
Udp	string

ServiceAssociationLink

ServiceAssociationLink 資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	資源群組內唯一的資源名稱。 此名稱可用來存取資源。
properties.allowDelete	boolean	如果為 true，則可以刪除資源。
properties.link	string	連結至外部資源。
properties.linkedResourceType	string	鏈接資源的資源類型。
properties.locations	string[]	位置清單。
properties.provisioningState	ProvisioningState	服務關聯鏈接資源的布建狀態。
type	string	資源類型。

ServiceEndpointPolicy

服務端點原則資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
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

服務端點原則定義。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
name	string	資源群組內唯一的資源名稱。 此名稱可用來存取資源。
properties.description	string	此規則的說明。 限制為140個字元。
properties.provisioningState	ProvisioningState	服務端點原則定義資源的布建狀態。
properties.service	string	服務端點名稱。
properties.serviceResources	string[]	服務資源清單。
type	string	資源類型。

ServiceEndpointPropertiesFormat

服務端點屬性。

名稱	類型	Description
locations	string[]	位置清單。
provisioningState	ProvisioningState	服務端點資源的布建狀態。
service	string	端點服務的型別。

Subnet

虛擬網路資源中的子網。

名稱	類型	預設值	Description
etag	string		每當更新資源時變更的唯一隻讀字串。
id	string		資源識別碼。
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.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[]		服務端點的陣列。
type	string		資源類型。

SubResource

另一個子資源的參考。

名稱	類型	Description
id	string	資源識別碼。

SyncMode

後端集區的後端位址同步模式

名稱	類型	Description
Automatic	string
Manual	string

TrafficAnalyticsConfigurationProperties

定義使用分析組態的參數。

名稱	類型	Description
enabled	boolean	啟用/停用使用分析的旗標。
trafficAnalyticsInterval	integer	以分鐘為單位的間隔，決定TA服務應該執行流程分析的頻率。
workspaceId	string	附加工作區的資源 GUID。
workspaceRegion	string	附加工作區的位置。
workspaceResourceId	string	連結工作區的資源標識碼。

TrafficAnalyticsProperties

定義使用分析組態的參數。

名稱	類型	Description
networkWatcherFlowAnalyticsConfiguration	TrafficAnalyticsConfigurationProperties	定義使用分析組態的參數。

TransportProtocol

端點的傳輸通訊協定。

名稱	類型	Description
All	string
Tcp	string
Udp	string

VirtualNetworkPrivateEndpointNetworkPolicies

在子網的私人端點上啟用或停用套用網路原則。

名稱	類型	Description
Disabled	string
Enabled	string
NetworkSecurityGroupEnabled	string
RouteTableEnabled	string

VirtualNetworkPrivateLinkServiceNetworkPolicies

在子網中的私人連結服務上啟用或停用套用網路原則。

名稱	類型	Description
Disabled	string
Enabled	string

VirtualNetworkTap

虛擬網路 點選資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源識別碼。
location	string	資源位置。
name	string	資源名稱。
properties.destinationLoadBalancerFrontEndIPConfiguration	FrontendIPConfiguration	內部 Load Balancer 上將接收點選的私人IP地址參考。
properties.destinationNetworkInterfaceIPConfiguration	NetworkInterfaceIPConfiguration	將接收點選之收集器 nic 私人 IP 位址的參考。
properties.destinationPort	integer	將接收點選流量的 VXLAN 目的地埠。
properties.networkInterfaceTapConfigurations	NetworkInterfaceTapConfiguration[]	指定需要點選之網路介面IP組態的資源標識碼清單。
properties.provisioningState	ProvisioningState	虛擬網路點選資源的布建狀態。
properties.resourceGuid	string	虛擬網路的資源 GUID 屬性點選資源。
tags	object	資源標籤。
type	string	資源類型。

Visibility

私人連結服務的可見性清單。

名稱	類型	Description
subscriptions	string[]	訂用帳戶清單。