Application Gateways - Backend Health

服務:: Application Gateway

API 版本:: 2025-03-01

取得資源群組中指定應用程式閘道的後端健康情況。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth?api-version=2025-03-01

含選擇性參數:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth?api-version=2025-03-01&$expand={$expand}

URI 參數

名稱	位於	必要	類型	Description
applicationGatewayName	path	True	string	應用程式閘道的名稱。
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。
$expand	query		string	展開後端健全狀況中所參考的 BackendAddressPool 和 BackendHttpSettings。

回應

名稱	類型	Description
200 OK	ApplicationGatewayBackendHealth	請求成功。
202 Accepted		已接受，作業將以非同步方式完成。
Other Status Codes	CloudError	說明作業為何失敗的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

範例

Get Backend Health

範例要求

POST https://management.azure.com/subscriptions/subid/resourceGroups/appgw/providers/Microsoft.Network/applicationGateways/appgw/backendhealth?api-version=2025-03-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python application_gateway_backend_health_get.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.application_gateways.begin_backend_health(
        resource_group_name="appgw",
        application_gateway_name="appgw",
    ).result()
    print(response)


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

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

/**
 * This sample demonstrates how to Gets the backend health of the specified application gateway in a resource group.
 *
 * @summary Gets the backend health of the specified application gateway in a resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayBackendHealthGet.json
 */
async function getBackendHealth() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "appgw";
  const applicationGatewayName = "appgw";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.applicationGateways.beginBackendHealthAndWait(
    resourceGroupName,
    applicationGatewayName,
  );
  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

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

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayBackendHealthGet.json
// this example is just showing the usage of "ApplicationGateways_BackendHealth" 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 ApplicationGatewayResource created on azure
// for more information of creating ApplicationGatewayResource, please refer to the document of ApplicationGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "appgw";
string applicationGatewayName = "appgw";
ResourceIdentifier applicationGatewayResourceId = ApplicationGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, applicationGatewayName);
ApplicationGatewayResource applicationGateway = client.GetApplicationGatewayResource(applicationGatewayResourceId);

// invoke the operation
ArmOperation<ApplicationGatewayBackendHealth> lro = await applicationGateway.BackendHealthAsync(WaitUntil.Completed);
ApplicationGatewayBackendHealth result = lro.Value;

Console.WriteLine($"Succeeded: {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

{
  "backendAddressPools": [
    {
      "backendAddressPool": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool"
      },
      "backendHttpSettingsCollection": [
        {
          "backendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings"
          },
          "servers": [
            {
              "address": "10.220.1.8",
              "health": "Up"
            }
          ]
        }
      ]
    },
    {
      "backendAddressPool": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFPool"
      },
      "backendHttpSettingsCollection": [
        {
          "backendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings"
          },
          "servers": [
            {
              "address": "10.220.1.4",
              "health": "Up"
            },
            {
              "address": "10.220.1.5",
              "health": "Up"
            }
          ]
        }
      ]
    }
  ]
}

狀態碼:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01

定義

