Restore Points - Create

リファレンス

Service:: Compute

API Version:: 2024-03-01

復元ポイントを作成する操作。既存の復元ポイントのプロパティの更新は許可されていません

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}?api-version=2024-03-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。
restorePointCollectionName	path	True	string	復元ポイントコレクションの名前。
restorePointName	path	True	string	復元ポイントの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	型	説明
properties.consistencyMode	ConsistencyModeTypes	RestorePoint の ConsistencyMode。復元ポイントの作成時に入力で指定できます。現時点では、CrashConsistent のみが有効な入力として受け入れられます。詳細については、を https://aka.ms/RestorePoints 参照してください。
properties.excludeDisks	ApiEntityReference[]	お客様が復元ポイントから除外するディスクリソース ID の一覧。ディスクが指定されていない場合は、すべてのディスクが含まれます。
properties.sourceMetadata	RestorePointSourceMetadata	復元ポイントの作成時にキャプチャされた VM の詳細を取得します。
properties.sourceRestorePoint	ApiEntityReference	コピーを作成する必要があるソース復元ポイントのリソース ID。
properties.timeCreated	string	復元ポイントの作成時刻を取得します。

応答

名前	型	説明
201 Created	RestorePoint	作成済み
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	ユーザーアカウントの借用

例

Copy a restore point to a different region

Create a restore point

Copy a restore point to a different region

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?api-version=2024-03-01

{
  "properties": {
    "sourceRestorePoint": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
    }
  }
}


import com.azure.resourcemanager.compute.fluent.models.RestorePointInner;
import com.azure.resourcemanager.compute.models.ApiEntityReference;

/**
 * Samples for RestorePoints Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * restorePointExamples/RestorePoint_Copy_BetweenRegions.json
     */
    /**
     * Sample code: Copy a restore point to a different region.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void copyARestorePointToADifferentRegion(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getRestorePoints().create("myResourceGroup", "rpcName",
            "rpName",
            new RestorePointInner().withSourceRestorePoint(new ApiEntityReference().withId(
                "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName")),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python restore_point_copy_between_regions.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}",
    )

    response = client.restore_points.begin_create(
        resource_group_name="myResourceGroup",
        restore_point_collection_name="rpcName",
        restore_point_name="rpName",
        parameters={
            "properties": {
                "sourceRestorePoint": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePoint_Copy_BetweenRegions.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/restorePointExamples/RestorePoint_Copy_BetweenRegions.json
func ExampleRestorePointsClient_BeginCreate_copyARestorePointToADifferentRegion() {
	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.NewRestorePointsClient().BeginCreate(ctx, "myResourceGroup", "rpcName", "rpName", armcompute.RestorePoint{
		Properties: &armcompute.RestorePointProperties{
			SourceRestorePoint: &armcompute.APIEntityReference{
				ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"),
			},
		},
	}, 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 The operation to create the restore point. Updating properties of an existing restore point is not allowed
 *
 * @summary The operation to create the restore point. Updating properties of an existing restore point is not allowed
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePoint_Copy_BetweenRegions.json
 */
async function copyARestorePointToADifferentRegion() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const restorePointCollectionName = "rpcName";
  const restorePointName = "rpName";
  const parameters = {
    sourceRestorePoint: {
      id: "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.restorePoints.beginCreateAndWait(
    resourceGroupName,
    restorePointCollectionName,
    restorePointName,
    parameters,
  );
  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

Status code:: 201

{
  "name": "rpName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
  "properties": {
    "sourceRestorePoint": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName"
    },
    "sourceMetadata": {
      "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
      "hardwareProfile": {
        "vmSize": "Standard_B1s"
      },
      "storageProfile": {
        "osDisk": {
          "osType": "Windows",
          "name": "osDisk123",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123"
          },
          "diskRestorePoint": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
          }
        },
        "dataDisks": [
          {
            "lun": 1,
            "name": "dataDisk123",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123"
            },
            "diskRestorePoint": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_68785190-1acb-4d5e-a8ae-705b45f3dca5"
            }
          }
        ],
        "diskControllerType": "NVMe"
      },
      "osProfile": {
        "computerName": "computerName",
        "adminUsername": "admin",
        "windowsConfiguration": {
          "provisionVMAgent": true,
          "enableAutomaticUpdates": true
        },
        "secrets": [],
        "allowExtensionOperations": true,
        "requireGuestProvisionSignal": true
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": true
        }
      },
      "location": "westus",
      "userData": "c2FtcGxlIHVzZXJEYXRh"
    },
    "provisioningState": "Creating",
    "consistencyMode": "ApplicationConsistent",
    "timeCreated": "2021-10-25T23:54:29.2796325+00:00"
  }
}

Create a restore point

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName?api-version=2024-03-01

{
  "properties": {
    "excludeDisks": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
      }
    ]
  }
}


import com.azure.resourcemanager.compute.fluent.models.RestorePointInner;
import com.azure.resourcemanager.compute.models.ApiEntityReference;
import java.util.Arrays;

/**
 * Samples for RestorePoints Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * restorePointExamples/RestorePoint_Create.json
     */
    /**
     * Sample code: Create a restore point.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createARestorePoint(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getRestorePoints().create("myResourceGroup", "rpcName",
            "rpName",
            new RestorePointInner().withExcludeDisks(Arrays.asList(new ApiEntityReference().withId(
                "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"))),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python restore_point_create.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}",
    )

    response = client.restore_points.begin_create(
        resource_group_name="myResourceGroup",
        restore_point_collection_name="rpcName",
        restore_point_name="rpName",
        parameters={
            "properties": {
                "excludeDisks": [
                    {
                        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
                    }
                ]
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePoint_Create.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/restorePointExamples/RestorePoint_Create.json
func ExampleRestorePointsClient_BeginCreate_createARestorePoint() {
	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.NewRestorePointsClient().BeginCreate(ctx, "myResourceGroup", "rpcName", "rpName", armcompute.RestorePoint{
		Properties: &armcompute.RestorePointProperties{
			ExcludeDisks: []*armcompute.APIEntityReference{
				{
					ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"),
				}},
		},
	}, 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 The operation to create the restore point. Updating properties of an existing restore point is not allowed
 *
 * @summary The operation to create the restore point. Updating properties of an existing restore point is not allowed
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/restorePointExamples/RestorePoint_Create.json
 */
async function createARestorePoint() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const restorePointCollectionName = "rpcName";
  const restorePointName = "rpName";
  const parameters = {
    excludeDisks: [
      {
        id: "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.restorePoints.beginCreateAndWait(
    resourceGroupName,
    restorePointCollectionName,
    restorePointName,
    parameters,
  );
  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

Status code:: 201

{
  "name": "rpName",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName",
  "properties": {
    "excludeDisks": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123"
      }
    ],
    "sourceMetadata": {
      "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7",
      "hardwareProfile": {
        "vmSize": "Standard_B1s"
      },
      "storageProfile": {
        "osDisk": {
          "osType": "Windows",
          "name": "osDisk123",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123"
          },
          "diskRestorePoint": {
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
          }
        },
        "dataDisks": [
          {
            "lun": 1,
            "name": "dataDisk123",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123"
            },
            "diskRestorePoint": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_68785190-1acb-4d5e-a8ae-705b45f3dca5"
            }
          }
        ],
        "diskControllerType": "NVMe"
      },
      "osProfile": {
        "computerName": "computerName",
        "adminUsername": "admin",
        "windowsConfiguration": {
          "provisionVMAgent": true,
          "enableAutomaticUpdates": true
        },
        "secrets": [],
        "allowExtensionOperations": true,
        "requireGuestProvisionSignal": true
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": true
        }
      },
      "location": "westus",
      "userData": "c2FtcGxlIHVzZXJEYXRh"
    },
    "provisioningState": "Succeeded",
    "consistencyMode": "ApplicationConsistent",
    "timeCreated": "2021-01-27T20:35:05.8401519+00:00"
  }
}

