VirtualNetworkGateways interface
表示 VirtualNetworkGateways 的介面。
方法
方法詳細資料
beginCreateOrUpdate(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)
在指定的資源群組中建立或更新虛擬網路閘道。
function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- VirtualNetworkGateway
提供用來建立或更新虛擬網路閘道作業的參數。
選項參數。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
beginCreateOrUpdateAndWait(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)
在指定的資源群組中建立或更新虛擬網路閘道。
function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams): Promise<VirtualNetworkGateway>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- VirtualNetworkGateway
提供用來建立或更新虛擬網路閘道作業的參數。
選項參數。
傳回
Promise<VirtualNetworkGateway>
beginDelete(string, string, VirtualNetworkGatewaysDeleteOptionalParams)
刪除指定的虛擬網路閘道。
function beginDelete(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, VirtualNetworkGatewaysDeleteOptionalParams)
刪除指定的虛擬網路閘道。
function beginDeleteAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<void>
beginGeneratevpnclientpackage(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)
為指定資源群組中虛擬網路閘道的 P2S 用戶端產生 VPN 用戶端套件。
function beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>, VirtualNetworkGatewaysGeneratevpnclientpackageResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- VpnClientParameters
提供給產生虛擬網路閘道 VPN 用戶端套件作業的參數。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>, VirtualNetworkGatewaysGeneratevpnclientpackageResponse>>
beginGeneratevpnclientpackageAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)
為指定資源群組中虛擬網路閘道的 P2S 用戶端產生 VPN 用戶端套件。
function beginGeneratevpnclientpackageAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams): Promise<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- VpnClientParameters
提供給產生虛擬網路閘道 VPN 用戶端套件作業的參數。
傳回
beginGenerateVpnProfile(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)
為指定資源群組中虛擬網路閘道的 P2S 用戶端產生 VPN 設定檔。 用於 IKEV2 和半徑型驗證。
function beginGenerateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGatewaysGenerateVpnProfileResponse>, VirtualNetworkGatewaysGenerateVpnProfileResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- VpnClientParameters
提供給產生虛擬網路閘道 VPN 用戶端套件作業的參數。
選項參數。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualNetworkGatewaysGenerateVpnProfileResponse>, VirtualNetworkGatewaysGenerateVpnProfileResponse>>
beginGenerateVpnProfileAndWait(string, string, VpnClientParameters, VirtualNetworkGatewaysGenerateVpnProfileOptionalParams)
為指定資源群組中虛擬網路閘道的 P2S 用戶端產生 VPN 設定檔。 用於 IKEV2 和半徑型驗證。
function beginGenerateVpnProfileAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGenerateVpnProfileOptionalParams): Promise<VirtualNetworkGatewaysGenerateVpnProfileResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- VpnClientParameters
提供給產生虛擬網路閘道 VPN 用戶端套件作業的參數。
選項參數。
傳回
beginGetAdvertisedRoutes(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)
此作業會擷取虛擬網路閘道向指定的對等公告路由清單。
function beginGetAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams): Promise<PollerLike<PollOperationState<GatewayRouteListResult>, GatewayRouteListResult>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- peer
-
string
對等的 IP 位址
選項參數。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<GatewayRouteListResult>, GatewayRouteListResult>>
beginGetAdvertisedRoutesAndWait(string, string, string, VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams)
此作業會擷取虛擬網路閘道向指定的對等公告路由清單。
function beginGetAdvertisedRoutesAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: VirtualNetworkGatewaysGetAdvertisedRoutesOptionalParams): Promise<GatewayRouteListResult>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- peer
-
string
對等的 IP 位址
選項參數。
傳回
Promise<GatewayRouteListResult>
beginGetBgpPeerStatus(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)
GetBgpPeerStatus 作業會擷取所有 BGP 對等互連的狀態。
function beginGetBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams): Promise<PollerLike<PollOperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>
beginGetBgpPeerStatusAndWait(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)
GetBgpPeerStatus 作業會擷取所有 BGP 對等互連的狀態。
function beginGetBgpPeerStatusAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams): Promise<BgpPeerStatusListResult>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<BgpPeerStatusListResult>
beginGetLearnedRoutes(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)
此作業會擷取虛擬網路閘道所學到的路由清單,包括從 BGP 對等互連學習的路由。
function beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams): Promise<PollerLike<PollOperationState<GatewayRouteListResult>, GatewayRouteListResult>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<GatewayRouteListResult>, GatewayRouteListResult>>
beginGetLearnedRoutesAndWait(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)
此作業會擷取虛擬網路閘道所學到的路由清單,包括從 BGP 對等互連學習的路由。
function beginGetLearnedRoutesAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams): Promise<GatewayRouteListResult>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<GatewayRouteListResult>
beginGetVpnclientIpsecParameters(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)
取得 VpnclientIpsecParameters 作業會透過網路資源提供者,擷取指定資源群組中虛擬網路閘道之 P2S 用戶端 vpnclient ipsec 原則的相關資訊。
function beginGetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams): Promise<PollerLike<PollOperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道名稱。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>
beginGetVpnclientIpsecParametersAndWait(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)
取得 VpnclientIpsecParameters 作業會透過網路資源提供者,擷取指定資源群組中虛擬網路閘道之 P2S 用戶端 vpnclient ipsec 原則的相關資訊。
function beginGetVpnclientIpsecParametersAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams): Promise<VpnClientIPsecParameters>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道名稱。
傳回
Promise<VpnClientIPsecParameters>
beginGetVpnProfilePackageUrl(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)
取得指定資源群組中虛擬網路閘道之 P2S 用戶端預先產生的 VPN 設定檔。 必須先使用 generateVpnProfile 來產生設定檔。
function beginGetVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>>
beginGetVpnProfilePackageUrlAndWait(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)
取得指定資源群組中虛擬網路閘道之 P2S 用戶端預先產生的 VPN 設定檔。 必須先使用 generateVpnProfile 來產生設定檔。
function beginGetVpnProfilePackageUrlAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams): Promise<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
傳回
beginReset(string, string, VirtualNetworkGatewaysResetOptionalParams)
重設指定資源群組中虛擬網路閘道的主要。
function beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
beginResetAndWait(string, string, VirtualNetworkGatewaysResetOptionalParams)
重設指定資源群組中虛擬網路閘道的主要。
function beginResetAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams): Promise<VirtualNetworkGateway>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<VirtualNetworkGateway>
beginResetVpnClientSharedKey(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)
重設指定資源群組中虛擬網路閘道的 VPN 用戶端共用金鑰。
function beginResetVpnClientSharedKey(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginResetVpnClientSharedKeyAndWait(string, string, VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams)
重設指定資源群組中虛擬網路閘道的 VPN 用戶端共用金鑰。
function beginResetVpnClientSharedKeyAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetVpnClientSharedKeyOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
傳回
Promise<void>
beginSetVpnclientIpsecParameters(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)
設定 VpnclientIpsecParameters 作業會透過網路資源提供者,為指定資源群組中虛擬網路閘道的 P2S 用戶端設定 vpnclient ipsec 原則。
function beginSetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams): Promise<PollerLike<PollOperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- vpnclientIpsecParams
- VpnClientIPsecParameters
透過網路資源提供者,提供給虛擬網路閘道 P2S 用戶端作業之 Begin Set vpnclient ipsec 參數的參數。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>
beginSetVpnclientIpsecParametersAndWait(string, string, VpnClientIPsecParameters, VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams)
設定 VpnclientIpsecParameters 作業會透過網路資源提供者,為指定資源群組中虛擬網路閘道的 P2S 用戶端設定 vpnclient ipsec 原則。
function beginSetVpnclientIpsecParametersAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, vpnclientIpsecParams: VpnClientIPsecParameters, options?: VirtualNetworkGatewaysSetVpnclientIpsecParametersOptionalParams): Promise<VpnClientIPsecParameters>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- vpnclientIpsecParams
- VpnClientIPsecParameters
透過網路資源提供者,提供給虛擬網路閘道 P2S 用戶端作業之 Begin Set vpnclient ipsec 參數的參數。
傳回
Promise<VpnClientIPsecParameters>
beginUpdateTags(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)
更新虛擬網路閘道標籤。
function beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- TagsObject
提供用來更新虛擬網路閘道標籤的參數。
選項參數。
傳回
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
beginUpdateTagsAndWait(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)
更新虛擬網路閘道標籤。
function beginUpdateTagsAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams): Promise<VirtualNetworkGateway>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- TagsObject
提供用來更新虛擬網路閘道標籤的參數。
選項參數。
傳回
Promise<VirtualNetworkGateway>
get(string, string, VirtualNetworkGatewaysGetOptionalParams)
依資源群組取得指定的虛擬網路閘道。
function get(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetOptionalParams): Promise<VirtualNetworkGateway>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<VirtualNetworkGateway>
list(string, VirtualNetworkGatewaysListOptionalParams)
依資源群組取得所有虛擬網路閘道。
function list(resourceGroupName: string, options?: VirtualNetworkGatewaysListOptionalParams): PagedAsyncIterableIterator<VirtualNetworkGateway, VirtualNetworkGateway[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。
選項參數。
傳回
listConnections(string, string, VirtualNetworkGatewaysListConnectionsOptionalParams)
取得虛擬網路閘道中的所有連線。
function listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysListConnectionsOptionalParams): PagedAsyncIterableIterator<VirtualNetworkGatewayConnectionListEntity, VirtualNetworkGatewayConnectionListEntity[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
supportedVpnDevices(string, string, VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams)
取得支援的 VPN 裝置的 XML 格式表示。
function supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysSupportedVpnDevicesOptionalParams): Promise<VirtualNetworkGatewaysSupportedVpnDevicesResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
vpnDeviceConfigurationScript(string, string, VpnDeviceScriptParameters, VirtualNetworkGatewaysVpnDeviceConfigurationScriptOptionalParams)
取得 vpn 裝置組態腳本的 xml 格式標記法。
function vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnDeviceScriptParameters, options?: VirtualNetworkGatewaysVpnDeviceConfigurationScriptOptionalParams): Promise<VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayConnectionName
-
string
產生組態腳本的虛擬網路閘道連線名稱。
- parameters
- VpnDeviceScriptParameters
提供給產生 vpn 裝置腳本作業的參數。