名稱	Description
AccessMode	私人連結服務的存取模式。
ApplicationGatewayBackendAddress	應用程式閘道的後端位址。
ApplicationGatewayBackendAddressPool	應用程式閘道的後端位址池。
ApplicationGatewayBackendHealth	ApplicationGatewayBackendHealth API 服務呼叫的回應。
ApplicationGatewayBackendHealthHttpSettings	應用程式閘道 BackendHealthHttp 設定。
ApplicationGatewayBackendHealthPool	應用程式閘道 BackendHealth 集區。
ApplicationGatewayBackendHealthServer	應用程式網關 backendhealth http 設定。
ApplicationGatewayBackendHealthServerHealth	後端伺服器的健康情況。
ApplicationGatewayBackendHttpSettings	應用程式閘道的後端位址池設定。
ApplicationGatewayConnectionDraining	線上清空可讓後端伺服器的開啟連線在後端伺服器從組態中移除之後，於指定時間內處於作用中狀態。
ApplicationGatewayCookieBasedAffinity	以 Cookie 為基礎的親和性。
ApplicationGatewayIPConfiguration	應用程式閘道的IP組態。目前允許1個公用和1個私人IP組態。
ApplicationGatewayProtocol	應用程式閘道通訊協定。
ApplicationSecurityGroup	資源群組中的應用程式安全組。
AutoApproval	私人連結服務的自動核准清單。
BackendAddressPool	後端IP位址的集區。
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
CustomDnsConfigPropertiesFormat	包含來自客戶的自定義 Dns 解析組態。
DdosSettings	包含公用IP的 DDoS 保護設定。
DdosSettingsProtectionMode	公用IP的 DDoS 保護模式
Delegation	詳細說明要委派子網的服務。
DeleteOptions	指定刪除 VM 時，公用 IP 位址會發生什麼事
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	一旦設定后，系統管理狀態清單可以覆寫健康狀態探查，讓Load Balancer 一律會將新的連線轉送至後端，或拒絕新的連線並重設現有的連線。
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組態。
PrivateEndpointIPVersionType	指定私有端點私有 IP 的 IP 版本類型。如果沒有定義，這會預設為 IPv4。
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	將此屬性設定為 Tenant，以允許與 AAD 租使用者中的其他訂用帳戶共用子網。只有當 defaultOutboundAccess 設定為 false 時，才能設定此屬性，只有在子網是空的時，才能設定這兩個屬性。
Subnet	虛擬網路資源中的子網。
SubResource	另一個子資源的參考。
SyncMode	後端集區的後端位址同步模式
TrafficAnalyticsConfigurationProperties	定義使用分析組態的參數。
TrafficAnalyticsProperties	定義使用分析組態的參數。
TransportProtocol	端點的傳輸通訊協定。
UserAssignedIdentities	與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
VirtualNetworkPrivateEndpointNetworkPolicies	在子網的私人端點上啟用或停用套用網路原則。
VirtualNetworkPrivateLinkServiceNetworkPolicies	在子網中的私人連結服務上啟用或停用套用網路原則。
VirtualNetworkTap	虛擬網路點選資源。
Visibility	私人連結服務的可見度清單。

AccessMode

列舉型別

私人連結服務的存取模式。

值	Description
Default	允許不受限制地存取私人連結服務。
Restricted	限制對僅在可見性清單內的訂閱的存取。

ApplicationGatewayBackendAddress

Object

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

名稱	類型	Description
fqdn	string	完全合格的網域名稱 (FQDN)。
ipAddress	string	IP位址。

ApplicationGatewayBackendAddressPool

Object

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

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

ApplicationGatewayBackendHealth

Object

ApplicationGatewayBackendHealth API 服務呼叫的回應。

名稱	類型	Description
backendAddressPools	ApplicationGatewayBackendHealthPool[]	ApplicationGatewayBackendHealthPool 資源的清單。

ApplicationGatewayBackendHealthHttpSettings

Object

應用程式閘道 BackendHealthHttp 設定。

名稱	類型	Description
backendHttpSettings	ApplicationGatewayBackendHttpSettings	ApplicationGatewayBackendHttpSettings 資源的參考。
servers	ApplicationGatewayBackendHealthServer[]	ApplicationGatewayBackendHealthServer 資源清單。

ApplicationGatewayBackendHealthPool

Object

應用程式閘道 BackendHealth 集區。

名稱	類型	Description
backendAddressPool	ApplicationGatewayBackendAddressPool	ApplicationGatewayBackendAddressPool 資源的參考。
backendHttpSettingsCollection	ApplicationGatewayBackendHealthHttpSettings[]	ApplicationGatewayBackendHealthHttpSettings 資源清單。

ApplicationGatewayBackendHealthServer

Object

應用程式網關 backendhealth http 設定。