定義

名前	説明
AdditionalUnattendContent	Windows セットアップで使用される Unattend.xml ファイルに含めることができる追加の XML 形式の情報を指定します。コンテンツは、名前、コンポーネント名、およびコンテンツが適用されるパスを設定することによって定義されます。
ApiEntityReference	API エンティティ参照。
ApiError	API エラー。
ApiErrorBase	API エラーベース。
BootDiagnostics	ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。コンソールログの出力を簡単に表示できます。 Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。
CachingTypes	キャッシュの種類を取得します。
CloudError	コンピューティングサービスからのエラー応答。
ComponentNames	コンポーネントの名前。現在、許容される値は Microsoft-Windows-Shell-Setup のみです。
ConsistencyModeTypes	RestorePoint の ConsistencyMode。復元ポイントの作成時に入力で指定できます。現時点では、有効な入力として受け入れられるのは CrashConsistent のみです。詳細については、を https://aka.ms/RestorePoints 参照してください。
DiagnosticsProfile	ブート診断設定の状態を指定します。最小 api-version: 2015-06-15。
DiskControllerTypes	復元ポイントの作成時にキャプチャされた VM のディスクコントローラーの種類を取得します。
DiskEncryptionSetParameters	ディスクに指定できるカスタマーマネージドディスク暗号化セットリソース ID のパラメーターについて説明します。メモ：ディスク暗号化セットのリソース ID は、マネージドディスクにのみ指定できます。詳細については、こちらを参照 https://aka.ms/mdssewithcmkoverview してください。
DiskEncryptionSettings	ディスクの暗号化設定について説明します
DiskRestorePointAttributes	ディスク復元ポイントの詳細。
DiskRestorePointInstanceView	ディスク復元ポイントのインスタンスビュー。
DiskRestorePointReplicationStatus	ディスク復元ポイントのインスタンスビュー。
EncryptionIdentity	Keyvault 操作のアクセストークンを取得するために ADE によって使用されるマネージド ID を指定します。
HardwareProfile	仮想マシンのハードウェア設定を指定します。
HyperVGenerationTypes	復元ポイントがキャプチャされるソース VM の HyperVGeneration。
InnerError	内部エラーの詳細。
InstanceViewStatus	インスタンスビューの状態。
KeyVaultKeyReference	Key Vault キーへの参照について説明します
KeyVaultSecretReference	Key Vault シークレットへの参照について説明します
LinuxConfiguration	仮想マシン上の Linux オペレーティングシステムの設定を指定します。サポートされている Linux ディストリビューションの一覧については、「 Linux on Azure-Endorsed Distributions」を参照してください。
LinuxPatchAssessmentMode	IaaS 仮想マシンの VM ゲストパッチ評価のモードを指定します。次のいずれかの値になります。 ImageDefault - 仮想マシンでのパッチ評価のタイミングを制御します。 AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。プロパティ provisionVMAgent は true である必要があります。
LinuxPatchSettings	Linux での VM ゲストパッチ適用に関連する設定を指定します。
LinuxVMGuestPatchAutomaticByPlatformRebootSetting	すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。
LinuxVMGuestPatchAutomaticByPlatformSettings	Linux パッチ設定でパッチモード AutomaticByPlatform が選択されている場合に適用される追加の設定を指定します。
LinuxVMGuestPatchMode	OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシンスケールセットに関連付けられている仮想マシンへの VM ゲストパッチ適用のモードを指定します。次のいずれかの値になります。 ImageDefault - 仮想マシンの既定の修正プログラムの構成が使用されます。 AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。プロパティ provisionVMAgent は true である必要があります
ManagedDiskParameters	マネージドディスクのパラメーター。
Mode	機能が有効になっている場合に ProxyAgent が実行するモードを指定します。 ProxyAgent は監査または監視を開始しますが、監査モードでホストエンドポイントへの要求に対するアクセス制御を適用しませんが、強制モードではアクセス制御を適用します。既定値は [強制モード] です。
OperatingSystemType	オペレーティングシステムの種類を取得します。
OSProfile	仮想マシンのオペレーティングシステム設定を指定します。一部の設定は、VM をプロビジョニングした後は変更できません。
PassNames	パス名。現在、許容される値は OobeSystem のみです。
PatchSettings	Windows での VM ゲストパッチ適用に関連する設定を指定します。
ProtocolTypes	WinRM リスナーのプロトコルを指定します。指定できる値は http、https です。
ProxyAgentSettings	仮想マシンの作成時に ProxyAgent 設定を指定します。最小 api-version: 2024-03-01。
RestorePoint	復元ポイントの詳細。
RestorePointEncryption	ディスク復元ポイントの保存時の暗号化設定。これは、復元ポイントの作成時に入力で指定できる省略可能なプロパティです。
RestorePointEncryptionType	ディスク復元ポイントのデータを暗号化するために使用されるキーの種類。
RestorePointInstanceView	復元ポイントのインスタンスビュー。
RestorePointSourceMetadata	復元ポイントが作成された仮想マシンのプロパティについて説明します。提供されるプロパティは、復元ポイントの作成時にキャプチャされた仮想マシンの全体的なプロパティのサブセットとスナップショットです。
RestorePointSourceVMDataDisk	データディスクについて説明します。
RestorePointSourceVMOSDisk	オペレーティングシステムディスクについて説明します。
RestorePointSourceVMStorageProfile	ストレージプロファイルについて説明します。
securityEncryptionTypes	マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB と共にマネージドディスクを暗号化するには DiskWithVMGuestState、VMGuestState BLOB のみの暗号化には VMGuestStateOnly、VMGuestState BLOB にファームウェア状態を保持しない場合は NonPersistedTPM に設定されます。メモ：これは、機密 VM にのみ設定できます。
SecurityProfile	仮想マシンまたは仮想マシンスケールセットのセキュリティプロファイル設定を指定します。
SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。既定の動作は次のとおりです。このプロパティが設定されていない限り、UefiSettings は有効になりません。
SettingNames	コンテンツが適用される設定の名前を指定します。使用できる値は、FirstLogonCommands と AutoLogon です。
SshConfiguration	Azure で実行されている Linux ベースの VM の SSH 構成
SshPublicKey	SSH 証明書の公開キーと、公開キーが配置されている Linux VM 上のパスに関する情報が含まれています。
StatusLevelTypes	レベルコード。
StorageAccountTypes	マネージドディスクのストレージアカウントの種類を指定します。注: UltraSSD_LRSはデータディスクでのみ使用できます。OS ディスクでは使用できません。
SubResource
UefiSettings	仮想マシンの作成時に使用されるセキュアブートや vTPM などのセキュリティ設定を指定します。最小 api-version: 2020-12-01。
VaultCertificate	Key Vault内の 1 つの証明書参照と、証明書が VM 上に存在する場所について説明します。
VaultSecretGroup	すべて同じKey Vault内にある証明書のセットについて説明します。
VirtualMachineSizeTypes	仮想マシンのサイズを指定します。列挙型データ型は現在非推奨であり、2023 年 12 月 23 日までに削除される予定です。使用可能なサイズの一覧を取得するには、次の API を使用することをお勧めします。可用性セットで使用可能なすべての仮想マシンサイズの一覧表示、リージョンで使用可能なすべての仮想マシンサイズの一覧表示、サイズ変更のために使用可能なすべての仮想マシンサイズの一覧表示。仮想マシンのサイズの詳細については、「仮想マシンのサイズ」を参照してください。使用可能な VM サイズは、リージョンと可用性セットによって異なります。
VMDiskSecurityProfile	マネージドディスクのセキュリティプロファイル設定を指定します。メモ：これは、機密 VM に対してのみ設定できます。
VMSizeProperties	仮想マシンの VM サイズプロパティの設定を指定します。
WindowsConfiguration	仮想マシン上の Windows オペレーティングシステムの設定を指定します。
WindowsPatchAssessmentMode	IaaS 仮想マシンの VM ゲストパッチ評価のモードを指定します。次のいずれかの値になります。 ImageDefault - 仮想マシンでのパッチ評価のタイミングを制御します。 AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。プロパティ provisionVMAgent は true である必要があります。
WindowsVMGuestPatchAutomaticByPlatformRebootSetting	すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。
WindowsVMGuestPatchAutomaticByPlatformSettings	Windows パッチ設定でパッチモード AutomaticByPlatform が選択されている場合に適用される追加の設定を指定します。
WindowsVMGuestPatchMode	OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシンスケールセットに関連付けられている仮想マシンへの VM ゲストパッチ適用のモードを指定します。次のいずれかの値になります。手動 - 仮想マシンへのパッチの適用を制御します。これを行うには、VM 内でパッチを手動で適用します。このモードでは、自動更新は無効になります。プロパティ WindowsConfiguration.enableAutomaticUpdates は false にする必要があります AutomaticByOS - 仮想マシンは OS によって自動的に更新されます。プロパティ WindowsConfiguration.enableAutomaticUpdates は true である必要があります。 AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。プロパティ provisionVMAgent と WindowsConfiguration.enableAutomaticUpdates は true である必要があります
WinRMConfiguration	VM の Windows リモート管理の構成について説明します
WinRMListener	Windows リモート管理リスナーのプロトコルと拇印について説明します

