Virtual Network Gateways - Invoke Prepare Migration

服務:

Network Gateway

API 版本:

2025-05-01

觸發 Virtual Network Gateway 的準備遷移。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/prepareMigration?api-version=2025-05-01

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
virtualNetworkGatewayName	path	True	string	虛擬網路閘道的名稱。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
migrationType	True	VirtualNetworkGatewayMigrationType	MigrationType 的虛擬網路閘道。
resourceUrl		string	需要傳遞至移轉的資源 URL。

回應

名稱	類型	Description
202 Accepted		已接受資源作業。 標題 Location: string Retry-After: integer
Other Status Codes	Common.CloudError	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

範圍

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

範例

VirtualNetworkGatewayPrepareMigration

範例要求

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/prepareMigration?api-version=2025-05-01

{
  "migrationType": "UpgradeDeploymentToStandardIP",
  "resourceUrl": "testUrl"
}

JavaScript

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

/**
 * This sample demonstrates how to Trigger prepare migration for the virtual network gateway.
 *
 * @summary Trigger prepare migration for the virtual network gateway.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/VirtualNetworkGatewayPrepareMigration.json
 */
async function virtualNetworkGatewayPrepareMigration() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "vpngw";
  const migrationParams = {
    migrationType: "UpgradeDeploymentToStandardIP",
    resourceUrl: "testUrl",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.beginInvokePrepareMigrationAndWait(
    resourceGroupName,
    virtualNetworkGatewayName,
    migrationParams,
  );
  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

範例回覆

狀態碼:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-05-01

定義

名稱	Description
Common.CloudError	來自服務的錯誤回應。
Common.CloudErrorBody	來自服務的錯誤回應。
VirtualNetworkGatewayMigrationParameters	虛擬網路閘道遷移參數。
VirtualNetworkGatewayMigrationType	MigrationType 的虛擬網路閘道。

Common.CloudError

Object

來自服務的錯誤回應。

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

Common.CloudErrorBody

Object

來自服務的錯誤回應。

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

VirtualNetworkGatewayMigrationParameters

Object

虛擬網路閘道遷移參數。

名稱	類型	Description
migrationType	VirtualNetworkGatewayMigrationType	MigrationType 的虛擬網路閘道。
resourceUrl	string	需要傳遞至移轉的資源 URL。

VirtualNetworkGatewayMigrationType

列舉型別

MigrationType 的虛擬網路閘道。

值	Description
UpgradeDeploymentToStandardIP	表示這是從基本IP CSES到標準IP VMSS的遷移過程。