名稱	類型	Description
address	string	後端伺服器的 IP 位址或 FQDN。
health	ApplicationGatewayBackendHealthServerHealth	後端伺服器的健康情況。
healthProbeLog	string	健康探測記錄。
ipConfiguration	NetworkInterfaceIPConfiguration	參考後端伺服器的 IP 設定。

ApplicationGatewayBackendHealthServerHealth

列舉型別

後端伺服器的健康情況。

值	Description
Unknown
Up
Down
Partial
Draining

ApplicationGatewayBackendHttpSettings

Object

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

名稱	類型	預設值	Description
etag	string		每當更新資源時變更的唯一隻讀字串。
id	string		資源標識碼。
name	string		應用程式閘道內唯一的後端 HTTP 設定名稱。
properties.affinityCookieName	string		要用於同質 Cookie 的 Cookie 名稱。
properties.authenticationCertificates	SubResource[]		應用程式閘道驗證憑證的參考數位。
properties.connectionDraining	ApplicationGatewayConnectionDraining		後端 HTTP 設定資源的連線清空。
properties.cookieBasedAffinity	ApplicationGatewayCookieBasedAffinity		以 Cookie 為基礎的親和性。
properties.dedicatedBackendConnection	boolean		啟用或停用每個後端伺服器的專用連線。預設值設定為 false。
properties.hostName	string		要傳送至後端伺服器的主機標頭。
properties.path	string		路徑，應該作為所有 HTTP 要求的前置詞。 Null 表示不會加上路徑前置詞。預設值為 null。
properties.pickHostNameFromBackendAddress	boolean		是否應該從後端伺服器的主機名中挑選主機標頭。預設值為 False。
properties.port	integer (int32)		後端上的目的地埠。
properties.probe	SubResource		探查應用程式閘道的資源。
properties.probeEnabled	boolean		是否啟用探查。預設值為 False。
properties.protocol	ApplicationGatewayProtocol		用來與後端通訊的通訊協定。
properties.provisioningState	ProvisioningState		後端 HTTP 設定資源的布建狀態。
properties.requestTimeout	integer (int32)		要求以秒為單位的逾時。如果未在 RequestTimeout 內收到回應，應用程式閘道將會失敗要求。可接受的值為 1 秒到 86400 秒。
properties.sniName	string		指定 SNI 值以符合後端憑證的通用名稱。根據預設，應用程式閘道會使用傳入要求的主機標頭作為 SNI。預設值為 null。
properties.trustedRootCertificates	SubResource[]		應用程式閘道受信任跟證書的參考數位。
properties.validateCertChainAndExpiry	boolean	True	驗證或略過後端伺服器上憑證的鏈結和到期驗證。預設值設定為 true。
properties.validateSNI	boolean	True	啟用時，會驗證後端伺服器所提供憑證的「通用名稱」是否符合「伺服器名稱指示（SNI）」值。預設值為 True。
type	string		資源類型。

ApplicationGatewayConnectionDraining

Object

線上清空可讓後端伺服器的開啟連線在後端伺服器從組態中移除之後，於指定時間內處於作用中狀態。

名稱	類型	Description
drainTimeoutInSec	integer (int32) minimum: 1 maximum: 3600 exclusiveMinimum: False exclusiveMaximum: False	線上清空的秒數為作用中。可接受的值為 1 秒到 3600 秒。
enabled	boolean	是否啟用連線清空。

ApplicationGatewayCookieBasedAffinity

列舉型別

以 Cookie 為基礎的親和性。

值	Description
Enabled
Disabled

ApplicationGatewayIPConfiguration

Object

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

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

ApplicationGatewayProtocol

列舉型別

應用程式閘道通訊協定。

值	Description
Http	支援 httpListeners 和 backendHttpSettingsCollection 屬性。
Https	支援 httpListeners 和 backendHttpSettingsCollection 屬性。
Tcp	支援接聽程式和 backendSettingsCollection 屬性。
Tls	支援接聽程式和 backendSettingsCollection 屬性。

ApplicationSecurityGroup

Object

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

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

AutoApproval

Object

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

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

BackendAddressPool

Object

