エフェメラル OS ディスクがない VM スケール セット内の 1 つ以上の仮想マシンを再イメージ化 (オペレーティング システムのアップグレード) します。エフェメラル OS ディスクを持つ仮想マシンの場合、仮想マシンは初期状態にリセットされます。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage?api-version=2024-03-01
URI パラメーター
名前 |
/ |
必須 |
型 |
説明 |
resourceGroupName
|
path |
True
|
string
|
リソース グループの名前。
|
subscriptionId
|
path |
True
|
string
|
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
|
vmScaleSetName
|
path |
True
|
string
|
VM スケール セットの名前。
|
api-version
|
query |
True
|
string
|
クライアント API のバージョン。
|
要求本文
名前 |
型 |
説明 |
exactVersion
|
string
|
OS ディスクを再イメージ化するバージョンを 10 進数で指定します。 正確なバージョンが指定されていない場合、OS ディスクは既存のバージョンの OS ディスクに再イメージ化されます。
|
forceUpdateOSDiskForEphemeral
|
boolean
|
仮想マシン スケール セット VM のエフェメラル OS ディスクを強制的に更新するためのパラメーター
|
instanceIds
|
string[]
|
仮想マシン スケール セットのインスタンス ID。 仮想マシン スケール セットのインスタンス ID を省略すると、仮想マシン スケール セット内のすべての仮想マシンで操作が実行されます。
|
osProfile
|
OSProfileProvisioningData
|
非エフェメラル OS ディスクの再イメージ化に必要な情報を指定します。
|
tempDisk
|
boolean
|
一時ディスクを再イメージ化するかどうかを指定します。 既定値: false 注: この一時ディスク再イメージ化パラメーターは、エフェメラル OS ディスクを使用した VM/VMSS でのみサポートされます。
|
応答
名前 |
型 |
説明 |
200 OK
|
|
OK
|
202 Accepted
|
|
同意
|
Other Status Codes
|
CloudError
|
操作に失敗した理由を説明するエラー応答。
|
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 |
説明 |
user_impersonation
|
ユーザー アカウントの借用
|
例
VirtualMachineScaleSet_Reimage_MaximumSet_Gen
Sample Request
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaa/reimage?api-version=2024-03-01
{
"instanceIds": [
"aaaaaaaaaa"
],
"forceUpdateOSDiskForEphemeral": true,
"tempDisk": true
}
from azure.identity import DefaultAzureCredential
from azure.mgmt.compute import ComputeManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-compute
# USAGE
python virtual_machine_scale_set_reimage_maximum_set_gen.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 = ComputeManagementClient(
credential=DefaultAzureCredential(),
subscription_id="{subscription-id}",
)
client.virtual_machine_scale_sets.begin_reimage(
resource_group_name="rgcompute",
vm_scale_set_name="aaaaaaaaaaaaaaaaaaaaaaaaaa",
).result()
# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.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
package armcompute_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_BeginReimage_virtualMachineScaleSetReimageMaximumSetGen() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewVirtualMachineScaleSetsClient().BeginReimage(ctx, "rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaaa", &armcompute.VirtualMachineScaleSetsClientBeginReimageOptions{VMScaleSetReimageInput: &armcompute.VirtualMachineScaleSetReimageParameters{
TempDisk: to.Ptr(true),
ForceUpdateOSDiskForEphemeral: to.Ptr(true),
InstanceIDs: []*string{
to.Ptr("aaaaaaaaaa")},
},
})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.
*
* @summary Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.
* x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json
*/
async function virtualMachineScaleSetReimageMaximumSetGen() {
const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
const vmScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaaa";
const vmScaleSetReimageInput = {
forceUpdateOSDiskForEphemeral: true,
instanceIds: ["aaaaaaaaaa"],
tempDisk: true,
};
const options = {
vmScaleSetReimageInput,
};
const credential = new DefaultAzureCredential();
const client = new ComputeManagementClient(credential, subscriptionId);
const result = await client.virtualMachineScaleSets.beginReimageAndWait(
resourceGroupName,
vmScaleSetName,
options,
);
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
Sample Response
location: https://foo.com/operationstatus
VirtualMachineScaleSet_Reimage_MinimumSet_Gen
Sample Request
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaaaa/reimage?api-version=2024-03-01
from azure.identity import DefaultAzureCredential
from azure.mgmt.compute import ComputeManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-compute
# USAGE
python virtual_machine_scale_set_reimage_minimum_set_gen.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 = ComputeManagementClient(
credential=DefaultAzureCredential(),
subscription_id="{subscription-id}",
)
client.virtual_machine_scale_sets.begin_reimage(
resource_group_name="rgcompute",
vm_scale_set_name="aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
).result()
# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.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
package armcompute_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_BeginReimage_virtualMachineScaleSetReimageMinimumSetGen() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewVirtualMachineScaleSetsClient().BeginReimage(ctx, "rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", &armcompute.VirtualMachineScaleSetsClientBeginReimageOptions{VMScaleSetReimageInput: nil})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.
*
* @summary Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.
* x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json
*/
async function virtualMachineScaleSetReimageMinimumSetGen() {
const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
const vmScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaaaaa";
const credential = new DefaultAzureCredential();
const client = new ComputeManagementClient(credential, subscriptionId);
const result = await client.virtualMachineScaleSets.beginReimageAndWait(
resourceGroupName,
vmScaleSetName,
);
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
Sample Response
location: https://foo.com/operationstatus
定義
ApiError
API エラー。
名前 |
型 |
説明 |
code
|
string
|
エラー コード。
|
details
|
ApiErrorBase[]
|
Api エラーの詳細
|
innererror
|
InnerError
|
Api の内部エラー
|
message
|
string
|
エラー メッセージ。
|
target
|
string
|
特定のエラーのターゲット。
|
ApiErrorBase
API エラーベース。
名前 |
型 |
説明 |
code
|
string
|
エラー コード。
|
message
|
string
|
エラー メッセージ。
|
target
|
string
|
特定のエラーのターゲット。
|
CloudError
コンピューティング サービスからのエラー応答。
InnerError
内部エラーの詳細。
名前 |
型 |
説明 |
errordetail
|
string
|
内部エラー メッセージまたは例外ダンプ。
|
exceptiontype
|
string
|
例外の種類。
|
OSProfileProvisioningData
非エフェメラル仮想マシンを再イメージ化するための追加パラメーター。
名前 |
型 |
説明 |
adminPassword
|
string
|
管理者アカウントのパスワードを指定します。
最小長 (Windows): 8 文字
最小長 (Linux): 6 文字
最大長 (Windows): 123 文字
最大長 (Linux): 72 文字
複雑さの要件: 以下の 4 つの条件のうち 3 つを満たす必要がある 文字が小さい 上の文字を含む 数字を含む 特殊文字を含む (正規表現の一致 [\W_])
許可されていない値: "abc@123"、"P@$$w 0rd"、"P@ssw0rd"、"P@ssword123"、"Pa$$word"、"pass@word1"、"Password!"、"Password1"、"Password22"、"iloveyou!"
パスワードをリセットする方法については、「Windows VM でリモート デスクトップ サービスまたはそのログイン パスワードをリセットする方法」を参照してください。
ルート パスワードをリセットする方法については、「VMAccess 拡張機能を使用して Azure Linux VM 上のディスクを管理、SSH、チェックまたは修復する」を参照してください。
|
customData
|
string
|
カスタム データの Base 64 エンコード文字列を指定します。 Base 64 エンコード文字列は、仮想マシン上にファイルとして保存されるバイナリ配列にデコードされます。 バイナリ配列の長さは最大 65535 バイトです。 注: customData プロパティでシークレットまたはパスワードを渡さないでください。 このプロパティは、VM の作成後に更新できません。 プロパティ customData は、ファイルとして保存される VM に渡されます。詳細については、「 Azure VM 上のカスタム データ」を参照してください。 Linux VM に cloud-init を使用する場合は、「 cloud-init を使用して作成時に Linux VM をカスタマイズする」を参照してください。
|
VirtualMachineScaleSetReimageParameters
仮想マシン スケール セット VM の再イメージ化パラメーターについて説明します。
名前 |
型 |
説明 |
exactVersion
|
string
|
OS ディスクを再イメージ化するバージョンを 10 進数で指定します。 正確なバージョンが指定されていない場合、OS ディスクは既存のバージョンの OS ディスクに再イメージ化されます。
|
forceUpdateOSDiskForEphemeral
|
boolean
|
仮想マシン スケール セット VM のエフェメラル OS ディスクを強制的に更新するためのパラメーター
|
instanceIds
|
string[]
|
仮想マシン スケール セットのインスタンス ID。 仮想マシン スケール セットのインスタンス ID を省略すると、仮想マシン スケール セット内のすべての仮想マシンで操作が実行されます。
|
osProfile
|
OSProfileProvisioningData
|
非エフェメラル OS ディスクの再イメージ化に必要な情報を指定します。
|
tempDisk
|
boolean
|
一時ディスクを再イメージ化するかどうかを指定します。 既定値: false 注: この一時ディスク再イメージ化パラメーターは、エフェメラル OS ディスクを使用した VM/VMSS でのみサポートされます。
|