AdditionalUnattendContent

Windows セットアップで使用される Unattend.xml ファイルに含めることができる追加の XML 形式の情報を指定します。コンテンツは、名前、コンポーネント名、およびコンテンツが適用されるパスを設定することによって定義されます。

名前	型	説明
componentName	ComponentNames	コンポーネントの名前。現在、許容される値は Microsoft-Windows-Shell-Setup のみです。
content	string	指定したパスとコンポーネントの unattend.xml ファイルに追加される XML 形式のコンテンツを指定します。 XML は 4 KB 未満である必要があり、挿入される設定または機能のルート要素を含める必要があります。
passName	PassNames	パス名。現在、許容される値は OobeSystem のみです。
settingName	SettingNames	コンテンツが適用される設定の名前を指定します。使用できる値は、FirstLogonCommands と AutoLogon です。

ApiEntityReference

API エンティティ参照。

名前	型	説明
id	string	/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..の形式の ARM リソース ID。

ApiError

API エラー。

名前	型	説明
code	string	エラーコード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api の内部エラー
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

API エラーベース。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

BootDiagnostics

ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。コンソールログの出力を簡単に表示できます。 Azure では、ハイパーバイザーから VM のスクリーンショットを表示することもできます。

名前	型	説明
enabled	boolean	仮想マシンでブート診断を有効にする必要があるかどうか。
storageUri	string	コンソール出力とスクリーンショットを配置するために使用するストレージアカウントの URI。ブート診断を有効にするときに storageUri が指定されていない場合は、マネージドストレージが使用されます。

CachingTypes

キャッシュの種類を取得します。

名前	型	説明
None	string
ReadOnly	string
ReadWrite	string

CloudError

コンピューティングサービスからのエラー応答。

名前	型	説明
error	ApiError	API エラー。

ComponentNames

コンポーネントの名前。現在、許容される値は Microsoft-Windows-Shell-Setup のみです。

名前	型	説明
Microsoft-Windows-Shell-Setup	string

ConsistencyModeTypes

RestorePoint の ConsistencyMode。復元ポイントの作成時に入力で指定できます。現時点では、有効な入力として受け入れられるのは CrashConsistent のみです。詳細については、を https://aka.ms/RestorePoints 参照してください。

名前	型	説明
ApplicationConsistent	string
CrashConsistent	string
FileSystemConsistent	string

DiagnosticsProfile

ブート診断設定の状態を指定します。最小 api-version: 2015-06-15。

名前	型	説明
bootDiagnostics	BootDiagnostics	ブート診断は、コンソール出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。注: storageUri が指定されている場合は、ストレージアカウントが VM と同じリージョンとサブスクリプションにあることを確認します。コンソールログの出力を簡単に表示できます。 Azure では、ハイパーバイザーからの VM のスクリーンショットも表示できます。

DiskControllerTypes

復元ポイントの作成時にキャプチャされた VM のディスクコントローラーの種類を取得します。

名前	型	説明
NVMe	string
SCSI	string

DiskEncryptionSetParameters

ディスクに指定できるカスタマーマネージドディスク暗号化セットリソース ID のパラメーターについて説明します。 メモ： ディスク暗号化セットのリソース ID は、マネージドディスクにのみ指定できます。詳細については、こちらを参照 https://aka.ms/mdssewithcmkoverview してください。

名前	型	説明
id	string	リソース ID

DiskEncryptionSettings

ディスクの暗号化設定について説明します

名前	型	説明
diskEncryptionKey	KeyVaultSecretReference	Key Vault シークレットであるディスク暗号化キーの場所を指定します。
enabled	boolean	仮想マシンでディスク暗号化を有効にするかどうかを指定します。
keyEncryptionKey	KeyVaultKeyReference	Key Vault内のキー暗号化キーの場所を指定します。

DiskRestorePointAttributes

ディスク復元ポイントの詳細。

名前	型	説明
encryption	RestorePointEncryption	ディスク復元ポイントの保存時の暗号化設定。これは、復元ポイントの作成時に入力で指定できる省略可能なプロパティです。
id	string	リソース ID
sourceDiskRestorePoint	ApiEntityReference	ソースディスク復元ポイントのリソース ID。

DiskRestorePointInstanceView

ディスク復元ポイントのインスタンスビュー。

名前	型	説明
id	string	ディスク復元ポイント ID。
replicationStatus	DiskRestorePointReplicationStatus	ディスク復元ポイントのレプリケーションの状態情報。