後端IP位址的集區。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
name	string	負載平衡器所使用之後端位址池集合內唯一的資源名稱。此名稱可用來存取資源。
properties.backendIPConfigurations	NetworkInterfaceIPConfiguration[]	網路介面中定義的 IP 位址參考陣列。
properties.drainPeriodInSeconds	integer (int32)	將 RESET 傳送至用戶端和後端位址之前，Load Balancer 會等候的秒數。
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	資源類型。

CloudError

Object

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤內文。

CloudErrorBody

Object

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	有關錯誤的其他詳細資料清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中的屬性名稱。

CustomDnsConfigPropertiesFormat

Object

包含來自客戶的自定義 Dns 解析組態。

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

DdosSettings

Object

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

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

DdosSettingsProtectionMode

列舉型別

公用IP的 DDoS 保護模式

值	Description
VirtualNetworkInherited
Enabled
Disabled

Delegation

Object

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

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

ExtendedLocation

Object

ExtendedLocation 複雜類型。

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

ExtendedLocationTypes

列舉型別

擴充位置的類型。

值	Description
EdgeZone

FlowLog

Object

流量記錄資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
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.recordTypes	string	可選欄位可根據流量狀態過濾網路流量日誌。此欄位的值可以是任何以逗號分隔的字母 B、C、E 或 D 組成的組合字串。B 代表開始，當流程被創造時。 C 代表每五分鐘產生的持續流量，持續進行。 E 代表結束，當流程終止時。 D 代表拒絕，當一個流被拒絕時。如果未指定，則會記錄所有網路流量。
properties.retentionPolicy	RetentionPolicyParameters	定義流量記錄保留原則的參數。
properties.storageId	string	用來儲存流量記錄的記憶體帳戶標識碼。
properties.targetResourceGuid	string	將套用流量記錄的網路安全組 GUID。
properties.targetResourceId	string	將套用流量記錄的網路安全組標識碼。
tags	object	資源標籤。
type	string	資源類型。

FlowLogFormatParameters

Object

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

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

FlowLogFormatType

列舉型別

流量記錄檔的文件類型。

值	Description
JSON

FrontendIPConfiguration

Object

負載平衡器的前端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

Object

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

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

GatewayLoadBalancerTunnelInterfaceType

列舉型別

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

值	Description
None
Internal
External

GatewayLoadBalancerTunnelProtocol

列舉型別

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

值	Description
None
Native
VXLAN

InboundNatRule

Object

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

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
name	string	負載平衡器所使用之輸入NAT規則集合內唯一的資源名稱。此名稱可用來存取資源。
properties.backendAddressPool	SubResource	backendAddressPool 資源的參考。
properties.backendIPConfiguration	NetworkInterfaceIPConfiguration	VM 網路介面上定義之私人IP位址的參考。傳送至每個前端IP組態的前端埠的流量會轉送至後端IP。
properties.backendPort	integer (int32)	用於內部端點的連接埠。可接受的值範圍從 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 (int32)	外部端點的連接埠。每個規則的埠號碼在Load Balancer內必須是唯一的。可接受的值範圍從 1 到 65534。
properties.frontendPortRangeEnd	integer (int32)	外部端點的埠範圍結束。此屬性會與 BackendAddressPool 和 FrontendPortRangeStart 搭配使用。系統會針對來自 BackendAddressPool 的每個後端位址建立個別輸入 NAT 規則埠對應。可接受的值範圍從 1 到 65534。
properties.frontendPortRangeStart	integer (int32)	外部端點的埠範圍開始。此屬性會與 BackendAddressPool 和 FrontendPortRangeEnd 搭配使用。系統會針對來自 BackendAddressPool 的每個後端位址建立個別輸入 NAT 規則埠對應。可接受的值範圍從 1 到 65534。
properties.idleTimeoutInMinutes	integer (int32)	TCP 閑置連線的逾時。此值可以設定在 4 到 30 分鐘之間。預設值為 4 分鐘。只有當通訊協定設定為 TCP 時，才會使用這個專案。
properties.protocol	TransportProtocol	負載平衡規則所使用的傳輸通訊協議參考。
properties.provisioningState	ProvisioningState	輸入 NAT 規則資源的佈建狀態。
type	string	資源類型。

