VirtualNetworkGateways interface
表示 VirtualNetworkGateways 的介面。
方法
方法詳細資料
beginCreateOrUpdate(string, string, VirtualNetworkGateway, VirtualNetworkGatewaysCreateOrUpdateOptionalParams)
在指定的資源群組中建立或更新虛擬網路閘道。
function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: VirtualNetworkGatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- VirtualNetworkGateway
提供用來建立或更新虛擬網路閘道作業的參數。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<void>, void>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, VirtualNetworkGatewaysDeleteOptionalParams)
刪除指定的虛擬網路閘道。
function beginDeleteAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysDeleteOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<void>
beginDisconnectVirtualNetworkGatewayVpnConnections(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)
中斷指定資源群組中虛擬網路閘道的 VPN 連線。
function beginDisconnectVirtualNetworkGatewayVpnConnections(resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- request
- P2SVpnConnectionRequest
參數會提供來中斷 VPN 連線的連線。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait(string, string, P2SVpnConnectionRequest, VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams)
中斷指定資源群組中虛擬網路閘道的 VPN 連線。
function beginDisconnectVirtualNetworkGatewayVpnConnectionsAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, request: P2SVpnConnectionRequest, options?: VirtualNetworkGatewaysDisconnectVirtualNetworkGatewayVpnConnectionsOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- request
- P2SVpnConnectionRequest
參數會提供來中斷 VPN 連線的連線。
傳回
Promise<void>
beginGeneratevpnclientpackage(string, string, VpnClientParameters, VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams)
為指定資源群組中虛擬網路閘道的 P2S 用戶端產生 VPN 用戶端套件。
function beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: VirtualNetworkGatewaysGeneratevpnclientpackageOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGeneratevpnclientpackageResponse>, VirtualNetworkGatewaysGeneratevpnclientpackageResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- VpnClientParameters
提供給產生虛擬網路閘道 VPN 用戶端封裝作業的參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<VirtualNetworkGatewaysGenerateVpnProfileResponse>, VirtualNetworkGatewaysGenerateVpnProfileResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- VpnClientParameters
提供給產生虛擬網路閘道 VPN 用戶端封裝作業的參數。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- peer
-
string
對等的IP位址。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<BgpPeerStatusListResult>, BgpPeerStatusListResult>>
beginGetBgpPeerStatusAndWait(string, string, VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams)
GetBgpPeerStatus 作業會擷取所有 BGP 對等互連的狀態。
function beginGetBgpPeerStatusAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams): Promise<BgpPeerStatusListResult>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<BgpPeerStatusListResult>
beginGetFailoverAllTestDetails(string, string, string, boolean, VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams)
此作業會擷取針對不同對等互連位置在閘道上執行的所有故障轉移測試詳細數據
function beginGetFailoverAllTestDetails(resourceGroupName: string, virtualNetworkGatewayName: string, typeParam: string, fetchLatest: boolean, options?: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGetFailoverAllTestDetailsResponse>, VirtualNetworkGatewaysGetFailoverAllTestDetailsResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- typeParam
-
string
故障轉移測試的類型
- fetchLatest
-
boolean
只擷取每個對等互連位置的最新測試
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysGetFailoverAllTestDetailsResponse>, VirtualNetworkGatewaysGetFailoverAllTestDetailsResponse>>
beginGetFailoverAllTestDetailsAndWait(string, string, string, boolean, VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams)
此作業會擷取針對不同對等互連位置在閘道上執行的所有故障轉移測試詳細數據
function beginGetFailoverAllTestDetailsAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, typeParam: string, fetchLatest: boolean, options?: VirtualNetworkGatewaysGetFailoverAllTestDetailsOptionalParams): Promise<VirtualNetworkGatewaysGetFailoverAllTestDetailsResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- typeParam
-
string
故障轉移測試的類型
- fetchLatest
-
boolean
只擷取每個對等互連位置的最新測試
傳回
beginGetFailoverSingleTestDetails(string, string, string, string, VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams)
此作業會根據測試 Guid 擷取在閘道上執行之特定故障轉移測試的詳細數據
function beginGetFailoverSingleTestDetails(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, failoverTestId: string, options?: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysGetFailoverSingleTestDetailsResponse>, VirtualNetworkGatewaysGetFailoverSingleTestDetailsResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- peeringLocation
-
string
測試的對等互連位置
- failoverTestId
-
string
識別測試的唯一 Guid 值
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysGetFailoverSingleTestDetailsResponse>, VirtualNetworkGatewaysGetFailoverSingleTestDetailsResponse>>
beginGetFailoverSingleTestDetailsAndWait(string, string, string, string, VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams)
此作業會根據測試 Guid 擷取在閘道上執行之特定故障轉移測試的詳細數據
function beginGetFailoverSingleTestDetailsAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, failoverTestId: string, options?: VirtualNetworkGatewaysGetFailoverSingleTestDetailsOptionalParams): Promise<VirtualNetworkGatewaysGetFailoverSingleTestDetailsResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- peeringLocation
-
string
測試的對等互連位置
- failoverTestId
-
string
識別測試的唯一 Guid 值
傳回
beginGetLearnedRoutes(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)
此作業會擷取虛擬網路網關已學習的路由清單,包括從 BGP 對等互連學習的路由。
function beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams): Promise<SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayRouteListResult>, GatewayRouteListResult>>
beginGetLearnedRoutesAndWait(string, string, VirtualNetworkGatewaysGetLearnedRoutesOptionalParams)
此作業會擷取虛擬網路網關已學習的路由清單,包括從 BGP 對等互連學習的路由。
function beginGetLearnedRoutesAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetLearnedRoutesOptionalParams): Promise<GatewayRouteListResult>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<GatewayRouteListResult>
beginGetResiliencyInformation(string, string, VirtualNetworkGatewaysGetResiliencyInformationOptionalParams)
此作檢索 Express Route 閘道的彈性資訊,包括閘道的當前彈性分數和進一步提高分數的建議
function beginGetResiliencyInformation(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams): Promise<SimplePollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayResiliencyInformation>, GatewayResiliencyInformation>>
beginGetResiliencyInformationAndWait(string, string, VirtualNetworkGatewaysGetResiliencyInformationOptionalParams)
此作檢索 Express Route 閘道的彈性資訊,包括閘道的當前彈性分數和進一步提高分數的建議
function beginGetResiliencyInformationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetResiliencyInformationOptionalParams): Promise<GatewayResiliencyInformation>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
傳回
Promise<GatewayResiliencyInformation>
beginGetRoutesInformation(string, string, VirtualNetworkGatewaysGetRoutesInformationOptionalParams)
此作根據 Express Route 閘道的彈性檢索路由集資訊
function beginGetRoutesInformation(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetRoutesInformationOptionalParams): Promise<SimplePollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<GatewayRouteSetsInformation>, GatewayRouteSetsInformation>>
beginGetRoutesInformationAndWait(string, string, VirtualNetworkGatewaysGetRoutesInformationOptionalParams)
此作根據 Express Route 閘道的彈性檢索路由集資訊
function beginGetRoutesInformationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetRoutesInformationOptionalParams): Promise<GatewayRouteSetsInformation>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<GatewayRouteSetsInformation>
beginGetVpnclientConnectionHealth(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)
針對指定資源群組中虛擬網路網關的每個 P2S 用戶端連線,取得 VPN 用戶端連線健康情況詳細數據。
function beginGetVpnclientConnectionHealth(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams): Promise<SimplePollerLike<OperationState<VpnClientConnectionHealthDetailListResult>, VpnClientConnectionHealthDetailListResult>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VpnClientConnectionHealthDetailListResult>, VpnClientConnectionHealthDetailListResult>>
beginGetVpnclientConnectionHealthAndWait(string, string, VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams)
針對指定資源群組中虛擬網路網關的每個 P2S 用戶端連線,取得 VPN 用戶端連線健康情況詳細數據。
function beginGetVpnclientConnectionHealthAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientConnectionHealthOptionalParams): Promise<VpnClientConnectionHealthDetailListResult>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
傳回
beginGetVpnclientIpsecParameters(string, string, VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams)
取得 VpnclientIpsecParameters 作業會透過網路資源提供者,擷取指定資源群組中虛擬網路網關 P2S 用戶端之 vpnclient ipsec 原則的相關信息。
function beginGetVpnclientIpsecParameters(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnclientIpsecParametersOptionalParams): Promise<SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道名稱。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>, VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>>
beginGetVpnProfilePackageUrlAndWait(string, string, VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams)
取得指定資源群組中虛擬網路閘道 P2S 用戶端的預先產生 VPN 配置檔。 必須先使用 generateVpnProfile 來產生配置檔。
function beginGetVpnProfilePackageUrlAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysGetVpnProfilePackageUrlOptionalParams): Promise<VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
傳回
beginInvokeAbortMigration(string, string, VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams)
觸發虛擬網路閘道的中止遷移。
function beginInvokeAbortMigration(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeAbortMigrationHeaders>, VirtualNetworkGatewaysInvokeAbortMigrationHeaders>>
參數
- resourceGroupName
-
string
虛擬網路閘道的資源組名。
- virtualNetworkGatewayName
-
string
閘道名稱。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeAbortMigrationHeaders>, VirtualNetworkGatewaysInvokeAbortMigrationHeaders>>
beginInvokeAbortMigrationAndWait(string, string, VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams)
觸發虛擬網路閘道的中止遷移。
function beginInvokeAbortMigrationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeAbortMigrationOptionalParams): Promise<VirtualNetworkGatewaysInvokeAbortMigrationHeaders>
參數
- resourceGroupName
-
string
虛擬網路閘道的資源組名。
- virtualNetworkGatewayName
-
string
閘道名稱。
選項參數。
傳回
beginInvokeCommitMigration(string, string, VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams)
觸發虛擬網路網關的提交遷移。
function beginInvokeCommitMigration(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeCommitMigrationHeaders>, VirtualNetworkGatewaysInvokeCommitMigrationHeaders>>
參數
- resourceGroupName
-
string
虛擬網路閘道的資源組名。
- virtualNetworkGatewayName
-
string
閘道名稱。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeCommitMigrationHeaders>, VirtualNetworkGatewaysInvokeCommitMigrationHeaders>>
beginInvokeCommitMigrationAndWait(string, string, VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams)
觸發虛擬網路網關的提交遷移。
function beginInvokeCommitMigrationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeCommitMigrationOptionalParams): Promise<VirtualNetworkGatewaysInvokeCommitMigrationHeaders>
參數
- resourceGroupName
-
string
虛擬網路閘道的資源組名。
- virtualNetworkGatewayName
-
string
閘道名稱。
傳回
beginInvokeExecuteMigration(string, string, VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams)
觸發虛擬網路閘道的執行遷移。
function beginInvokeExecuteMigration(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeExecuteMigrationHeaders>, VirtualNetworkGatewaysInvokeExecuteMigrationHeaders>>
參數
- resourceGroupName
-
string
虛擬網路閘道的資源組名。
- virtualNetworkGatewayName
-
string
閘道名稱。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokeExecuteMigrationHeaders>, VirtualNetworkGatewaysInvokeExecuteMigrationHeaders>>
beginInvokeExecuteMigrationAndWait(string, string, VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams)
觸發虛擬網路閘道的執行遷移。
function beginInvokeExecuteMigrationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysInvokeExecuteMigrationOptionalParams): Promise<VirtualNetworkGatewaysInvokeExecuteMigrationHeaders>
參數
- resourceGroupName
-
string
虛擬網路閘道的資源組名。
- virtualNetworkGatewayName
-
string
閘道名稱。
傳回
beginInvokePrepareMigration(string, string, VirtualNetworkGatewayMigrationParameters, VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams)
觸發 Virtual Network Gateway 的準備遷移。
function beginInvokePrepareMigration(resourceGroupName: string, virtualNetworkGatewayName: string, migrationParams: VirtualNetworkGatewayMigrationParameters, options?: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokePrepareMigrationHeaders>, VirtualNetworkGatewaysInvokePrepareMigrationHeaders>>
參數
- resourceGroupName
-
string
虛擬網路閘道的資源組名。
- virtualNetworkGatewayName
-
string
閘道名稱。
- migrationParams
- VirtualNetworkGatewayMigrationParameters
通過網路資源提供程式提供給 Begin Prepare migration on basic vpn gateway(在基本 VPN 閘道上開始準備遷移)的參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysInvokePrepareMigrationHeaders>, VirtualNetworkGatewaysInvokePrepareMigrationHeaders>>
beginInvokePrepareMigrationAndWait(string, string, VirtualNetworkGatewayMigrationParameters, VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams)
觸發 Virtual Network Gateway 的準備遷移。
function beginInvokePrepareMigrationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, migrationParams: VirtualNetworkGatewayMigrationParameters, options?: VirtualNetworkGatewaysInvokePrepareMigrationOptionalParams): Promise<VirtualNetworkGatewaysInvokePrepareMigrationHeaders>
參數
- resourceGroupName
-
string
虛擬網路閘道的資源組名。
- virtualNetworkGatewayName
-
string
閘道名稱。
- migrationParams
- VirtualNetworkGatewayMigrationParameters
通過網路資源提供程式提供給 Begin Prepare migration on basic vpn gateway(在基本 VPN 閘道上開始準備遷移)的參數。
傳回
beginReset(string, string, VirtualNetworkGatewaysResetOptionalParams)
重設指定資源群組中虛擬網路閘道的主要 。
function beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysResetOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<void>, void>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<SimplePollerLike<OperationState<VpnClientIPsecParameters>, VpnClientIPsecParameters>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- vpnclientIpsecParams
- VpnClientIPsecParameters
透過網路資源提供者提供給虛擬網路網關 P2S 用戶端作業之 Begin Set vpnclient ipsec 參數的參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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>
beginStartExpressRouteSiteFailoverSimulation(string, string, string, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams)
此作業會在閘道上針對指定的對等互連位置啟動故障轉移模擬
function beginStartExpressRouteSiteFailoverSimulation(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, options?: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- peeringLocation
-
string
測試的對等互連位置
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>>
beginStartExpressRouteSiteFailoverSimulationAndWait(string, string, string, VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams)
此作業會在閘道上針對指定的對等互連位置啟動故障轉移模擬
function beginStartExpressRouteSiteFailoverSimulationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, peeringLocation: string, options?: VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationOptionalParams): Promise<VirtualNetworkGatewaysStartExpressRouteSiteFailoverSimulationResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- peeringLocation
-
string
測試的對等互連位置
傳回
beginStartPacketCapture(string, string, VirtualNetworkGatewaysStartPacketCaptureOptionalParams)
在指定的資源群組中的虛擬網路網關上啟動封包擷取。
function beginStartPacketCapture(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStartPacketCaptureResponse>, VirtualNetworkGatewaysStartPacketCaptureResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysStartPacketCaptureResponse>, VirtualNetworkGatewaysStartPacketCaptureResponse>>
beginStartPacketCaptureAndWait(string, string, VirtualNetworkGatewaysStartPacketCaptureOptionalParams)
在指定的資源群組中的虛擬網路網關上啟動封包擷取。
function beginStartPacketCaptureAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysStartPacketCaptureOptionalParams): Promise<VirtualNetworkGatewaysStartPacketCaptureResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
beginStopExpressRouteSiteFailoverSimulation(string, string, ExpressRouteFailoverStopApiParameters, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams)
此作業會在閘道上停止指定對等互連位置的故障轉移模擬
function beginStopExpressRouteSiteFailoverSimulation(resourceGroupName: string, virtualNetworkGatewayName: string, stopParameters: ExpressRouteFailoverStopApiParameters, options?: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- stopParameters
- ExpressRouteFailoverStopApiParameters
虛擬網路閘道停止提供的模擬參數,以停止閘道上的故障轉移模擬。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>>
beginStopExpressRouteSiteFailoverSimulationAndWait(string, string, ExpressRouteFailoverStopApiParameters, VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams)
此作業會在閘道上停止指定對等互連位置的故障轉移模擬
function beginStopExpressRouteSiteFailoverSimulationAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, stopParameters: ExpressRouteFailoverStopApiParameters, options?: VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationOptionalParams): Promise<VirtualNetworkGatewaysStopExpressRouteSiteFailoverSimulationResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- stopParameters
- ExpressRouteFailoverStopApiParameters
虛擬網路閘道停止提供的模擬參數,以停止閘道上的故障轉移模擬。
傳回
beginStopPacketCapture(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewaysStopPacketCaptureOptionalParams)
停止指定資源群組中虛擬網路網關上的封包擷取。
function beginStopPacketCapture(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGatewaysStopPacketCaptureResponse>, VirtualNetworkGatewaysStopPacketCaptureResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- VpnPacketCaptureStopParameters
提供的虛擬網路閘道封包擷取參數,以停止網關上的封包擷取。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualNetworkGatewaysStopPacketCaptureResponse>, VirtualNetworkGatewaysStopPacketCaptureResponse>>
beginStopPacketCaptureAndWait(string, string, VpnPacketCaptureStopParameters, VirtualNetworkGatewaysStopPacketCaptureOptionalParams)
停止指定資源群組中虛擬網路網關上的封包擷取。
function beginStopPacketCaptureAndWait(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnPacketCaptureStopParameters, options?: VirtualNetworkGatewaysStopPacketCaptureOptionalParams): Promise<VirtualNetworkGatewaysStopPacketCaptureResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- VpnPacketCaptureStopParameters
提供的虛擬網路閘道封包擷取參數,以停止網關上的封包擷取。
選項參數。
傳回
beginUpdateTags(string, string, TagsObject, VirtualNetworkGatewaysUpdateTagsOptionalParams)
更新虛擬網路閘道標籤。
function beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: VirtualNetworkGatewaysUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<VirtualNetworkGateway>, VirtualNetworkGateway>>
參數
- resourceGroupName
-
string
資源群組的名稱。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
- parameters
- TagsObject
提供以更新虛擬網路閘道標籤的參數。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<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
虛擬網路閘道的名稱。
選項參數。
傳回
listRadiusSecrets(string, string, VirtualNetworkGatewaysListRadiusSecretsOptionalParams)
列出所有 Radius 伺服器,其中包含來自虛擬網路閘道 VpnClientConfiguration 的個別 RADIUS 秘密。
function listRadiusSecrets(resourceGroupName: string, virtualNetworkGatewayName: string, options?: VirtualNetworkGatewaysListRadiusSecretsOptionalParams): Promise<RadiusAuthServerListResult>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- virtualNetworkGatewayName
-
string
虛擬網路閘道的名稱。
選項參數。
傳回
Promise<RadiusAuthServerListResult>
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 裝置腳本作業的參數。