DiskRestorePointReplicationStatus

ディスク復元ポイントのインスタンスビュー。

名前	型	説明
completionPercent	integer	レプリケーションの完了率。
status	InstanceViewStatus	リソースの状態情報。

EncryptionIdentity

Keyvault 操作のアクセストークンを取得するために ADE によって使用されるマネージド ID を指定します。

名前	型	説明
userAssignedIdentityResourceId	string	VM に関連付けられているいずれかのユーザー ID の ARM リソース ID を指定します。

HardwareProfile

仮想マシンのハードウェア設定を指定します。

名前	型	説明
vmSize	VirtualMachineSizeTypes	仮想マシンのサイズを指定します。列挙型データ型は現在非推奨であり、2023 年 12 月 23 日までに削除されます。使用可能なサイズの一覧を取得するには、次の API を使用することをお勧めします。可用性セットで使用可能なすべての仮想マシンサイズを一覧表示する、リージョンで使用可能なすべての仮想マシンサイズを一覧表示する、サイズ変更に使用できるすべての仮想マシンサイズを一覧表示する。仮想マシンのサイズの詳細については、「仮想マシンのサイズ」を参照してください。使用可能な VM サイズは、リージョンと可用性セットによって異なります。
vmSizeProperties	VMSizeProperties	仮想マシンのサイズをカスタマイズするためのプロパティを指定します。最小 api-version: 2021-07-01。この機能はまだプレビューモードであり、VirtualMachineScaleSet ではサポートされていません。詳細については、「VM のカスタマイズ」の手順に従ってください。

HyperVGenerationTypes

復元ポイントがキャプチャされるソース VM の HyperVGeneration。

名前	型	説明
V1	string
V2	string

InnerError

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラーメッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

InstanceViewStatus

インスタンスビューの状態。

名前	型	説明
code	string	ステータスコード。
displayStatus	string	状態の短いローカライズ可能なラベル。
level	StatusLevelTypes	レベルコード。
message	string	アラートやエラーメッセージを含む詳細なステータスメッセージ。
time	string	状態の時刻。

KeyVaultKeyReference

Key Vault キーへの参照について説明します

名前	型	説明
keyUrl	string	Key Vaultのキー暗号化キーを参照する URL。
sourceVault	SubResource	キーを含むKey Vaultの相対 URL。

KeyVaultSecretReference

Key Vault シークレットへの参照について説明します

名前	型	説明
secretUrl	string	Key Vault内のシークレットを参照する URL。
sourceVault	SubResource	シークレットを含むKey Vaultの相対 URL。

LinuxConfiguration

仮想マシン上の Linux オペレーティングシステムの設定を指定します。サポートされている Linux ディストリビューションの一覧については、「 Linux on Azure-Endorsed Distributions」を参照してください。

名前	型	説明
disablePasswordAuthentication	boolean	パスワード認証を無効にするかどうかを指定します。
enableVMAgentPlatformUpdates	boolean	Linux 仮想マシンに対して VMAgent Platform Updatesが有効かどうかを示します。既定値は false です。
patchSettings	LinuxPatchSettings	[プレビュー機能]Linux での VM ゲストパッチ適用に関連する設定を指定します。
provisionVMAgent	boolean	仮想マシン上に仮想マシンエージェントをプロビジョニングするかどうかを示します。このプロパティが要求本文で指定されていない場合、既定の動作では true に設定されます。これにより、VM エージェントが VM にインストールされ、後で拡張機能を VM に追加できるようになります。
ssh	SshConfiguration	Linux OS の SSH キーの構成を指定します。

LinuxPatchAssessmentMode

IaaS 仮想マシンの VM ゲストパッチ評価のモードを指定します。

次のいずれかの値になります。

ImageDefault - 仮想マシンでのパッチ評価のタイミングを制御します。

AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。プロパティ provisionVMAgent は true である必要があります。

名前	型	説明
AutomaticByPlatform	string
ImageDefault	string

LinuxPatchSettings

Linux での VM ゲストパッチ適用に関連する設定を指定します。

名前	型	説明
assessmentMode	LinuxPatchAssessmentMode	IaaS 仮想マシンの VM ゲストパッチ評価のモードを指定します。次のいずれかの値になります。 ImageDefault - 仮想マシンでのパッチ評価のタイミングを制御します。 AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。プロパティ provisionVMAgent は true である必要があります。
automaticByPlatformSettings	LinuxVMGuestPatchAutomaticByPlatformSettings	Linux 上の VM ゲストパッチ適用でのパッチモード AutomaticByPlatform の追加設定を指定します。
patchMode	LinuxVMGuestPatchMode	OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシンスケールセットに関連付けられている仮想マシンへの VM ゲストパッチ適用のモードを指定します。次のいずれかの値になります。 ImageDefault - 仮想マシンの既定の修正プログラムの構成が使用されます。 AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。プロパティ provisionVMAgent は true である必要があります

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。

名前	型	説明
Always	string
IfRequired	string
Never	string
Unknown	string

LinuxVMGuestPatchAutomaticByPlatformSettings

Linux パッチ設定でパッチモード AutomaticByPlatform が選択されている場合に適用される追加の設定を指定します。

名前	型	説明
bypassPlatformSafetyChecksOnUserSchedule	boolean	お客様が誤ってアップグレードすることなく修正プログラムの適用をスケジュールできるようにします
rebootSetting	LinuxVMGuestPatchAutomaticByPlatformRebootSetting	すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。

LinuxVMGuestPatchMode

OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシンスケールセットに関連付けられている仮想マシンへの VM ゲストパッチ適用のモードを指定します。

次のいずれかの値になります。

ImageDefault - 仮想マシンの既定の修正プログラムの構成が使用されます。

AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。プロパティ provisionVMAgent は true である必要があります

名前	型	説明
AutomaticByPlatform	string
ImageDefault	string

ManagedDiskParameters

マネージドディスクのパラメーター。

名前	型	説明
diskEncryptionSet	DiskEncryptionSetParameters	マネージドディスクのカスタマーマネージドディスク暗号化セットリソース ID を指定します。
id	string	リソース ID
securityProfile	VMDiskSecurityProfile	マネージドディスクのセキュリティプロファイルを指定します。
storageAccountType	StorageAccountTypes	マネージドディスクのストレージアカウントの種類を指定します。注: UltraSSD_LRSはデータディスクでのみ使用できます。OS ディスクでは使用できません。

Mode

機能が有効になっている場合に ProxyAgent が実行するモードを指定します。 ProxyAgent は監査または監視を開始しますが、監査モードでホストエンドポイントへの要求に対するアクセス制御を適用しませんが、強制モードではアクセス制御を適用します。既定値は [強制モード] です。

名前	型	説明
Audit	string
Enforce	string

OperatingSystemType

オペレーティングシステムの種類を取得します。

名前	型	説明
Linux	string
Windows	string

OSProfile

仮想マシンのオペレーティングシステム設定を指定します。一部の設定は、VM をプロビジョニングした後は変更できません。