IPAllocationMethod

列舉型別

IP 位址配置方法。

值	Description
Static
Dynamic

IpamPoolPrefixAllocation

Object

IpamPool 前置詞配置參考。

名稱	類型	Description
allocatedAddressPrefixes	string[]	相關聯資源的 IpamPool 中指派的 IP 位址前置詞清單。
numberOfIpAddresses	string	要配置的IP位址數目。
pool.id	string (arm-id)	相關聯 Azure IpamPool 資源的資源標識碼。

IPConfiguration

Object

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

Object

IP 組態配置檔子資源。

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

IpTag

Object

包含與對象相關聯的 IpTag。

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

IPVersion

列舉型別

IP 位址版本。

值	Description
IPv4
IPv6

LoadBalancerBackendAddress

Object

負載平衡器後端位址。

名稱	類型	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
None
Up
Down

ManagedServiceIdentity

Object

資源的身分識別。

名稱	類型	Description
principalId	string	系統指派身分的主體識別碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string	系統指派身分識別的租用戶識別碼。此屬性只會針對系統指派的身分識別提供。
type	ResourceIdentityType	用於資源的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的識別。類型『None』會從虛擬機中移除任何身分識別。
userAssignedIdentities	UserAssignedIdentities	與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

NatGateway

Object

Nat 閘道資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
id	string	資源標識碼。
location	string	資源位置。
name	string	資源名稱。
properties.idleTimeoutInMinutes	integer (int32)	nat 閘道的閒置逾時。
properties.provisioningState	ProvisioningState	NAT 閘道資源的佈建狀態。
properties.publicIpAddresses	SubResource[]	與 nat 閘道資源關聯的公有IP位址 V4 陣列。
properties.publicIpAddressesV6	SubResource[]	與 nat 閘道資源關聯的公有IP位址 V6 陣列。
properties.publicIpPrefixes	SubResource[]	與 nat 閘道資源關聯的公有IP前綴 V4 陣列。
properties.publicIpPrefixesV6	SubResource[]	與 nat 閘道資源關聯的公有IP前綴 V6 陣列。
properties.resourceGuid	string	NAT 閘道資源的資源 GUID 屬性。
properties.sourceVirtualNetwork	SubResource	使用此 nat 閘道資源對源虛擬網路的引用。
properties.subnets	SubResource[]	使用此 nat 閘道資源之子網路的參考陣列。
sku	NatGatewaySku	nat 閘道 SKU。
tags	object	資源標籤。
type	string	資源類型。
zones	string[]	可用性區域清單，表示應該在其中部署 Nat 閘道的區域。

NatGatewaySku

Object

NAT 閘道的 SKU。

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

NatGatewaySkuName

列舉型別

Nat 閘道 SKU 的名稱。

值	Description
Standard
StandardV2

NatRulePortMapping

Object

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

名稱	類型	Description
backendPort	integer (int32)	後端連接埠。
frontendPort	integer (int32)	前埠。
inboundNatRuleName	string	傳入 NAT 規則的名稱。

NetworkInterface

Object

資源群組中的網路介面。

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

列舉型別

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

值	Description
None
MaxConnections
Floating
AcceleratedConnections

NetworkInterfaceAuxiliarySku

列舉型別

網路介面資源的輔助 SKU。

值	Description
None
A1
A2
A4
A8

NetworkInterfaceDnsSettings

Object

網路介面的 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 專案。此 DNS 名稱可藉由串連 VM 名稱與 internalDomainNameSuffix 值來建構。
internalFqdn	string	支援相同虛擬網路中 VM 之間內部通訊的完整 DNS 名稱。

NetworkInterfaceIPConfiguration

Object

