Virtual Machines - Reimage
エフェメラル OS ディスクを持たない仮想マシンを再イメージ化 (オペレーティング システムのアップグレード) します。エフェメラル OS ディスクを持つ仮想マシンの場合、仮想マシンは初期状態にリセットされます。 注: 古い OS ディスクの保持は、OS ディスクの deleteOption の値によって異なります。 deleteOption がデタッチされている場合、古い OS ディスクは再イメージ化後も保持されます。 deleteOption が delete の場合、古い OS ディスクは再イメージ化後に削除されます。 再イメージ化を実行する前に、OS ディスクの deleteOption を適宜更新する必要があります。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage?api-version=2024-03-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループの名前。 |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。 |
vm
|
path | True |
string |
仮想マシンの名前。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
parameters |
仮想マシンの再イメージ化操作に指定されたパラメーター。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
202 Accepted |
同意 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Reimage a Non-Ephemeral Virtual Machine. |
Reimage a Virtual Machine. |
Reimage a Non-Ephemeral Virtual Machine.
Sample Request
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVMName/reimage?api-version=2024-03-01
{
"tempDisk": true,
"exactVersion": "aaaaaa",
"osProfile": {
"adminPassword": "{your-password}",
"customData": "{your-custom-data}"
}
}
Sample Response
Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-03-01
Reimage a Virtual Machine.
Sample Request
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVMName/reimage?api-version=2024-03-01
{
"tempDisk": true
}
Sample Response
Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2024-03-01
定義
名前 | 説明 |
---|---|
Api |
API エラー。 |
Api |
API エラーベース。 |
Cloud |
コンピューティング サービスからのエラー応答。 |
Inner |
内部エラーの詳細。 |
OSProfile |
非エフェメラル OS ディスクの再イメージ化に必要な情報を指定します。 |
Virtual |
仮想マシンの再イメージ化操作に指定されたパラメーター。 |
ApiError
API エラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
details |
Api エラーの詳細 |
|
innererror |
Api の内部エラー |
|
message |
string |
エラー メッセージ。 |
target |
string |
特定のエラーのターゲット。 |
ApiErrorBase
API エラーベース。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
message |
string |
エラー メッセージ。 |
target |
string |
特定のエラーのターゲット。 |
CloudError
コンピューティング サービスからのエラー応答。
名前 | 型 | 説明 |
---|---|---|
error |
API エラー。 |
InnerError
内部エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
errordetail |
string |
内部エラー メッセージまたは例外ダンプ。 |
exceptiontype |
string |
例外の種類。 |
OSProfileProvisioningData
非エフェメラル OS ディスクの再イメージ化に必要な情報を指定します。
名前 | 型 | 説明 |
---|---|---|
adminPassword |
string |
管理者アカウントのパスワードを指定します。 |
customData |
string |
カスタム データの Base 64 エンコード文字列を指定します。 Base 64 エンコード文字列は、仮想マシン上にファイルとして保存されるバイナリ配列にデコードされます。 バイナリ配列の長さは最大 65535 バイトです。 注: customData プロパティでシークレットまたはパスワードを渡さないでください。 このプロパティは、VM の作成後に更新できません。 プロパティ customData は、ファイルとして保存される VM に渡されます。詳細については、「 Azure VM 上のカスタム データ」を参照してください。 Linux VM に cloud-init を使用する場合は、「 cloud-init を使用して作成時に Linux VM をカスタマイズする」を参照してください。 |
VirtualMachineReimageParameters
仮想マシンの再イメージ化操作に指定されたパラメーター。
名前 | 型 | 説明 |
---|---|---|
exactVersion |
string |
OS ディスクを再イメージ化するバージョンを 10 進数で指定します。 正確なバージョンが指定されていない場合、OS ディスクは既存のバージョンの OS ディスクに再イメージ化されます。 |
osProfile |
非エフェメラル OS ディスクの再イメージ化に必要な情報を指定します。 |
|
tempDisk |
boolean |
一時ディスクを再イメージ化するかどうかを指定します。 既定値: false 注: この一時ディスク再イメージ化パラメーターは、エフェメラル OS ディスクを使用した VM/VMSS でのみサポートされます。 |