名前	型	説明
adminPassword	string	管理者アカウントのパスワードを指定します。最小長 (Windows): 8 文字最小長 (Linux): 6 文字最大長 (Windows): 123 文字最大長 (Linux): 72 文字複雑さの要件: 以下の 4 つの条件のうち 3 つを満たす必要がある文字が小さい上の文字を含む数字を含む特殊文字があります (Regex match [\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、チェックまたは修復する」を参照してください。
adminUsername	string	管理者アカウントの名前を指定します。このプロパティは、VM の作成後に更新できません。 Windows のみの制限: "." で終わることはできません。許可されていない値: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1"、"123"、"a"、"actuser"、"adm"、"admin2"、"aspnet"、"backup"、"console"、"david"、"guest"、"john"、"owner"、"root"、"server"、"sql"、"support"、"support_388945a0"、"sys"、"test2"、"test3"、"user4"、"user5"。最小長 (Linux): 1 文字最大長 (Linux): 64 文字最大長 (Windows): 20 文字。
allowExtensionOperations	boolean	仮想マシンで拡張機能の操作を許可するかどうかを指定します。これは、仮想マシンに拡張機能が存在しない場合にのみ False に設定できます。
computerName	string	仮想マシンのホスト OS 名を指定します。 VM の作成後にこの名前を更新することはできません。最大長 (Windows): 15 文字。最大長 (Linux): 64 文字。名前付け規則と制限については、「 Azure インフラストラクチャサービスの実装ガイドライン」を参照してください。
customData	string	カスタムデータの Base 64 エンコード文字列を指定します。 Base 64 エンコード文字列は、仮想マシン上にファイルとして保存されるバイナリ配列にデコードされます。バイナリ配列の長さは最大 65535 バイトです。注: customData プロパティにシークレットまたはパスワードを渡さないでください。このプロパティは、VM の作成後に更新できません。プロパティ 'customData' は、ファイルとして保存される VM に渡されます。詳細については、「 Azure VM 上のカスタムデータ」を参照してください。 Linux VM に cloud-init を使用する場合は、「 cloud-init を使用して作成時に Linux VM をカスタマイズする」を参照してください。
linuxConfiguration	LinuxConfiguration	仮想マシン上の Linux オペレーティングシステムの設定を指定します。サポートされている Linux ディストリビューションの一覧については、「Linux on Azure-Endorsed Distributions」を参照してください。
requireGuestProvisionSignal	boolean	True に設定するか、省略する必要がある省略可能なプロパティ。
secrets	VaultSecretGroup[]	仮想マシンにインストールする必要がある証明書のセットを指定します。仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault仮想マシン拡張機能を使用することをお勧めします。
windowsConfiguration	WindowsConfiguration	仮想マシン上の Windows オペレーティングシステムの設定を指定します。

PassNames

パス名。現在、許容される値は OobeSystem のみです。

名前	型	説明
OobeSystem	string

PatchSettings

Windows での VM ゲストパッチ適用に関連する設定を指定します。

名前	型	説明
assessmentMode	WindowsPatchAssessmentMode	IaaS 仮想マシンの VM ゲストパッチ評価のモードを指定します。次のいずれかの値になります。 ImageDefault - 仮想マシンでのパッチ評価のタイミングを制御します。 AutomaticByPlatform - プラットフォームは定期的なパッチ評価をトリガーします。プロパティ provisionVMAgent は true である必要があります。
automaticByPlatformSettings	WindowsVMGuestPatchAutomaticByPlatformSettings	Windows 上の VM ゲスト修正プログラムの修正プログラムモード AutomaticByPlatform の追加設定を指定します。
enableHotpatching	boolean	再起動を必要とせずに、お客様が Azure VM にパッチを適用できるようにします。 enableHotpatching の場合、'provisionVMAgent' を true に設定し、'patchMode' を 'AutomaticByPlatform' に設定する必要があります。
patchMode	WindowsVMGuestPatchMode	OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシンスケールセットに関連付けられている仮想マシンへの VM ゲストパッチ適用のモードを指定します。次のいずれかの値になります。手動 - 仮想マシンへのパッチの適用を制御します。これを行うには、VM 内でパッチを手動で適用します。このモードでは、自動更新は無効になります。プロパティ WindowsConfiguration.enableAutomaticUpdates は false にする必要があります AutomaticByOS - 仮想マシンは OS によって自動的に更新されます。プロパティ WindowsConfiguration.enableAutomaticUpdates は true である必要があります。 AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。プロパティ provisionVMAgent と WindowsConfiguration.enableAutomaticUpdates は true である必要があります

ProtocolTypes

WinRM リスナーのプロトコルを指定します。指定できる値は http、https です。

名前	型	説明
Http	string
Https	string

ProxyAgentSettings

仮想マシンの作成時に ProxyAgent 設定を指定します。最小 api-version: 2024-03-01。

名前	型	説明
enabled	boolean	仮想マシンまたは仮想マシンスケールセットで ProxyAgent 機能を有効にするかどうかを指定します。
keyIncarnationId	integer	このプロパティの値を大きくすると、ユーザーはゲストとホストの間の通信チャネルをセキュリティで保護するために使用されるキーをリセットできます。
mode	Mode	機能が有効になっている場合に ProxyAgent が実行するモードを指定します。 ProxyAgent は監査または監視を開始しますが、監査モードでホストエンドポイントへの要求に対するアクセス制御を適用しませんが、強制モードではアクセス制御を適用します。既定値は [強制モード] です。

RestorePoint

復元ポイントの詳細。

名前	型	説明
id	string	リソース ID
name	string	リソース名
properties.consistencyMode	ConsistencyModeTypes	RestorePoint の ConsistencyMode。復元ポイントの作成時に入力で指定できます。現時点では、CrashConsistent のみが有効な入力として受け入れられます。詳細については、を https://aka.ms/RestorePoints 参照してください。
properties.excludeDisks	ApiEntityReference[]	お客様が復元ポイントから除外するディスクリソース ID の一覧。ディスクが指定されていない場合は、すべてのディスクが含まれます。
properties.instanceView	RestorePointInstanceView	復元ポイントインスタンスビュー。
properties.provisioningState	string	復元ポイントのプロビジョニング状態を取得します。
properties.sourceMetadata	RestorePointSourceMetadata	復元ポイントの作成時にキャプチャされた VM の詳細を取得します。
properties.sourceRestorePoint	ApiEntityReference	コピーを作成する必要があるソース復元ポイントのリソース ID。
properties.timeCreated	string	復元ポイントの作成時刻を取得します。
type	string	リソースの種類

RestorePointEncryption

ディスク復元ポイントの保存時の暗号化設定。これは、復元ポイントの作成時に入力で指定できる省略可能なプロパティです。

名前	型	説明
diskEncryptionSet	DiskEncryptionSetParameters	ディスクに指定できるカスタマーマネージドディスク暗号化セットリソース ID のパラメーターについて説明します。メモ：ディスク暗号化セットのリソース ID は、マネージドディスクにのみ指定できます。詳細については、こちらを参照 https://aka.ms/mdssewithcmkoverview してください。
type	RestorePointEncryptionType	ディスク復元ポイントのデータを暗号化するために使用されるキーの種類。

RestorePointEncryptionType

ディスク復元ポイントのデータを暗号化するために使用されるキーの種類。

名前	型	説明
EncryptionAtRestWithCustomerKey	string	ディスク復元ポイントは、顧客が変更および取り消すことができるカスタマーマネージドキーを使用して保存時に暗号化されます。
EncryptionAtRestWithPlatformAndCustomerKeys	string	ディスク復元ポイントは、2 層の暗号化を使用して保存時に暗号化されます。キーの 1 つはカスタマーマネージドで、もう 1 つのキーは Platform managed です。
EncryptionAtRestWithPlatformKey	string	ディスク復元ポイントは、プラットフォームマネージドキーを使用して保存時に暗号化されます。

RestorePointInstanceView

復元ポイントのインスタンスビュー。

名前	型	説明
diskRestorePoints	DiskRestorePointInstanceView[]	ディスク復元ポイントの情報。
statuses	InstanceViewStatus[]	リソースの状態情報。

RestorePointSourceMetadata

復元ポイントが作成された仮想マシンのプロパティについて説明します。提供されるプロパティは、復元ポイントの作成時にキャプチャされた仮想マシンの全体的なプロパティのサブセットとスナップショットです。

名前	型	説明
diagnosticsProfile	DiagnosticsProfile	診断プロファイルを取得します。
hardwareProfile	HardwareProfile	ハードウェアプロファイルを取得します。
hyperVGeneration	HyperVGenerationTypes	復元ポイントがキャプチャされるソース VM の HyperVGeneration。
licenseType	string	ライセンスの種類を取得します。これは、ライセンス持ち込みシナリオ用です。
location	string	復元ポイントが作成された VM の場所。
osProfile	OSProfile	OS プロファイルを取得します。
securityProfile	SecurityProfile	セキュリティプロファイルを取得します。
storageProfile	RestorePointSourceVMStorageProfile	ストレージプロファイルを取得します。
userData	string	復元ポイントがキャプチャされるソース VM に関連付けられている UserData 。これは base-64 でエンコードされた値です。
vmId	string	仮想マシンの一意の ID を取得します。

RestorePointSourceVMDataDisk

データディスクについて説明します。

名前	型	説明
caching	CachingTypes	キャッシュの種類を取得します。
diskRestorePoint	DiskRestorePointAttributes	ディスク復元ポイントのプロパティが含まれています。
diskSizeGB	integer	空のデータディスクの初期ディスクサイズ (GB)、および既存の OS ディスクとデータディスクの新しい目的のサイズを取得します。
lun	integer	論理ユニット番号を取得します。
managedDisk	ManagedDiskParameters	マネージドディスクの詳細を格納します。
name	string	ディスク名を取得します。
writeAcceleratorEnabled	boolean	ディスクが書き込みアクセラレータが有効になっている場合は true を表示します。

RestorePointSourceVMOSDisk

オペレーティングシステムディスクについて説明します。

名前	型	説明
caching	CachingTypes	キャッシュの種類を取得します。
diskRestorePoint	DiskRestorePointAttributes	ディスク復元ポイントのプロパティが含まれています。
diskSizeGB	integer	ディスクサイズを GB 単位で取得します。
encryptionSettings	DiskEncryptionSettings	ディスク暗号化設定を取得します。
managedDisk	ManagedDiskParameters	マネージドディスクの詳細を取得します
name	string	ディスク名を取得します。
osType	OperatingSystemType	オペレーティングシステムの種類を取得します。
writeAcceleratorEnabled	boolean	ディスクが書き込みアクセラレータが有効になっている場合は true を表示します。

RestorePointSourceVMStorageProfile

ストレージプロファイルについて説明します。

名前	型	説明
dataDisks	RestorePointSourceVMDataDisk[]	復元ポイントの作成時にキャプチャされた VM のデータディスクを取得します。
diskControllerType	DiskControllerTypes	復元ポイントの作成時にキャプチャされた VM のディスクコントローラーの種類を取得します。
osDisk	RestorePointSourceVMOSDisk	復元ポイントの作成時にキャプチャされた VM の OS ディスクを取得します。

securityEncryptionTypes

マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB と共にマネージドディスクを暗号化するには DiskWithVMGuestState、VMGuestState BLOB のみの暗号化には VMGuestStateOnly、VMGuestState BLOB にファームウェア状態を保持しない場合は NonPersistedTPM に設定されます。 メモ： これは、機密 VM にのみ設定できます。

名前	型	説明
DiskWithVMGuestState	string
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

仮想マシンまたは仮想マシンスケールセットのセキュリティプロファイル設定を指定します。

名前	型	説明
encryptionAtHost	boolean	このプロパティは、要求のユーザーが仮想マシンまたは仮想マシンスケールセットの Host Encryption を有効または無効にするために使用できます。これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。既定の動作は、リソースに対してこのプロパティが true に設定されていない限り、ホストでの暗号化は無効になります。
encryptionIdentity	EncryptionIdentity	Keyvault 操作のアクセストークンを取得するために ADE によって使用されるマネージド ID を指定します。
proxyAgentSettings	ProxyAgentSettings	仮想マシンの作成時に ProxyAgent 設定を指定します。最小 api-version: 2024-03-01。
securityType	SecurityTypes	仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。既定の動作は次のとおりです。このプロパティが設定されていない限り、UefiSettings は有効になりません。
uefiSettings	UefiSettings	仮想マシンの作成時に使用されるセキュアブートや vTPM などのセキュリティ設定を指定します。最小 api-version: 2020-12-01。

SecurityTypes

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、指定した値に設定する必要があります。既定の動作は次のとおりです。このプロパティが設定されていない限り、UefiSettings は有効になりません。

名前	型	説明
ConfidentialVM	string
TrustedLaunch	string

SettingNames

コンテンツが適用される設定の名前を指定します。使用できる値は、FirstLogonCommands と AutoLogon です。

名前	型	説明
AutoLogon	string
FirstLogonCommands	string

SshConfiguration

Azure で実行されている Linux ベースの VM の SSH 構成

名前	型	説明
publicKeys	SshPublicKey[]	Linux ベースの VM で認証するために使用される SSH 公開キーの一覧。

SshPublicKey

SSH 証明書の公開キーと、公開キーが配置されている Linux VM 上のパスに関する情報が含まれています。

名前	型	説明
keyData	string	SSH を使用して VM で認証するために使用される SSH 公開キー証明書。キーは、少なくとも 2048 ビットで、ssh-rsa 形式である必要があります。 SSH キーの作成については、「Azure の Linux VM 用 Linux および Mac で SSH キーを作成する」を参照してください。https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).
path	string	ssh 公開キーが格納されている、作成された VM 上の完全なパスを指定します。ファイルが既に存在する場合は、指定したキーがそのファイルに追加されます。例: /home/user/.ssh/authorized_keys

StatusLevelTypes

レベルコード。

名前	型	説明
Error	string
Info	string
Warning	string

StorageAccountTypes

マネージドディスクのストレージアカウントの種類を指定します。注: UltraSSD_LRSはデータディスクでのみ使用できます。OS ディスクでは使用できません。

名前	型	説明
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

SubResource

名前	型	説明
id	string	リソース ID

UefiSettings

仮想マシンの作成時に使用されるセキュアブートや vTPM などのセキュリティ設定を指定します。最小 api-version: 2020-12-01。

名前	型	説明
secureBootEnabled	boolean	仮想マシンでセキュアブートを有効にするかどうかを指定します。最小 api-version: 2020-12-01。
vTpmEnabled	boolean	仮想マシンで vTPM を有効にするかどうかを指定します。最小 api-version: 2020-12-01。

VaultCertificate

Key Vault内の 1 つの証明書参照と、証明書が VM 上に存在する場所について説明します。

名前	型	説明
certificateStore	string	Windows VM の場合は、証明書を追加する仮想マシン上の証明書ストアを指定します。指定した証明書ストアは、LocalMachine アカウントに暗黙的に含まれます。 Linux VM の場合、証明書ファイルは /var/lib/waagent ディレクトリの下に配置され、ファイル名 <は X509 証明書ファイルの場合は UppercaseThumbprint.crt>、 <秘密キーの場合は UppercaseThumbprint.prv> です。これらのファイルはどちらも .pem 形式です。
certificateUrl	string	これは、シークレットとしてKey Vaultにアップロードされた証明書の URL です。 Key Vaultにシークレットを追加する方法については、「キーコンテナーにキーまたはシークレットを追加する」を参照してください。この場合、証明書は UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。 { "data":"", "dataType":"pfx", "password":"" } 仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault仮想マシン拡張機能を使用することをお勧めします。

VaultSecretGroup

すべて同じKey Vault内にある証明書のセットについて説明します。

名前	型	説明
sourceVault	SubResource	VaultCertificates のすべての証明書を含むKey Vaultの相対 URL。
vaultCertificates	VaultCertificate[]	証明書を含む SourceVault 内のキーコンテナー参照の一覧。

VirtualMachineSizeTypes

仮想マシンのサイズを指定します。列挙型データ型は現在非推奨であり、2023 年 12 月 23 日までに削除される予定です。使用可能なサイズの一覧を取得するには、次の API を使用することをお勧めします。可用性セットで使用可能なすべての仮想マシンサイズの一覧表示、リージョンで使用可能なすべての仮想マシンサイズの一覧表示、サイズ変更のために使用可能なすべての仮想マシンサイズの一覧表示。仮想マシンのサイズの詳細については、「仮想マシンのサイズ」を参照してください。使用可能な VM サイズは、リージョンと可用性セットによって異なります。

名前	型	説明
Basic_A0	string
Basic_A1	string
Basic_A2	string
Basic_A3	string
Basic_A4	string
Standard_A0	string
Standard_A1	string
Standard_A10	string
Standard_A11	string
Standard_A1_v2	string
Standard_A2	string
Standard_A2_v2	string
Standard_A2m_v2	string
Standard_A3	string
Standard_A4	string
Standard_A4_v2	string
Standard_A4m_v2	string
Standard_A5	string
Standard_A6	string
Standard_A7	string
Standard_A8	string
Standard_A8_v2	string
Standard_A8m_v2	string
Standard_A9	string
Standard_B1ms	string
Standard_B1s	string
Standard_B2ms	string
Standard_B2s	string
Standard_B4ms	string
Standard_B8ms	string
Standard_D1	string
Standard_D11	string
Standard_D11_v2	string
Standard_D12	string
Standard_D12_v2	string
Standard_D13	string
Standard_D13_v2	string
Standard_D14	string
Standard_D14_v2	string
Standard_D15_v2	string
Standard_D16_v3	string
Standard_D16s_v3	string
Standard_D1_v2	string
Standard_D2	string
Standard_D2_v2	string
Standard_D2_v3	string
Standard_D2s_v3	string
Standard_D3	string
Standard_D32_v3	string
Standard_D32s_v3	string
Standard_D3_v2	string
Standard_D4	string
Standard_D4_v2	string
Standard_D4_v3	string
Standard_D4s_v3	string
Standard_D5_v2	string
Standard_D64_v3	string
Standard_D64s_v3	string
Standard_D8_v3	string
Standard_D8s_v3	string
Standard_DS1	string
Standard_DS11	string
Standard_DS11_v2	string
Standard_DS12	string
Standard_DS12_v2	string
Standard_DS13	string
Standard_DS13-2_v2	string
Standard_DS13-4_v2	string
Standard_DS13_v2	string
Standard_DS14	string
Standard_DS14-4_v2	string
Standard_DS14-8_v2	string
Standard_DS14_v2	string
Standard_DS15_v2	string
Standard_DS1_v2	string
Standard_DS2	string
Standard_DS2_v2	string
Standard_DS3	string
Standard_DS3_v2	string
Standard_DS4	string
Standard_DS4_v2	string
Standard_DS5_v2	string
Standard_E16_v3	string
Standard_E16s_v3	string
Standard_E2_v3	string
Standard_E2s_v3	string
Standard_E32-16_v3	string
Standard_E32-8s_v3	string
Standard_E32_v3	string
Standard_E32s_v3	string
Standard_E4_v3	string
Standard_E4s_v3	string
Standard_E64-16s_v3	string
Standard_E64-32s_v3	string
Standard_E64_v3	string
Standard_E64s_v3	string
Standard_E8_v3	string
Standard_E8s_v3	string
Standard_F1	string
Standard_F16	string
Standard_F16s	string
Standard_F16s_v2	string
Standard_F1s	string
Standard_F2	string
Standard_F2s	string
Standard_F2s_v2	string
Standard_F32s_v2	string
Standard_F4	string
Standard_F4s	string
Standard_F4s_v2	string
Standard_F64s_v2	string
Standard_F72s_v2	string
Standard_F8	string
Standard_F8s	string
Standard_F8s_v2	string
Standard_G1	string
Standard_G2	string
Standard_G3	string
Standard_G4	string
Standard_G5	string
Standard_GS1	string
Standard_GS2	string
Standard_GS3	string
Standard_GS4	string
Standard_GS4-4	string
Standard_GS4-8	string
Standard_GS5	string
Standard_GS5-16	string
Standard_GS5-8	string
Standard_H16	string
Standard_H16m	string
Standard_H16mr	string
Standard_H16r	string
Standard_H8	string
Standard_H8m	string
Standard_L16s	string
Standard_L32s	string
Standard_L4s	string
Standard_L8s	string
Standard_M128-32ms	string
Standard_M128-64ms	string
Standard_M128ms	string
Standard_M128s	string
Standard_M64-16ms	string
Standard_M64-32ms	string
Standard_M64ms	string
Standard_M64s	string
Standard_NC12	string
Standard_NC12s_v2	string
Standard_NC12s_v3	string
Standard_NC24	string
Standard_NC24r	string
Standard_NC24rs_v2	string
Standard_NC24rs_v3	string
Standard_NC24s_v2	string
Standard_NC24s_v3	string
Standard_NC6	string
Standard_NC6s_v2	string
Standard_NC6s_v3	string
Standard_ND12s	string
Standard_ND24rs	string
Standard_ND24s	string
Standard_ND6s	string
Standard_NV12	string
Standard_NV24	string
Standard_NV6	string

VMDiskSecurityProfile

マネージドディスクのセキュリティプロファイル設定を指定します。 メモ： これは、機密 VM に対してのみ設定できます。

名前	型	説明
diskEncryptionSet	DiskEncryptionSetParameters	カスタマーマネージドキーで暗号化された ConfidentialVM OS ディスクと VMGuest BLOB に使用されるマネージドディスクのカスタマーマネージドディスク暗号化セットリソース ID を指定します。
securityEncryptionType	securityEncryptionTypes	マネージドディスクの EncryptionType を指定します。 VMGuestState BLOB と共にマネージドディスクを暗号化するには DiskWithVMGuestState、VMGuestState BLOB のみの暗号化には VMGuestStateOnly、VMGuestState BLOB にファームウェア状態を保持しない場合は NonPersistedTPM に設定されます。メモ：これは、機密 VM にのみ設定できます。

VMSizeProperties

仮想マシンの VM サイズプロパティの設定を指定します。

名前	型	説明
vCPUsAvailable	integer	VM で使用できる vCPU の数を指定します。このプロパティが要求本文で指定されていない場合、既定の動作では、リージョン内で使用可能なすべての仮想マシンサイズを一覧表示するの API 応答で公開される VM サイズに対して使用可能な vCPU の値に設定します。
vCPUsPerCore	integer	vCPU と物理コアの比率を指定します。要求本文でこのプロパティが指定されていない場合、既定の動作は、リージョン内で使用可能なすべての仮想マシンサイズを一覧表示するの API 応答で公開される VM サイズの vCPUPerCore の値に設定されます。このプロパティを 1 に設定すると、ハイパースレッディングが無効になります。

WindowsConfiguration

仮想マシン上の Windows オペレーティングシステムの設定を指定します。

名前	型	説明
additionalUnattendContent	AdditionalUnattendContent[]	Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の Base 64 でエンコードされた XML 形式の情報を指定します。
enableAutomaticUpdates	boolean	Windows 仮想マシンに対して自動Updatesが有効になっているかどうかを示します。既定値は true です。仮想マシンスケールセットの場合、このプロパティを更新でき、更新は OS の再プロビジョニングで有効になります。
enableVMAgentPlatformUpdates	boolean	Windows 仮想マシンに対して VMAgent Platform Updatesが有効になっているかどうかを示します。既定値は false です。
patchSettings	PatchSettings	[プレビュー機能]Windows での VM ゲストパッチ適用に関連する設定を指定します。
provisionVMAgent	boolean	仮想マシン上に仮想マシンエージェントをプロビジョニングするかどうかを示します。このプロパティが要求本文で指定されていない場合、既定では true に設定されます。これにより、VM エージェントが VM にインストールされ、後で拡張機能を VM に追加できるようになります。
timeZone	string	仮想マシンのタイムゾーンを指定します。たとえば、"太平洋標準時" などです。指定できる値は、TimeZoneInfo.GetSystemTimeZones によって返されるタイムゾーンの値 TimeZoneInfo.Id できます。
winRM	WinRMConfiguration	Windows リモート管理リスナーを指定します。これによって、リモートの Windows PowerShell が有効になります。

WindowsPatchAssessmentMode

名前	型	説明
AutomaticByPlatform	string
ImageDefault	string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。

名前	型	説明
Always	string
IfRequired	string
Never	string
Unknown	string

WindowsVMGuestPatchAutomaticByPlatformSettings

Windows パッチ設定でパッチモード AutomaticByPlatform が選択されている場合に適用される追加の設定を指定します。

名前	型	説明
bypassPlatformSafetyChecksOnUserSchedule	boolean	お客様が誤ってアップグレードすることなく修正プログラムの適用をスケジュールできるようにします
rebootSetting	WindowsVMGuestPatchAutomaticByPlatformRebootSetting	すべての AutomaticByPlatform パッチインストール操作の再起動設定を指定します。

WindowsVMGuestPatchMode

OrchestrationMode をフレキシブルとして使用して、IaaS 仮想マシンまたは仮想マシンスケールセットに関連付けられている仮想マシンへの VM ゲストパッチ適用のモードを指定します。

次のいずれかの値になります。

手動 - 仮想マシンへのパッチの適用を制御します。これを行うには、VM 内でパッチを手動で適用します。このモードでは、自動更新は無効になります。プロパティ WindowsConfiguration.enableAutomaticUpdates は false にする必要があります

AutomaticByOS - 仮想マシンは OS によって自動的に更新されます。プロパティ WindowsConfiguration.enableAutomaticUpdates は true である必要があります。

AutomaticByPlatform - 仮想マシンはプラットフォームによって自動的に更新されます。プロパティ provisionVMAgent と WindowsConfiguration.enableAutomaticUpdates は true である必要があります

名前	型	説明
AutomaticByOS	string
AutomaticByPlatform	string
Manual	string

WinRMConfiguration

VM の Windows リモート管理の構成について説明します

名前	型	説明
listeners	WinRMListener[]	Windows リモート管理リスナーの一覧

WinRMListener

Windows リモート管理リスナーのプロトコルと拇印について説明します

名前	型	説明
certificateUrl	string	これは、シークレットとしてKey Vaultにアップロードされた証明書の URL です。 Key Vaultにシークレットを追加する方法については、「キーコンテナーにキーまたはシークレットを追加する」を参照してください。この場合、証明書は UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。 { "data":"", "dataType":"pfx", "password":"" } 仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault仮想マシン拡張機能を使用することをお勧めします。
protocol	ProtocolTypes	WinRM リスナーのプロトコルを指定します。指定できる値は http、https です。

Share via

Restore Points - Create

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

Scopes

例

Copy a restore point to a different region

Sample Request

Sample Response

Create a restore point

Sample Request

Sample Response

定義

AdditionalUnattendContent

ApiEntityReference

ApiError

ApiErrorBase

BootDiagnostics

CachingTypes

CloudError

ComponentNames

ConsistencyModeTypes

DiagnosticsProfile

DiskControllerTypes

DiskEncryptionSetParameters

DiskEncryptionSettings

DiskRestorePointAttributes

DiskRestorePointInstanceView

DiskRestorePointReplicationStatus

EncryptionIdentity

HardwareProfile

HyperVGenerationTypes

InnerError

InstanceViewStatus

KeyVaultKeyReference

KeyVaultSecretReference

LinuxConfiguration

LinuxPatchAssessmentMode

LinuxPatchSettings

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

LinuxVMGuestPatchAutomaticByPlatformSettings

LinuxVMGuestPatchMode

ManagedDiskParameters

Mode

OperatingSystemType

OSProfile

PassNames

PatchSettings

ProtocolTypes

ProxyAgentSettings

RestorePoint

RestorePointEncryption

RestorePointEncryptionType

RestorePointInstanceView

RestorePointSourceMetadata

RestorePointSourceVMDataDisk

RestorePointSourceVMOSDisk

RestorePointSourceVMStorageProfile

securityEncryptionTypes

SecurityProfile

SecurityTypes

SettingNames

SshConfiguration

SshPublicKey

StatusLevelTypes

StorageAccountTypes

SubResource

UefiSettings

VaultCertificate

VaultSecretGroup

VirtualMachineSizeTypes

VMDiskSecurityProfile

VMSizeProperties

WindowsConfiguration

WindowsPatchAssessmentMode

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

WindowsVMGuestPatchAutomaticByPlatformSettings