網路介面中的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位址。它可以是單一 IP 位址或格式為 /<prefix-length> 的
properties.privateIPAddressPrefixLength	integer (int32) minimum: 1 maximum: 128	私人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

Object

網路介面的 PrivateLinkConnection 屬性。

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

NetworkInterfaceMigrationPhase

列舉型別

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

值	Description
None
Prepare
Commit
Abort
Committed

NetworkInterfaceNicType

列舉型別

網路介面資源的類型。

值	Description
Standard
Elastic

NetworkInterfaceTapConfiguration

Object

點選網路介面中的組態。

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

NetworkSecurityGroup

Object

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

Object

私人端點資源。

名稱	類型	預設值	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.ipVersionType	PrivateEndpointIPVersionType	IPv4	指定私有端點私有 IP 的 IP 版本類型。如果沒有定義，這會預設為 IPv4。
properties.manualPrivateLinkServiceConnections	PrivateLinkServiceConnection[]		遠端資源連線的相關信息群組。當網路管理員無權核准遠程資源的連線時使用。
properties.networkInterfaces	NetworkInterface[]		針對這個私人端點所建立之網路介面的參考陣列。
properties.privateLinkServiceConnections	PrivateLinkServiceConnection[]		遠端資源連線的相關信息群組。
properties.provisioningState	ProvisioningState		私人端點資源的布建狀態。
properties.subnet	Subnet		將配置私人IP之子網的標識碼。
tags	object		資源標籤。
type	string		資源類型。

PrivateEndpointConnection

Object

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

Object

私人端點的IP組態。

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

PrivateEndpointIPVersionType

列舉型別

指定私有端點私有 IP 的 IP 版本類型。如果沒有定義，這會預設為 IPv4。

值	Description
IPv4	表示私有端點的私有 IP 將僅為 IPv4。
IPv6	表示私有端點的私有 IP 僅為 IPv6。
DualStack	表示私有端點的私有 IP 可以同時是 IPv4 和 IPv6。

PrivateLinkService

Object

私人鏈接服務資源。

名稱	類型	Description
etag	string	每當更新資源時變更的唯一隻讀字串。
extendedLocation	ExtendedLocation	負載平衡器的擴充位置。
id	string	資源標識碼。
location	string	資源位置。
name	string	資源名稱。
properties.accessMode	AccessMode	私人連結服務的存取模式。
properties.alias	string	私人鏈接服務的別名。
properties.autoApproval	AutoApproval	私人連結服務的自動核准清單。
properties.destinationIPAddress	string	私人鏈接服務的目的地IP位址。
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

Object

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

Object

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

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

PrivateLinkServiceIpConfiguration

Object

私人鏈接服務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	資源類型。

ProvisioningState

列舉型別

目前的布建狀態。

值	Description
Succeeded
Updating
Deleting
Failed

PublicIPAddress

Object

公用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 (int32)	公用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

Object

包含與公用IP位址相關聯的 DNS 記錄 FQDN。

名稱	類型	Description
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 中的哈希值。

值	Description
TenantReuse
SubscriptionReuse
ResourceGroupReuse
NoReuse

PublicIPAddressMigrationPhase

列舉型別

公用IP位址的移轉階段。

值	Description
None
Prepare
Commit
Abort
Committed

PublicIPAddressSku

Object

公用IP位址的SKU。

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

PublicIPAddressSkuName

列舉型別

公用IP位址 SKU 的名稱。

值	Description
Basic
Standard
StandardV2

PublicIPAddressSkuTier

列舉型別

公用IP位址SKU的階層。

值	Description
Regional
Global

ResourceIdentityType

列舉型別

用於資源的身分識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的識別。類型『None』會從虛擬機中移除任何身分識別。

值	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ResourceNavigationLink

Object

ResourceNavigationLink 資源。

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

RetentionPolicyParameters

Object

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

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

Route

Object

路由資源。

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

值	Description
VirtualNetworkGateway
VnetLocal
Internet
VirtualAppliance
None

RouteTable

Object

路由表資源。

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

Object

網路安全性規則。

名稱	類型	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 (int32)	規則的優先順序。此值可以介於 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
Deny

SecurityRuleDirection

列舉型別

規則的方向。方向會指定規則是否會在傳入或傳出流量上進行評估。

值	Description
Inbound
Outbound

SecurityRuleProtocol

列舉型別

此規則適用的網路協定。

值	Description
Tcp
Udp
Icmp
Esp
*
Ah

ServiceAssociationLink

Object

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

Object

服務端點原則資源。

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

Object

服務端點原則定義。

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

ServiceEndpointPropertiesFormat

Object

服務端點屬性。

名稱	類型	Description
locations	string[]	位置清單。
networkIdentifier	SubResource	SubResource 作為網路標識符。
provisioningState	ProvisioningState	服務端點資源的佈建狀態。
service	string	端點服務的型別。

SharingScope

列舉型別

將此屬性設定為 Tenant，以允許與 AAD 租使用者中的其他訂用帳戶共用子網。只有當 defaultOutboundAccess 設定為 false 時，才能設定此屬性，只有在子網是空的時，才能設定這兩個屬性。

值	Description
Tenant
DelegatedServices

Subnet

Object

虛擬網路資源中的子網。

名稱	類型	預設值	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.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		將此屬性設定為 Tenant，以允許與 AAD 租使用者中的其他訂用帳戶共用子網。只有當 defaultOutboundAccess 設定為 false 時，才能設定此屬性，只有在子網是空的時，才能設定這兩個屬性。
type	string		資源類型。

SubResource

Object

另一個子資源的參考。

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

SyncMode

列舉型別

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

值	Description
Automatic
Manual

TrafficAnalyticsConfigurationProperties

Object

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

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

TrafficAnalyticsProperties

Object

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

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

TransportProtocol

列舉型別

端點的傳輸通訊協定。

值	Description
Udp
Tcp
All
Quic

UserAssignedIdentities

Object

與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

名稱	類型	Description

VirtualNetworkPrivateEndpointNetworkPolicies

列舉型別

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

值	Description
Enabled
Disabled
NetworkSecurityGroupEnabled
RouteTableEnabled

VirtualNetworkPrivateLinkServiceNetworkPolicies

列舉型別

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

值	Description
Enabled
Disabled

VirtualNetworkTap

Object

虛擬網路點選資源。

名稱	類型	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 組態的資源 ID 清單。
properties.provisioningState	ProvisioningState	虛擬網路分流器資源的佈建狀態。
properties.resourceGuid	string	虛擬網路點道資源的資源 GUID 屬性。
tags	object	資源標籤。
type	string	資源類型。

Visibility

Object

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

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

共用方式為

Application Gateways - Backend Health

URI 參數

回應

安全性

azure_auth

範圍

範例

Get Backend Health

範例要求

範例回覆

定義

AccessMode

ApplicationGatewayBackendAddress

ApplicationGatewayBackendAddressPool

ApplicationGatewayBackendHealth

ApplicationGatewayBackendHealthHttpSettings

ApplicationGatewayBackendHealthPool

ApplicationGatewayBackendHealthServer

ApplicationGatewayBackendHealthServerHealth

ApplicationGatewayBackendHttpSettings

ApplicationGatewayConnectionDraining

ApplicationGatewayCookieBasedAffinity

ApplicationGatewayIPConfiguration

ApplicationGatewayProtocol

ApplicationSecurityGroup

AutoApproval

BackendAddressPool

CloudError

CloudErrorBody

CustomDnsConfigPropertiesFormat

DdosSettings

DdosSettingsProtectionMode

Delegation

DeleteOptions

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

PrivateEndpointIPVersionType

PrivateLinkService

PrivateLinkServiceConnection

PrivateLinkServiceConnectionState

PrivateLinkServiceIpConfiguration

ProvisioningState

PublicIPAddress

PublicIPAddressDnsSettings

PublicIpAddressDnsSettingsDomainNameLabelScope