Virtual Machines - Get

仮想マシンのモデル ビューまたはインスタンス ビューに関する情報を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}?api-version=2024-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}?$expand={$expand}&api-version=2024-03-01

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

リソース グループの名前。

subscriptionId
path True

string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

vmName
path True

string

仮想マシンの名前。

api-version
query True

string

クライアント API のバージョン。

$expand
query

InstanceViewTypes

操作に適用する展開式。 'InstanceView' は、プラットフォームによって管理され、コントロール プレーン操作の外部で変更できる仮想マシンのランタイム プロパティのスナップショットを取得します。 'UserData' は、VM の作成/更新操作中にユーザーによって提供された VM モデル ビューの一部として UserData プロパティを取得します。

応答

名前 説明
200 OK

VirtualMachine

OK

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 ユーザー アカウントの借用

Get a virtual machine placed on a dedicated host group through automatic placement
Get a virtual machine with Disk Controller Type Properties
Get a virtual machine with VM Size Properties
Get a Virtual Machine.

Get a virtual machine placed on a dedicated host group through automatic placement

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

Sample Response

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "hostGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup"
    },
    "hardwareProfile": {
      "vmSize": "Standard_D2s_v3"
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": []
    },
    "osProfile": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "provisioningState": "Succeeded"
  }
}

Get a virtual machine with Disk Controller Type Properties

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?$expand=userData&api-version=2024-03-01

Sample Response

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2",
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ],
      "diskControllerType": "NVMe"
    },
    "applicationProfile": {
      "galleryApplications": [
        {
          "tags": "myTag1",
          "order": 1,
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
          "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
        },
        {
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
        }
      ]
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
    "osProfile": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "provisioningState": "Succeeded"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "location": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Get a virtual machine with VM Size Properties

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?api-version=2024-03-01

Sample Response

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2",
      "vmSizeProperties": {
        "vCPUsAvailable": 1,
        "vCPUsPerCore": 1
      }
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ]
    },
    "applicationProfile": {
      "galleryApplications": [
        {
          "tags": "myTag1",
          "order": 1,
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
          "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
        },
        {
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
        }
      ]
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
    "osProfile": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "provisioningState": "Succeeded"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "location": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

Get a Virtual Machine.

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM?$expand=userData&api-version=2024-03-01

Sample Response

{
  "name": "myVM",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "West US",
  "tags": {
    "myTag1": "tagValue1"
  },
  "etag": "\"1\"",
  "properties": {
    "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1",
    "availabilitySet": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet"
    },
    "proximityPlacementGroup": {
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/my-ppg01"
    },
    "hardwareProfile": {
      "vmSize": "Standard_DS3_v2"
    },
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2016-Datacenter",
        "version": "latest"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "myOsDisk",
        "createOption": "FromImage",
        "caching": "ReadWrite",
        "managedDisk": {
          "storageAccountType": "Premium_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk"
        },
        "diskSizeGB": 30
      },
      "dataDisks": [
        {
          "lun": 0,
          "name": "myDataDisk0",
          "createOption": "Empty",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0"
          },
          "diskSizeGB": 30
        },
        {
          "lun": 1,
          "name": "myDataDisk1",
          "createOption": "Attach",
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "Premium_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1"
          },
          "diskSizeGB": 100
        }
      ]
    },
    "applicationProfile": {
      "galleryApplications": [
        {
          "tags": "myTag1",
          "order": 1,
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0",
          "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config"
        },
        {
          "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1"
        }
      ]
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
    "osProfile": {
      "computerName": "myVM",
      "adminUsername": "admin",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": false
      },
      "secrets": []
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true,
        "storageUri": "http://{myStorageAccount}.blob.core.windows.net"
      }
    },
    "extensionsTimeBudget": "PT50M",
    "provisioningState": "Succeeded",
    "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
  },
  "resources": [
    {
      "name": "CustomScriptExtension-DSC",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
      "type": "Microsoft.Compute/virtualMachines/extensions",
      "location": "west us",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ],
  "managedBy": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{MyVmss}"
}

定義

名前 説明
AdditionalCapabilities

仮想マシンで有効または無効にされる追加の機能を指定します。

AdditionalUnattendContent

Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の Base 64 でエンコードされた XML 形式の情報を指定します。

ApiEntityReference

ソース リソース識別子。 ディスクの作成元となるスナップショットまたはディスク復元ポイントを指定できます。

ApiError

API エラー。

ApiErrorBase

API エラーベース。

ApplicationProfile

VM/VMSS で使用できるようにするギャラリー アプリケーションを指定します。

AvailablePatchSummary

仮想マシンの最新の評価操作の利用可能なパッチの概要。

BillingProfile

Azure Spot 仮想マシンの課金関連の詳細を指定します。 最小 api-version: 2019-03-01。

BootDiagnostics

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

BootDiagnosticsInstanceView

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

CachingTypes

キャッシュの要件を指定します。 使用できる値は、 None、ReadOnly、ReadWrite です。 既定の動作は、 Standard Storage の場合は None です。Premium Storage の ReadOnly。

CapacityReservationProfile

仮想マシンの割り当てに使用される容量予約に関する情報を指定します。 最小 api-version: 2021-04-01。

CloudError

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

ComponentNames

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

DataDisk

仮想マシンにデータ ディスクを追加するために使用されるパラメーターを指定します。 ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。

DeleteOptions

VM が削除されたときのネットワーク インターフェイスの動作を指定する

DiagnosticsProfile

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

DiffDiskOptions

オペレーティング システム ディスクのエフェメラル ディスク設定を指定します。

DiffDiskPlacement

オペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 使用できる値は、 CacheDisk、ResourceDisk、NvmeDisk です。 既定の動作は、VM サイズ用に構成されている場合は CacheDisk 、それ以外の場合は ResourceDisk または NvmeDisk が使用されます。 キャッシュ ディスクを公開する VM サイズをチェックするには、Windows VM と https://docs.microsoft.com/azure/virtual-machines/windows/sizes Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes の VM サイズに関するドキュメントを参照してください。 NvmeDisk の最小 api-version: 2024-03-01。

DiffDiskSettings

仮想マシンで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。

DiskControllerTypes

VM 用に構成されたディスク コントローラーの種類を指定します。 メモ: 指定されていない場合、このプロパティは、指定された最小 API バージョンのオペレーティング システム ディスクと VM サイズの機能に基づいて、"hyperVGeneration" が V2 に設定された状態で作成されている場合、既定のディスク コントローラーの種類に設定されます。 VM の割り当てを暗黙的に解除して再割り当てする VM 構成で VM サイズを更新しない限り、ディスク コントローラーの種類を更新する前に VM の割り当てを解除する必要があります。 最小 api-version: 2022-08-01。

DiskCreateOptionTypes

仮想マシン ディスクの作成方法を指定します。 指定できる値は [アタッチ] です。 この値は、特殊化されたディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォーム イメージを使用している場合は、上記の imageReference 要素も使用する必要があります。 マーケットプレース イメージを使用している場合は、前に説明した plan 要素も使用する必要があります。

DiskDeleteOptionTypes

VM の削除時に OS ディスクを削除するかデタッチするかを指定します。 指定できる値は 、Delete です。 この値を使用すると、VM の削除時に OS ディスクが削除されます。 デタッチ。 この値を使用すると、VM が削除された後も os ディスクが保持されます。 既定値は [デタッチ] に設定されています。 エフェメラル OS ディスクの場合、既定値は Delete に設定 されます。 ユーザーは、エフェメラル OS ディスクの削除オプションを変更できません。

DiskDetachOptionTypes

ディスクのデタッチ中に使用するデタッチ動作、または仮想マシンからのデタッチ処理中のデタッチ動作を指定します。 サポートされる値: ForceDetach。 detachOption: ForceDetach はマネージド データ ディスクにのみ適用されます。 仮想マシンからの予期しない障害が原因でデータ ディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後の手段として強制デタッチを使用して、VM からディスクを強制的にデタッチします。 このデタッチ動作を使用する場合、すべての書き込みがフラッシュされていない可能性があります。 この機能はまだプレビュー モードであり 、VirtualMachineScaleSet ではサポートされていません。 detachOption: 'ForceDetach' の設定と共に、データ ディスクを強制的にBeDetached に 'true' に更新します。

DiskEncryptionSetParameters

マネージド ディスクのカスタマー マネージド ディスク暗号化セット リソース ID を指定します。

DiskEncryptionSettings

OS ディスクの暗号化設定を指定します。 最小 api-version: 2015-06-15。

DiskInstanceView

仮想マシンのディスク情報。

DomainNameLabelScopeTypes

作成される PublicIPAddress リソースのドメイン名ラベル スコープ。 生成された名前ラベルは、ドメイン名ラベルのスコープと VM ネットワーク プロファイルの一意の ID に従って、ハッシュされたドメイン名ラベルとポリシーを連結したものです。

EncryptionIdentity

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

EventGridAndResourceGraph

eventGridAndResourceGraph Scheduled Event 設定の作成時に使用される構成パラメーター。

ExtendedLocation

仮想マシンの拡張された場所。

ExtendedLocationTypes

拡張された場所の型。

HardwareProfile

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

HyperVGenerationType

リソースに関連付けられている HyperVGeneration の種類を指定します

ImageReference

使用するイメージに関する情報を指定します。 プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージに関する情報を指定できます。 この要素は、プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージを使用する場合に必要ですが、他の作成操作では使用されません。

InnerError

内部エラーの詳細。

InstanceViewStatus

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

InstanceViewTypes

操作に適用する展開式。 'InstanceView' は、プラットフォームによって管理され、コントロール プレーン操作の外部で変更できる仮想マシンのランタイム プロパティのスナップショットを取得します。 'UserData' は、VM の作成/更新操作中にユーザーによって提供された VM モデル ビューの一部として UserData プロパティを取得します。

IPVersions

Api-Version 2019-07-01 以降で使用できます。これは、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 と見なされます。 使用可能な値は、'IPv4' と 'IPv6' です。

KeyVaultKeyReference

Key Vault内のキー暗号化キーの場所を指定します。

KeyVaultSecretReference

参照渡しされ、キー コンテナーから使用される拡張機能で保護された設定

LastPatchInstallationSummary

仮想マシンの最新のインストール操作のインストールの概要。

LinuxConfiguration

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

LinuxPatchAssessmentMode

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

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

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

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

LinuxPatchSettings

[プレビュー機能]Linux での VM ゲストパッチ適用に関連する設定を指定します。

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

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

LinuxVMGuestPatchAutomaticByPlatformSettings

Linux 上の VM ゲスト パッチ適用におけるパッチ モード AutomaticByPlatform の追加設定を指定します。

LinuxVMGuestPatchMode

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

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

ImageDefault - 仮想マシンの既定のパッチ適用構成が使用されます。

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

MaintenanceOperationResultCodeTypes

最後のメンテナンス操作の結果コード。

MaintenanceRedeployStatus

仮想マシンのメンテナンス操作の状態。

ManagedDiskParameters

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

Mode

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

NetworkApiVersion

は、ネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API のバージョンを指定します

NetworkInterfaceAuxiliaryMode

ネットワーク インターフェイス リソースに対して補助モードを有効にするかどうかを指定します。

NetworkInterfaceAuxiliarySku

ネットワーク インターフェイス リソースに対して補助 SKU を有効にするかどうかを指定します。

NetworkInterfaceReference

仮想マシンに関連付けられているネットワーク インターフェイスのリソース ID の一覧を指定します。

NetworkProfile

仮想マシンのネットワーク インターフェイスを指定します。

OperatingSystemTypes

オペレーティング システムの種類。

OSDisk

仮想マシンで使用されるオペレーティング システム ディスクに関する情報を指定します。 ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。

OSImageNotificationProfile

OS イメージのスケジュールされたイベント関連の構成を指定します。

OSProfile

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

PassNames

パス名。 現在、使用できる値は OobeSystem のみです。

PatchOperationStatus

操作の全体的な成功または失敗の状態。 操作が完了するまで、"InProgress" のままです。 その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。

PatchSettings

[プレビュー機能]Windows での VM ゲストパッチ適用に関連する設定を指定します。

Plan

仮想マシンの作成に使用されるマーケットプレース イメージに関する情報を指定します。 この要素は、マーケットプレース イメージにのみ使用されます。 API からマーケットプレース イメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portalで、使用するマーケットプレース イメージを見つけて、[プログラムでデプロイする] をクリックします。[作業の開始] を>クリックします。 必要な情報を入力し、[ 保存] をクリックします。

ProtocolTypes

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

ProxyAgentSettings

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

PublicIPAddressSku

パブリック IP SKU について説明します。 これは、OrchestrationMode でフレキシブルとしてのみ設定できます。

PublicIPAddressSkuName

パブリック IP SKU 名を指定する

PublicIPAddressSkuTier

パブリック IP SKU レベルを指定する

PublicIPAllocationMethod

パブリック IP 割り当ての種類を指定する

ResourceIdentityType

仮想マシンに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類 'None' は、仮想マシンから ID を削除します。

ScheduledEventsAdditionalPublishingTargets

scheduledEventsAdditionalPublishingTargets の発行時に使用される構成パラメーター。

ScheduledEventsPolicy

仮想マシンの再デプロイ、再起動、ScheduledEventsAdditionalPublishingTargets Scheduled Event 関連の構成を指定します。

ScheduledEventsProfile

スケジュールされたイベント関連の構成を指定します。

securityEncryptionTypes

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

SecurityProfile

仮想マシンのセキュリティ関連のプロファイル設定を指定します。

SecurityTypes

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

SettingNames

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

SshConfiguration

Linux OS の SSH キーの構成を指定します。

SshPublicKey

Linux ベースの VM で認証するために使用される SSH 公開キーの一覧。

StatusLevelTypes

レベル コード。

StorageAccountTypes

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

StorageProfile

仮想マシンのストレージ設定を指定します。

SubResource

シークレットを含むKey Vaultの相対 URL。

TerminateNotificationProfile

Terminate Scheduled Event 関連の構成を指定します。

UefiSettings

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

UserAssignedIdentities

仮想マシンに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

UserInitiatedReboot

userInitiatedReboot のスケジュールされたイベント設定の作成の作成時に使用される構成パラメーター。

UserInitiatedRedeploy

userInitiatedRedeploy スケジュールされたイベント設定の作成の作成時に使用される構成パラメーター。

VaultCertificate

証明書を含む SourceVault のキー コンテナー参照の一覧。

VaultSecretGroup

仮想マシンにインストールする必要がある証明書のセットを指定します。 仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault 仮想マシン拡張機能を使用することをお勧めします。

VirtualHardDisk

仮想ハード ディスク。

VirtualMachine

仮想マシンについて説明します。

VirtualMachineAgentInstanceView

仮想マシンで実行されている VM エージェント。

VirtualMachineEvictionPolicyTypes

Azure スポット仮想マシンと Azure スポット スケール セットの削除ポリシーを指定します。 Azure Spot 仮想マシンの場合、"割り当て解除" と "削除" の両方がサポートされており、最小 api バージョンは 2019-03-01 です。 Azure スポット スケール セットでは、"割り当て解除" と "削除" の両方がサポートされており、api-version の最小バージョンは 2017-10-30-preview です。

VirtualMachineExtension

仮想マシンの子拡張機能リソース。

VirtualMachineExtensionHandlerInstanceView

仮想マシン拡張機能ハンドラー インスタンス ビュー。

VirtualMachineExtensionInstanceView

仮想マシン拡張機能インスタンス ビュー。

VirtualMachineHealthStatus

VM の正常性状態。

VirtualMachineIdentity

構成されている場合は、仮想マシンの ID。

VirtualMachineInstanceView

仮想マシン インスタンス ビュー。

VirtualMachineIpTag

パブリック IP アドレスに関連付けられている IP タグの一覧。

VirtualMachineNetworkInterfaceConfiguration

仮想マシン ネットワーク リソースの作成に使用するネットワーク構成を指定します。

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

ネットワーク インターフェイスに適用される DNS 設定。

VirtualMachineNetworkInterfaceIPConfiguration

ネットワーク インターフェイスの IP 構成を指定します。

VirtualMachinePatchStatus

[プレビュー機能]仮想マシンのパッチ操作の状態。

VirtualMachinePriorityTypes

仮想マシンの優先度を指定します。 最小 api-version: 2019-03-01

VirtualMachinePublicIPAddressConfiguration

publicIPAddressConfiguration。

VirtualMachinePublicIPAddressDnsSettingsConfiguration

publicIP アドレスに適用される DNS 設定。

VirtualMachineSizeTypes

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

VMDiskSecurityProfile

マネージド ディスクのセキュリティ プロファイルを指定します。

VMGalleryApplication

VM/VMSS で使用できるようにするギャラリー アプリケーションを指定します

VMSizeProperties

仮想マシンのサイズをカスタマイズするためのプロパティを指定します。 最小 api-version: 2021-07-01。 この機能はまだプレビュー モードであり、VirtualMachineScaleSet ではサポートされていません。 詳細については、「VM の カスタマイズ 」の手順に従ってください。

WindowsConfiguration

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

WindowsPatchAssessmentMode

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

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

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

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

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

WindowsVMGuestPatchAutomaticByPlatformSettings

Windows 上の VM ゲスト修正プログラムのパッチ モード AutomaticByPlatform の追加設定を指定します。

WindowsVMGuestPatchMode

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

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

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

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

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

WinRMConfiguration

Windows リモート管理リスナーを指定します。 これによって、リモートの Windows PowerShell が有効になります。

WinRMListener

Windows リモート管理リスナーの一覧

AdditionalCapabilities

仮想マシンで有効または無効にされる追加の機能を指定します。

名前 説明
hibernationEnabled

boolean

VM の休止機能を有効または無効にするフラグ。

ultraSSDEnabled

boolean

VM または VMSS にストレージ アカウントの種類がUltraSSD_LRSの 1 つ以上のマネージド データ ディスクを持つ機能を有効または無効にするフラグ。 ストレージ アカウントの種類がUltraSSD_LRSマネージド ディスクは、このプロパティが有効になっている場合にのみ、仮想マシンまたは仮想マシン スケール セットに追加できます。

AdditionalUnattendContent

Windows セットアップで使用される、Unattend.xml ファイルに含めることができる追加の Base 64 でエンコードされた XML 形式の情報を指定します。

名前 説明
componentName

ComponentNames

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

content

string

指定したパスとコンポーネントの unattend.xml ファイルに追加される XML 形式のコンテンツを指定します。 XML は 4 KB 未満である必要があり、挿入される設定または機能のルート要素を含める必要があります。

passName

PassNames

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

settingName

SettingNames

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

ApiEntityReference

ソース リソース識別子。 ディスクの作成元となるスナップショットまたはディスク復元ポイントを指定できます。

名前 説明
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

特定のエラーのターゲット。

ApplicationProfile

VM/VMSS で使用できるようにするギャラリー アプリケーションを指定します。

名前 説明
galleryApplications

VMGalleryApplication[]

VM/VMSS で使用できるようにするギャラリー アプリケーションを指定します

AvailablePatchSummary

仮想マシンの最新の評価操作の利用可能なパッチの概要。

名前 説明
assessmentActivityId

string

この結果を生成した操作のアクティビティ ID。 これは、CRP と拡張機能のログ間で相互に関連付けるために使用されます。

criticalAndSecurityPatchCount

integer

使用可能として検出され、まだインストールされていないクリティカルパッチまたはセキュリティパッチの数。

error

ApiError

操作の実行中に発生したエラー。 details 配列には、それらのリストが含まれています。

lastModifiedTime

string

操作が開始されたときの UTC タイムスタンプ。

otherPatchCount

integer

クリティカルおよびセキュリティを除く使用可能なすべてのパッチの数。

rebootPending

boolean

VM の全体的な再起動状態。 これは、部分的にインストールされたパッチがインストールを完了するために再起動を必要とするが、再起動がまだ発生していない場合に当てはまります。

startTime

string

操作が開始されたときの UTC タイムスタンプ。

status

PatchOperationStatus

操作の全体的な成功または失敗の状態。 操作が完了するまで、"InProgress" のままです。 その時点で、"不明"、"失敗"、"成功"、または "CompletedWithWarnings" になります。

BillingProfile

Azure Spot 仮想マシンの課金関連の詳細を指定します。 最小 api-version: 2019-03-01。

名前 説明
maxPrice

number

Azure スポット VM/VMSS に対して支払う最大価格を指定します。 この価格は米ドルです。

この価格は、VM サイズの現在の Azure スポット価格と比較されます。 また、価格は Azure スポット VM/VMSS の作成/更新時に比較され、maxPrice が現在の Azure スポット価格より大きい場合にのみ操作が成功します。

現在の Azure スポット価格が VM/VMSS の作成後に maxPrice を超えた場合、maxPrice は Azure スポット VM/VMSS の削除にも使用されます。

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

- 0 より大きい任意の 10 進値。 例: 0.01538

-1 – 既定の価格がオンデマンドであることを示します。

maxPrice を -1 に設定すると、価格上の理由から Azure Spot VM/VMSS を削除しないことを示すことができます。 また、提供されていない場合、既定の最大価格は -1 です。

最小 api-version: 2019-03-01。

BootDiagnostics

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

名前 説明
enabled

boolean

仮想マシンでブート 診断を有効にする必要があるかどうか。

storageUri

string

コンソール出力とスクリーンショットを配置するために使用するストレージ アカウントの URI。 ブート 診断を有効にするときに storageUri が指定されていない場合は、マネージド ストレージが使用されます。

BootDiagnosticsInstanceView

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

名前 説明
consoleScreenshotBlobUri

string

コンソールのスクリーンショット BLOB URI。 メモ:ブート 診断がマネージド ストレージで現在有効になっている場合、これは設定されません

serialConsoleLogBlobUri

string

シリアル コンソール ログ BLOB URI。 メモ:ブート 診断がマネージド ストレージで現在有効になっている場合、これは設定されません

status

InstanceViewStatus

VM のブート 診断状態情報。 メモ:ブート 診断の有効化でエラーが発生した場合にのみ設定されます。

CachingTypes

キャッシュの要件を指定します。 使用できる値は、 None、ReadOnly、ReadWrite です。 既定の動作は、 Standard Storage の場合は None です。Premium Storage の ReadOnly。

名前 説明
None

string

ReadOnly

string

ReadWrite

string

CapacityReservationProfile

仮想マシンの割り当てに使用される容量予約に関する情報を指定します。 最小 api-version: 2021-04-01。

名前 説明
capacityReservationGroup

SubResource

十分な容量が予約されていれば、仮想マシンまたはスケールセット VM インスタンスの割り当てに使用する必要がある容量予約グループ リソース ID を指定します。 詳細については、 を https://aka.ms/CapacityReservation 参照してください。

CloudError

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

名前 説明
error

ApiError

API エラー。

ComponentNames

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

名前 説明
Microsoft-Windows-Shell-Setup

string

DataDisk

仮想マシンにデータ ディスクを追加するために使用されるパラメーターを指定します。 ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。

名前 説明
caching

CachingTypes

キャッシュの要件を指定します。 使用できる値は、 None、ReadOnly、ReadWrite です。 既定の動作は、 Standard Storage の場合は None です。Premium Storage の ReadOnly。

createOption

DiskCreateOptionTypes

仮想マシン ディスクの作成方法を指定します。 指定できる値は [アタッチ] です。 この値は、特殊化されたディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシン のデータ ディスクを作成するときに使用されます。 プラットフォーム イメージを使用している場合は、上記の imageReference 要素も使用する必要があります。 マーケットプレース イメージを使用している場合は、前に説明した plan 要素も使用する必要があります。 空: この値は、空のデータ ディスクを作成するときに使用されます。 コピー:この値は、スナップショットまたは別のディスクからデータ ディスクを作成するために使用されます。 復元: この値は、ディスク復元ポイントからデータ ディスクを作成するために使用されます。

deleteOption

DiskDeleteOptionTypes

VM の削除時にデータ ディスクを削除するかデタッチするかを指定します。 使用できる値は 、Delete です。 この値を使用すると、VM の削除時にデータ ディスクが削除されます。 デタッチ。 この値を使用すると、VM が削除された後もデータ ディスクが保持されます。 既定値は [デタッチ] に設定されています。

detachOption

DiskDetachOptionTypes

ディスクのデタッチ中に使用するデタッチ動作、または仮想マシンからのデタッチ処理中のデタッチ動作を指定します。 サポートされている値: ForceDetach。 detachOption: ForceDetach は、マネージド データ ディスクにのみ適用されます。 仮想マシンからの予期しない障害が原因でデータ ディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後の手段として強制デタッチを使用して、VM からディスクを強制的にデタッチします。 このデタッチ動作を使用する場合、すべての書き込みがフラッシュされていない可能性があります。 この機能は引き続きプレビュー モードであり、VirtualMachineScaleSet ではサポートされていません。 データ ディスクを強制的にデタッチするには、detachOption: 'ForceDetach' の設定と共にBeDetached を 'true' に更新します。

diskIOPSReadWrite

integer

StorageAccountType がUltraSSD_LRSされている場合のマネージド ディスクの Read-Write IOPS を指定します。 VirtualMachine ScaleSet VM ディスクに対してのみ返されます。 VirtualMachine スケール セットの更新によってのみ更新できます。

diskMBpsReadWrite

integer

StorageAccountType がUltraSSD_LRSされた場合のマネージド ディスクの帯域幅を 1 秒あたり MB 単位で指定します。 VirtualMachine ScaleSet VM ディスクに対してのみ返されます。 VirtualMachine スケール セットの更新によってのみ更新できます。

diskSizeGB

integer

空のデータ ディスクのサイズをギガバイト単位で指定します。 この要素を使用して、仮想マシン イメージ内のディスクのサイズを上書きできます。 プロパティ 'diskSizeGB' は、ディスクのバイト数 x 1024^3 であり、値を 1023 より大きくすることはできません。

image

VirtualHardDisk

ソース ユーザー イメージの仮想ハード ディスク。 仮想ハード ディスクは、仮想マシンに接続される前にコピーされます。 SourceImage が指定されている場合は、移行先の仮想ハード ドライブが存在しない必要があります。

lun

integer

データ ディスクの論理ユニット番号を指定します。 この値は、VM 内のデータ ディスクを識別するために使用されるため、VM に接続されているデータ ディスクごとに一意である必要があります。

managedDisk

ManagedDiskParameters

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

name

string

ディスク名。

sourceResource

ApiEntityReference

ソース リソース識別子。 ディスクの作成元となるスナップショットまたはディスク復元ポイントを指定できます。

toBeDetached

boolean

データ ディスクが VirtualMachine/VirtualMachineScaleset からデタッチ中かどうかを指定します

vhd

VirtualHardDisk

仮想ハード ディスク。

writeAcceleratorEnabled

boolean

ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

DeleteOptions

VM が削除されたときのネットワーク インターフェイスの動作を指定する

名前 説明
Delete

string

Detach

string

DiagnosticsProfile

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

名前 説明
bootDiagnostics

BootDiagnostics

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

DiffDiskOptions

オペレーティング システム ディスクのエフェメラル ディスク設定を指定します。

名前 説明
Local

string

DiffDiskPlacement

オペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 使用できる値は、 CacheDisk、ResourceDisk、NvmeDisk です。 既定の動作は、VM サイズ用に構成されている場合は CacheDisk 、それ以外の場合は ResourceDisk または NvmeDisk が使用されます。 キャッシュ ディスクを公開する VM サイズをチェックするには、Windows VM と https://docs.microsoft.com/azure/virtual-machines/windows/sizes Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes の VM サイズに関するドキュメントを参照してください。 NvmeDisk の最小 api-version: 2024-03-01。

名前 説明
CacheDisk

string

NvmeDisk

string

ResourceDisk

string

DiffDiskSettings

仮想マシンで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。

名前 説明
option

DiffDiskOptions

オペレーティング システム ディスクのエフェメラル ディスク設定を指定します。

placement

DiffDiskPlacement

オペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 指定できる値は 、CacheDisk、ResourceDisk、NvmeDisk です。 既定の動作は、VM サイズ用に構成されている場合は CacheDisk 、それ以外の場合は ResourceDisk または NvmeDisk が使用されます。 キャッシュ ディスクを公開する VM サイズをチェックするには、 の Windows https://docs.microsoft.com/azure/virtual-machines/windows/sizes VM と Linux VM https://docs.microsoft.com/azure/virtual-machines/linux/sizes の VM サイズに関するドキュメントを参照してください。 NvmeDisk の最小 api-version: 2024-03-01。

DiskControllerTypes

VM 用に構成されたディスク コントローラーの種類を指定します。 メモ: 指定されていない場合、このプロパティは、指定された最小 API バージョンのオペレーティング システム ディスクと VM サイズの機能に基づいて、"hyperVGeneration" が V2 に設定された状態で作成されている場合、既定のディスク コントローラーの種類に設定されます。 VM の割り当てを暗黙的に解除して再割り当てする VM 構成で VM サイズを更新しない限り、ディスク コントローラーの種類を更新する前に VM の割り当てを解除する必要があります。 最小 api-version: 2022-08-01。

名前 説明
NVMe

string

SCSI

string

DiskCreateOptionTypes

仮想マシン ディスクの作成方法を指定します。 指定できる値は [アタッチ] です。 この値は、特殊化されたディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォーム イメージを使用している場合は、上記の imageReference 要素も使用する必要があります。 マーケットプレース イメージを使用している場合は、前に説明した plan 要素も使用する必要があります。

名前 説明
Attach

string

Copy

string

Empty

string

FromImage

string

Restore

string

DiskDeleteOptionTypes

VM の削除時に OS ディスクを削除するかデタッチするかを指定します。 指定できる値は 、Delete です。 この値を使用すると、VM の削除時に OS ディスクが削除されます。 デタッチ。 この値を使用すると、VM が削除された後も os ディスクが保持されます。 既定値は [デタッチ] に設定されています。 エフェメラル OS ディスクの場合、既定値は Delete に設定 されます。 ユーザーは、エフェメラル OS ディスクの削除オプションを変更できません。

名前 説明
Delete

string

Detach

string

DiskDetachOptionTypes

ディスクのデタッチ中に使用するデタッチ動作、または仮想マシンからのデタッチ処理中のデタッチ動作を指定します。 サポートされる値: ForceDetach。 detachOption: ForceDetach はマネージド データ ディスクにのみ適用されます。 仮想マシンからの予期しない障害が原因でデータ ディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後の手段として強制デタッチを使用して、VM からディスクを強制的にデタッチします。 このデタッチ動作を使用する場合、すべての書き込みがフラッシュされていない可能性があります。 この機能はまだプレビュー モードであり 、VirtualMachineScaleSet ではサポートされていません。 detachOption: 'ForceDetach' の設定と共に、データ ディスクを強制的にBeDetached に 'true' に更新します。

名前 説明
ForceDetach

string

DiskEncryptionSetParameters

マネージド ディスクのカスタマー マネージド ディスク暗号化セット リソース ID を指定します。

名前 説明
id

string

リソース ID

DiskEncryptionSettings

OS ディスクの暗号化設定を指定します。 最小 api-version: 2015-06-15。

名前 説明
diskEncryptionKey

KeyVaultSecretReference

Key Vault シークレットであるディスク暗号化キーの場所を指定します。

enabled

boolean

仮想マシンでディスク暗号化を有効にするかどうかを指定します。

keyEncryptionKey

KeyVaultKeyReference

Key Vault内のキー暗号化キーの場所を指定します。

DiskInstanceView

仮想マシンのディスク情報。

名前 説明
encryptionSettings

DiskEncryptionSettings[]

OS ディスクの暗号化設定を指定します。

最小 api-version: 2015-06-15

name

string

ディスク名。

statuses

InstanceViewStatus[]

リソースの状態情報。

DomainNameLabelScopeTypes

作成される PublicIPAddress リソースのドメイン名ラベル スコープ。 生成された名前ラベルは、ドメイン名ラベルのスコープと VM ネットワーク プロファイルの一意の ID に従って、ハッシュされたドメイン名ラベルとポリシーを連結したものです。

名前 説明
NoReuse

string

ResourceGroupReuse

string

SubscriptionReuse

string

TenantReuse

string

EncryptionIdentity

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

名前 説明
userAssignedIdentityResourceId

string

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

EventGridAndResourceGraph

eventGridAndResourceGraph Scheduled Event 設定の作成時に使用される構成パラメーター。

名前 説明
enable

boolean

スケジュールされたイベント関連の構成に対してイベント グリッドとリソース グラフを有効にするかどうかを指定します。

ExtendedLocation

仮想マシンの拡張された場所。

名前 説明
name

string

拡張場所の名前。

type

ExtendedLocationTypes

拡張された場所の型。

ExtendedLocationTypes

拡張された場所の型。

名前 説明
EdgeZone

string

HardwareProfile

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

名前 説明
vmSize

VirtualMachineSizeTypes

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

vmSizeProperties

VMSizeProperties

仮想マシンのサイズをカスタマイズするためのプロパティを指定します。 最小 api-version: 2021-07-01。 この機能はまだプレビュー モードであり、VirtualMachineScaleSet ではサポートされていません。 詳細については、「VM の カスタマイズ 」の手順に従ってください。

HyperVGenerationType

リソースに関連付けられている HyperVGeneration の種類を指定します

名前 説明
V1

string

V2

string

ImageReference

使用するイメージに関する情報を指定します。 プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージに関する情報を指定できます。 この要素は、プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージを使用する場合に必要ですが、他の作成操作では使用されません。

名前 説明
communityGalleryImageId

string

VM デプロイのコミュニティ ギャラリー イメージの一意の ID を指定しました。 これは、コミュニティ ギャラリー イメージ GET 呼び出しからフェッチできます。

exactVersion

string

仮想マシンの作成に使用されるプラットフォーム イメージまたはマーケットプレース イメージのバージョンを、10 進数で指定します。 この読み取り専用フィールドは、'version' フィールドで指定された値が 'latest' の場合にのみ、'version' と異なります。

id

string

リソース ID

offer

string

仮想マシンの作成に使用するプラットフォーム イメージまたはマーケットプレース イメージのオファーを指定します。

publisher

string

イメージの発行元。

sharedGalleryImageId

string

VM デプロイの共有ギャラリー イメージの一意の ID を指定しました。 これは、共有ギャラリー イメージ GET 呼び出しからフェッチできます。

sku

string

イメージ SKU。

version

string

仮想マシンの作成に使用されるプラットフォーム イメージまたはマーケットプレース イメージのバージョンを指定します。 使用できる形式は Major.Minor.Build または 'latest' です。 メジャー、マイナー、ビルドは 10 進数です。 デプロイ時に使用可能な最新バージョンのイメージを使用するには、'latest' を指定します。 'latest' を使用している場合でも、新しいバージョンが使用可能になった場合でも、デプロイ後に VM イメージは自動的に更新されません。 ギャラリー イメージのデプロイにはフィールド 'version' を使用しないでください。ギャラリー イメージは常にデプロイに 'id' フィールドを使用する必要があります。'最新' バージョンのギャラリー イメージを使用するには、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' をバージョン入力なしで 'id' フィールドに設定するだけです。

InnerError

内部エラーの詳細。

名前 説明
errordetail

string

内部エラー メッセージまたは例外ダンプ。

exceptiontype

string

例外の種類。

InstanceViewStatus

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

名前 説明
code

string

ステータス コード。

displayStatus

string

状態の短いローカライズ可能なラベル。

level

StatusLevelTypes

レベル コード。

message

string

アラートとエラー メッセージを含む詳細なステータス メッセージ。

time

string

状態の時刻。

InstanceViewTypes

操作に適用する展開式。 'InstanceView' は、プラットフォームによって管理され、コントロール プレーン操作の外部で変更できる仮想マシンのランタイム プロパティのスナップショットを取得します。 'UserData' は、VM の作成/更新操作中にユーザーによって提供された VM モデル ビューの一部として UserData プロパティを取得します。

名前 説明
instanceView

string

userData

string

IPVersions

Api-Version 2019-07-01 以降で使用できます。これは、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 と見なされます。 使用可能な値は、'IPv4' と 'IPv6' です。

名前 説明
IPv4

string

IPv6

string

KeyVaultKeyReference

Key Vault内のキー暗号化キーの場所を指定します。

名前 説明
keyUrl

string

Key Vaultのキー暗号化キーを参照する URL。

sourceVault

SubResource

キーを含むKey Vaultの相対 URL。

KeyVaultSecretReference

参照渡しされ、キー コンテナーから使用される拡張機能で保護された設定

名前 説明
secretUrl

string

Key Vault内のシークレットを参照する URL。

sourceVault

SubResource

シークレットを含むKey Vaultの相対 URL。

LastPatchInstallationSummary

仮想マシンの最新のインストール操作のインストールの概要。

名前 説明
error

ApiError

操作の実行中に発生したエラー。 details 配列には、それらのリストが含まれています。

excludedPatchCount

integer

使用可能なすべてのパッチの数。ただし、顧客が指定した除外リストの一致によって明示的に除外されます。

failedPatchCount

integer

インストールに失敗したパッチの数。

installationActivityId

string

この結果を生成した操作のアクティビティ ID。 これは、CRP ログと拡張機能ログ間で相互に関連付けるために使用されます。

installedPatchCount

integer

正常にインストールされたパッチの数。

lastModifiedTime

string

操作が開始されたときの UTC タイムスタンプ。

maintenanceWindowExceeded

boolean

操作が目的のすべてのアクションを完了するまでに時間が切れるかどうかを説明します

notSelectedPatchCount

integer

分類または包含リストのエントリと一致しなかったため、使用可能なすべてのパッチの数がインストールされません。

pendingPatchCount

integer

パッチのインストール操作中にインストールされる予定のすべての利用可能なパッチの数。

startTime

string

操作が開始されたときの UTC タイムスタンプ。

status

PatchOperationStatus

操作の全体的な成功または失敗の状態。 操作が完了するまで、"InProgress" のままです。 その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。

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 上の VM ゲスト パッチ適用におけるパッチ モード AutomaticByPlatform の追加設定を指定します。

名前 説明
bypassPlatformSafetyChecksOnUserSchedule

boolean

お客様が誤ってアップグレードすることなくパッチ適用をスケジュールできるようにします

rebootSetting

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

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

LinuxVMGuestPatchMode

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

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

ImageDefault - 仮想マシンの既定のパッチ適用構成が使用されます。

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

名前 説明
AutomaticByPlatform

string

ImageDefault

string

MaintenanceOperationResultCodeTypes

最後のメンテナンス操作の結果コード。

名前 説明
MaintenanceAborted

string

MaintenanceCompleted

string

None

string

RetryLater

string

MaintenanceRedeployStatus

仮想マシンのメンテナンス操作の状態。

名前 説明
isCustomerInitiatedMaintenanceAllowed

boolean

True を指定すると、お客様がメンテナンスを実行できます。

lastOperationMessage

string

最後のメンテナンス操作に対して返されたメッセージ。

lastOperationResultCode

MaintenanceOperationResultCodeTypes

最後のメンテナンス操作の結果コード。

maintenanceWindowEndTime

string

メンテナンス期間の終了時刻。

maintenanceWindowStartTime

string

メンテナンス期間の開始時刻。

preMaintenanceWindowEndTime

string

メンテナンス前期間の終了時刻。

preMaintenanceWindowStartTime

string

メンテナンス前期間の開始時刻。

ManagedDiskParameters

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

名前 説明
diskEncryptionSet

DiskEncryptionSetParameters

マネージド ディスクのカスタマー マネージド ディスク暗号化セット リソース ID を指定します。

id

string

リソース ID

securityProfile

VMDiskSecurityProfile

マネージド ディスクのセキュリティ プロファイルを指定します。

storageAccountType

StorageAccountTypes

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

Mode

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

名前 説明
Audit

string

Enforce

string

NetworkApiVersion

は、ネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API のバージョンを指定します

名前 説明
2020-11-01

string

NetworkInterfaceAuxiliaryMode

ネットワーク インターフェイス リソースに対して補助モードを有効にするかどうかを指定します。

名前 説明
AcceleratedConnections

string

Floating

string

None

string

NetworkInterfaceAuxiliarySku

ネットワーク インターフェイス リソースに対して補助 SKU を有効にするかどうかを指定します。

名前 説明
A1

string

A2

string

A4

string

A8

string

None

string

NetworkInterfaceReference

仮想マシンに関連付けられているネットワーク インターフェイスのリソース ID の一覧を指定します。

名前 説明
id

string

リソース ID

properties.deleteOption

DeleteOptions

VM が削除されたときのネットワーク インターフェイスの動作を指定する

properties.primary

boolean

仮想マシンに 1 つ以上のネットワーク インターフェイスがある場合に備えて、プライマリ ネットワーク インターフェイスを指定します。

NetworkProfile

仮想マシンのネットワーク インターフェイスを指定します。

名前 説明
networkApiVersion

NetworkApiVersion

は、ネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API のバージョンを指定します

networkInterfaceConfigurations

VirtualMachineNetworkInterfaceConfiguration[]

仮想マシン ネットワーク リソースの作成に使用するネットワーク構成を指定します。

networkInterfaces

NetworkInterfaceReference[]

仮想マシンに関連付けられているネットワーク インターフェイスのリソース ID の一覧を指定します。

OperatingSystemTypes

オペレーティング システムの種類。

名前 説明
Linux

string

Windows

string

OSDisk

仮想マシンで使用されるオペレーティング システム ディスクに関する情報を指定します。 ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。

名前 説明
caching

CachingTypes

キャッシュの要件を指定します。 使用できる値は、 None、ReadOnly、ReadWrite です。 既定の動作は、 Standard Storage の場合は None です。Premium Storage の ReadOnly。

createOption

DiskCreateOptionTypes

仮想マシン ディスクの作成方法を指定します。 指定できる値は [アタッチ] です。 この値は、特殊化されたディスクを使用して仮想マシンを作成するときに使用されます。 FromImage: この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォーム イメージを使用している場合は、上記の imageReference 要素も使用する必要があります。 マーケットプレース イメージを使用している場合は、前に説明した plan 要素も使用する必要があります。

deleteOption

DiskDeleteOptionTypes

VM の削除時に OS ディスクを削除するかデタッチするかを指定します。 指定できる値は 、Delete です。 この値を使用すると、VM の削除時に OS ディスクが削除されます。 デタッチ。 この値を使用すると、VM が削除された後も os ディスクが保持されます。 既定値は [デタッチ] に設定されています。 エフェメラル OS ディスクの場合、既定値は Delete に設定 されます。 ユーザーは、エフェメラル OS ディスクの削除オプションを変更できません。

diffDiskSettings

DiffDiskSettings

仮想マシンで使用されるオペレーティング システム ディスクのエフェメラル ディスク設定を指定します。

diskSizeGB

integer

空のデータ ディスクのサイズをギガバイト単位で指定します。 この要素を使用して、仮想マシン イメージ内のディスクのサイズを上書きできます。 プロパティ 'diskSizeGB' は、ディスクのバイト数 x 1024^3 であり、値を 1023 より大きくすることはできません。

encryptionSettings

DiskEncryptionSettings

OS ディスクの暗号化設定を指定します。 最小 api-version: 2015-06-15。

image

VirtualHardDisk

ソース ユーザー イメージの仮想ハード ディスク。 仮想ハード ディスクは、仮想マシンに接続される前にコピーされます。 SourceImage が指定されている場合は、移行先の仮想ハード ドライブが存在しない必要があります。

managedDisk

ManagedDiskParameters

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

name

string

ディスク名。

osType

OperatingSystemTypes

このプロパティを使用すると、ユーザー イメージまたは特殊化された VHD から VM を作成する場合に、ディスクに含まれる OS の種類を指定できます。 使用できる値は 、Windows、Linux です。

vhd

VirtualHardDisk

仮想ハード ディスク。

writeAcceleratorEnabled

boolean

ディスクで writeAccelerator を有効または無効にするかどうかを指定します。

OSImageNotificationProfile

OS イメージのスケジュールされたイベント関連の構成を指定します。

名前 説明
enable

boolean

OS イメージ のスケジュールされたイベントを有効にするか無効にするかを指定します。

notBeforeTimeout

string

仮想マシンの再イメージ化または OS のアップグレードを行う時間の長さは、イベントが自動承認 (タイムアウト) される前に、OS イメージのスケジュールされたイベントを承認する必要があります。 構成は ISO 8601 形式で指定され、値は 15 分 (PT15M) である必要があります

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

PatchOperationStatus

操作の全体的な成功または失敗の状態。 操作が完了するまで、"InProgress" のままです。 その時点で、"Unknown"、"Failed"、"Succeeded"、または "CompletedWithWarnings" になります。

名前 説明
CompletedWithWarnings

string

Failed

string

InProgress

string

Succeeded

string

Unknown

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 である必要があります

Plan

仮想マシンの作成に使用されるマーケットプレース イメージに関する情報を指定します。 この要素は、マーケットプレース イメージにのみ使用されます。 API からマーケットプレース イメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portalで、使用するマーケットプレース イメージを見つけて、[プログラムでデプロイする] をクリックします。[作業の開始] を>クリックします。 必要な情報を入力し、[ 保存] をクリックします。

名前 説明
name

string

プラン ID。

product

string

マーケットプレースからのイメージの製品を指定します。 これは、imageReference 要素の下の Offer と同じ値です。

promotionCode

string

販売促進コード。

publisher

string

発行元 ID。

ProtocolTypes

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

名前 説明
Http

string

Https

string

ProxyAgentSettings

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

名前 説明
enabled

boolean

仮想マシンまたは仮想マシン スケール セットで ProxyAgent 機能を有効にするかどうかを指定します。

keyIncarnationId

integer

このプロパティの値を大きくすると、ユーザーはゲストとホスト間の通信チャネルをセキュリティで保護するために使用されるキーをリセットできます。

mode

Mode

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

PublicIPAddressSku

パブリック IP SKU について説明します。 これは、OrchestrationMode でフレキシブルとしてのみ設定できます。

名前 説明
name

PublicIPAddressSkuName

パブリック IP SKU 名を指定する

tier

PublicIPAddressSkuTier

パブリック IP SKU レベルを指定する

PublicIPAddressSkuName

パブリック IP SKU 名を指定する

名前 説明
Basic

string

Standard

string

PublicIPAddressSkuTier

パブリック IP SKU レベルを指定する

名前 説明
Global

string

Regional

string

PublicIPAllocationMethod

パブリック IP 割り当ての種類を指定する

名前 説明
Dynamic

string

Static

string

ResourceIdentityType

仮想マシンに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類 'None' は、仮想マシンから ID を削除します。

名前 説明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ScheduledEventsAdditionalPublishingTargets

scheduledEventsAdditionalPublishingTargets の発行時に使用される構成パラメーター。

名前 説明
eventGridAndResourceGraph

EventGridAndResourceGraph

eventGridAndResourceGraph Scheduled Event 設定の作成時に使用される構成パラメーター。

ScheduledEventsPolicy

仮想マシンの再デプロイ、再起動、ScheduledEventsAdditionalPublishingTargets Scheduled Event 関連の構成を指定します。

名前 説明
scheduledEventsAdditionalPublishingTargets

ScheduledEventsAdditionalPublishingTargets

scheduledEventsAdditionalPublishingTargets の発行時に使用される構成パラメーター。

userInitiatedReboot

UserInitiatedReboot

userInitiatedReboot のスケジュールされたイベント設定の作成の作成時に使用される構成パラメーター。

userInitiatedRedeploy

UserInitiatedRedeploy

userInitiatedRedeploy スケジュールされたイベント設定の作成の作成時に使用される構成パラメーター。

ScheduledEventsProfile

スケジュールされたイベント関連の構成を指定します。

名前 説明
osImageNotificationProfile

OSImageNotificationProfile

OS イメージのスケジュールされたイベント関連の構成を指定します。

terminateNotificationProfile

TerminateNotificationProfile

終了スケジュールされたイベント関連の構成を指定します。

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

Linux OS の SSH キーの構成を指定します。

名前 説明
publicKeys

SshPublicKey[]

Linux ベースの VM で認証するために使用される SSH 公開キーの一覧。

SshPublicKey

Linux ベースの VM で認証するために使用される SSH 公開キーの一覧。

名前 説明
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

StorageProfile

仮想マシンのストレージ設定を指定します。

名前 説明
dataDisks

DataDisk[]

仮想マシンにデータ ディスクを追加するために使用されるパラメーターを指定します。 ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。

diskControllerType

DiskControllerTypes

VM 用に構成されたディスク コントローラーの種類を指定します。 メモ: 指定されていない場合、このプロパティは、指定された最小 API バージョンのオペレーティング システム ディスクと VM サイズの機能に基づいて、"hyperVGeneration" が V2 に設定された状態で作成される仮想マシンが既定のディスク コントローラーの種類に設定されます。 VM の割り当てを暗黙的に解除して再割り当てする VM 構成で VM サイズを更新しない限り、ディスク コントローラーの種類を更新する前に VM の割り当てを解除する必要があります。 最小 api-version: 2022-08-01。

imageReference

ImageReference

使用するイメージに関する情報を指定します。 プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージに関する情報を指定できます。 この要素は、プラットフォーム イメージ、マーケットプレース イメージ、または仮想マシン イメージを使用する場合に必要ですが、他の作成操作では使用されません。

osDisk

OSDisk

仮想マシンで使用されるオペレーティング システム ディスクに関する情報を指定します。 ディスクの詳細については、「 Azure 仮想マシンのディスクと VHD について」を参照してください。

SubResource

シークレットを含むKey Vaultの相対 URL。

名前 説明
id

string

リソース ID

TerminateNotificationProfile

Terminate Scheduled Event 関連の構成を指定します。

名前 説明
enable

boolean

Terminate Scheduled イベントを有効にするか無効にするかを指定します。

notBeforeTimeout

string

削除される仮想マシンの構成可能な時間の長さは、イベントが自動承認 (タイムアウト) される前に、スケジュールされたイベントの終了を承認する必要があります。 構成は ISO 8601 形式で指定する必要があります。既定値は 5 分 (PT5M) です

UefiSettings

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

名前 説明
secureBootEnabled

boolean

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

vTpmEnabled

boolean

仮想マシンで vTPM を有効にするかどうかを指定します。 最小 api-version: 2020-12-01。

UserAssignedIdentities

仮想マシンに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

名前 説明

UserInitiatedReboot

userInitiatedReboot のスケジュールされたイベント設定の作成の作成時に使用される構成パラメーター。

名前 説明
automaticallyApprove

boolean

再起動スケジュールされたイベント関連の構成を指定します。

UserInitiatedRedeploy

userInitiatedRedeploy スケジュールされたイベント設定の作成の作成時に使用される構成パラメーター。

名前 説明
automaticallyApprove

boolean

スケジュールされたイベントに関連する構成の再デプロイを指定します。

VaultCertificate

証明書を含む SourceVault のキー コンテナー参照の一覧。

名前 説明
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

仮想マシンにインストールする必要がある証明書のセットを指定します。 仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault 仮想マシン拡張機能を使用することをお勧めします。

名前 説明
sourceVault

SubResource

VaultCertificates のすべての証明書を含むKey Vaultの相対 URL。

vaultCertificates

VaultCertificate[]

証明書を含む SourceVault 内のキー コンテナー参照の一覧。

VirtualHardDisk

仮想ハード ディスク。

名前 説明
uri

string

仮想ハード ディスクの URI を指定します。

VirtualMachine

仮想マシンについて説明します。

名前 説明
etag

string

Etag は、VM の Create/Update/Get 応答で返されるプロパティです。これにより、顧客はヘッダーで提供して、オプティミスティック更新を保証できます。

extendedLocation

ExtendedLocation

仮想マシンの拡張された場所。

id

string

リソース ID

identity

VirtualMachineIdentity

構成されている場合は、仮想マシンの ID。

location

string

リソースの場所

managedBy

string

VM が VMSS の一部である場合、ManagedBy は仮想マシン スケール セット (VMSS) flex ARM resourceID に設定されます。 このプロパティは、内部リソース グループの削除の最適化のためにプラットフォームによって使用されます。

name

string

リソース名

plan

Plan

仮想マシンの作成に使用されるマーケットプレース イメージに関する情報を指定します。 この要素は、マーケットプレース イメージにのみ使用されます。 API からマーケットプレース イメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portalで、使用するマーケットプレース イメージを見つけて、[プログラムでデプロイする] をクリックします。[作業の開始] を>クリックします。 必要な情報を入力し、[ 保存] をクリックします。

properties.additionalCapabilities

AdditionalCapabilities

仮想マシンで有効または無効にする追加の機能を指定します。

properties.applicationProfile

ApplicationProfile

VM/VMSS で使用できるようにするギャラリー アプリケーションを指定します。

properties.availabilitySet

SubResource

仮想マシンを割り当てる可用性セットに関する情報を指定します。 同じ可用性セットで指定された仮想マシンは、可用性を最大化するために別々のノードに割り当てられます。 可用性セットの詳細については、「可用性 セットの概要」を参照してください。 Azure の計画メンテナンスの詳細については、「Azure でのVirtual Machinesのメンテナンスと更新」を参照してください。 現時点では、VM は作成時にのみ可用性セットに追加できます。 VM が追加される可用性セットは、可用性セット リソースと同じリソース グループの下に存在する必要があります。 既存の VM を可用性セットに追加することはできません。 このプロパティは、null 以外の properties.virtualMachineScaleSet 参照と共に存在することはできません。

properties.billingProfile

BillingProfile

Azure Spot 仮想マシンの課金関連の詳細を指定します。 最小 api-version: 2019-03-01。

properties.capacityReservation

CapacityReservationProfile

仮想マシンの割り当てに使用される容量予約に関する情報を指定します。 最小 api-version: 2021-04-01。

properties.diagnosticsProfile

DiagnosticsProfile

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

properties.evictionPolicy

VirtualMachineEvictionPolicyTypes

Azure スポット仮想マシンと Azure スポット スケール セットの削除ポリシーを指定します。 Azure Spot 仮想マシンの場合、"割り当て解除" と "削除" の両方がサポートされており、最小 api バージョンは 2019-03-01 です。 Azure スポット スケール セットでは、"割り当て解除" と "削除" の両方がサポートされており、api-version の最小バージョンは 2017-10-30-preview です。

properties.extensionsTimeBudget

string

すべての拡張機能の開始時間を指定します。 期間は 15 分から 120 分 (含む) で、ISO 8601 形式で指定する必要があります。 既定値は 90 分 (PT1H30M)。 最小 api-version: 2020-06-01。

properties.hardwareProfile

HardwareProfile

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

properties.host

SubResource

仮想マシンが存在する専用ホストに関する情報を指定します。 最小 api-version: 2018-10-01。

properties.hostGroup

SubResource

仮想マシンが存在する専用ホスト グループに関する情報を指定します。 メモ: ユーザーは、host プロパティと hostGroup プロパティの両方を指定できません。 最小 api-version: 2020-06-01。

properties.instanceView

VirtualMachineInstanceView

仮想マシン インスタンス ビュー。

properties.licenseType

string

使用されているイメージまたはディスクがオンプレミスでライセンスされていることを指定します。

Windows Server オペレーティング システムに使用できる値は次のとおりです。

Windows_Client

Windows_Server

Linux Server オペレーティング システムに使用できる値は次のとおりです。

RHEL_BYOS (RHEL の場合)

SLES_BYOS (SUSE の場合)

詳細については、「Windows Server の Azure ハイブリッド使用特典」を参照してください。

Linux Server の Azure ハイブリッド使用特典

最小 api-version: 2015-06-15

properties.networkProfile

NetworkProfile

仮想マシンのネットワーク インターフェイスを指定します。

properties.osProfile

OSProfile

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

properties.platformFaultDomain

integer

仮想マシンを作成するスケール セットの論理障害ドメインを指定します。 既定では、仮想マシンは、使用可能な障害ドメイン間のバランスを最適に維持する障害ドメインに自動的に割り当てられます。 これは、この仮想マシンの 'virtualMachineScaleSet' プロパティが設定されている場合にのみ適用されます。 参照される仮想マシン スケール セットには、1 より大きい 'platformFaultDomainCount' が必要です。 このプロパティは、仮想マシンを作成した後は更新できません。 障害ドメインの割り当ては、仮想マシン インスタンス ビューで表示できます。 最小 api-version: 2020‐12-01。

properties.priority

VirtualMachinePriorityTypes

仮想マシンの優先度を指定します。 最小 api-version: 2019-03-01

properties.provisioningState

string

プロビジョニング状態。これは応答にのみ表示されます。

properties.proximityPlacementGroup

SubResource

仮想マシンを割り当てる必要がある近接配置グループに関する情報を指定します。 最小 api-version: 2018-04-01。

properties.scheduledEventsPolicy

ScheduledEventsPolicy

仮想マシンの再デプロイ、再起動、および ScheduledEventsAdditionalPublishingTargets Scheduled Event 関連の構成を指定します。

properties.scheduledEventsProfile

ScheduledEventsProfile

スケジュールされたイベント関連の構成を指定します。

properties.securityProfile

SecurityProfile

仮想マシンのセキュリティ関連のプロファイル設定を指定します。

properties.storageProfile

StorageProfile

仮想マシンのストレージ設定を指定します。

properties.timeCreated

string

仮想マシン リソースが作成された時刻を指定します。 最小 api-version: 2021-11-01。

properties.userData

string

VM の UserData。Base-64 でエンコードする必要があります。 お客様はここでシークレットを渡さないでください。 最小 api-version: 2021-03-01。

properties.virtualMachineScaleSet

SubResource

仮想マシンを割り当てる仮想マシン スケール セットに関する情報を指定します。 同じ仮想マシン スケール セットで指定された仮想マシンは、可用性を最大化するために異なるノードに割り当てられます。 現時点では、VM は作成時にのみ仮想マシン スケール セットに追加できます。 既存の VM を仮想マシン スケール セットに追加することはできません。 このプロパティは、null 以外の properties.availabilitySet 参照と共に存在することはできません。 最小 api-version: 2019‐03-01。

properties.vmId

string

すべての Azure IaaS VM SMBIOS にエンコードおよび格納され、プラットフォーム BIOS コマンドを使用して読み取ることができる 128 ビット識別子である VM の一意の ID を指定します。

resources

VirtualMachineExtension[]

仮想マシンの子拡張機能リソース。

tags

object

リソース タグ

type

string

リソースの種類

zones

string[]

仮想マシン ゾーン。

VirtualMachineAgentInstanceView

仮想マシンで実行されている VM エージェント。

名前 説明
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

仮想マシン拡張機能ハンドラー インスタンス ビュー。

statuses

InstanceViewStatus[]

リソースの状態情報。

vmAgentVersion

string

VM エージェントのフル バージョン。

VirtualMachineEvictionPolicyTypes

Azure スポット仮想マシンと Azure スポット スケール セットの削除ポリシーを指定します。 Azure Spot 仮想マシンの場合、"割り当て解除" と "削除" の両方がサポートされており、最小 api バージョンは 2019-03-01 です。 Azure スポット スケール セットでは、"割り当て解除" と "削除" の両方がサポートされており、api-version の最小バージョンは 2017-10-30-preview です。

名前 説明
Deallocate

string

Delete

string

VirtualMachineExtension

仮想マシンの子拡張機能リソース。

名前 説明
id

string

リソース ID

location

string

リソースの場所

name

string

リソース名

properties.autoUpgradeMinorVersion

boolean

展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能でマイナー バージョンのアップグレードは行われません。

properties.enableAutomaticUpgrade

boolean

新しいバージョンの拡張機能が使用可能な場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。

properties.forceUpdateTag

string

拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。

properties.instanceView

VirtualMachineExtensionInstanceView

仮想マシン拡張機能インスタンス ビュー。

properties.protectedSettings

object

拡張機能には、protectedSettings または protectedSettingsFromKeyVault を含めることができます。または、保護された設定をまったく含めなくなります。

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

参照渡しで渡され、キー コンテナーから使用される拡張機能で保護された設定

properties.provisionAfterExtensions

string[]

この拡張機能をプロビジョニングする必要がある拡張機能名のコレクション。

properties.provisioningState

string

プロビジョニング状態。これは応答にのみ表示されます。

properties.publisher

string

拡張ハンドラーの発行元の名前。

properties.settings

object

拡張機能の Json 形式のパブリック設定。

properties.suppressFailures

boolean

拡張機能に起因するエラーが抑制されるかどうかを示します (VM に接続しないなどの操作エラーは、この値に関係なく抑制されません)。 既定値は false です。

properties.type

string

拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。

properties.typeHandlerVersion

string

スクリプト ハンドラーのバージョンを指定します。

tags

object

リソース タグ

type

string

リソースの種類

VirtualMachineExtensionHandlerInstanceView

仮想マシン拡張機能ハンドラー インスタンス ビュー。

名前 説明
status

InstanceViewStatus

拡張ハンドラーの状態。

type

string

拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。

typeHandlerVersion

string

スクリプト ハンドラーのバージョンを指定します。

VirtualMachineExtensionInstanceView

仮想マシン拡張機能インスタンス ビュー。

名前 説明
name

string

仮想マシン拡張機能の名前。

statuses

InstanceViewStatus[]

リソースの状態情報。

substatuses

InstanceViewStatus[]

リソースの状態情報。

type

string

拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。

typeHandlerVersion

string

スクリプト ハンドラーのバージョンを指定します。

VirtualMachineHealthStatus

VM の正常性状態。

名前 説明
status

InstanceViewStatus

VM の正常性状態情報。

VirtualMachineIdentity

構成されている場合は、仮想マシンの ID。

名前 説明
principalId

string

仮想マシン ID のプリンシパル ID。 このプロパティは、システム割り当て ID に対してのみ提供されます。

tenantId

string

仮想マシンに関連付けられているテナント ID。 このプロパティは、システム割り当て ID に対してのみ提供されます。

type

ResourceIdentityType

仮想マシンに使用される ID の種類。 種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 種類 'None' は、仮想マシンから ID を削除します。

userAssignedIdentities

UserAssignedIdentities

仮想マシンに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

VirtualMachineInstanceView

仮想マシン インスタンス ビュー。

名前 説明
assignedHost

string

自動配置が有効になっている専用ホスト グループに仮想マシンが関連付けられている場合に、仮想マシンが自動配置によって割り当てられる専用ホストのリソース ID。 最小 api-version: 2020-06-01。

bootDiagnostics

BootDiagnosticsInstanceView

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

computerName

string

仮想マシンに割り当てられたコンピューター名。

disks

DiskInstanceView[]

仮想マシンのディスク情報。

extensions

VirtualMachineExtensionInstanceView[]

拡張機能の情報。

hyperVGeneration

HyperVGenerationType

リソースに関連付けられている HyperVGeneration の種類を指定します

isVMInStandbyPool

boolean

[プレビュー機能]VM が現在スタンバイ プールに入っているか、スタンバイ プール外にあるかを指定します。

maintenanceRedeployStatus

MaintenanceRedeployStatus

仮想マシンのメンテナンス操作の状態。

osName

string

仮想マシンで実行されているオペレーティング システム。

osVersion

string

仮想マシンで実行されているオペレーティング システムのバージョン。

patchStatus

VirtualMachinePatchStatus

[プレビュー機能]仮想マシンのパッチ操作の状態。

platformFaultDomain

integer

仮想マシンの障害ドメインを指定します。

platformUpdateDomain

integer

仮想マシンの更新ドメインを指定します。

rdpThumbPrint

string

リモート デスクトップ証明書の拇印。

statuses

InstanceViewStatus[]

リソースの状態情報。

vmAgent

VirtualMachineAgentInstanceView

仮想マシンで実行されている VM エージェント。

vmHealth

VirtualMachineHealthStatus

VM の正常性状態。

VirtualMachineIpTag

パブリック IP アドレスに関連付けられている IP タグの一覧。

名前 説明
ipTagType

string

IP タグの種類。 例: FirstPartyUsage。

tag

string

パブリック IP に関連付けられている IP タグ。 例: SQL、ストレージなど。

VirtualMachineNetworkInterfaceConfiguration

仮想マシン ネットワーク リソースの作成に使用するネットワーク構成を指定します。

名前 説明
name

string

ネットワーク インターフェイス構成名。

properties.auxiliaryMode

NetworkInterfaceAuxiliaryMode

ネットワーク インターフェイス リソースに対して補助モードを有効にするかどうかを指定します。

properties.auxiliarySku

NetworkInterfaceAuxiliarySku

ネットワーク インターフェイス リソースに対して補助 SKU を有効にするかどうかを指定します。

properties.deleteOption

DeleteOptions

VM が削除されたときのネットワーク インターフェイスの動作を指定する

properties.disableTcpStateTracking

boolean

tcp 状態の追跡に対してネットワーク インターフェイスを無効にするかどうかを指定します。

properties.dnsSettings

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

ネットワーク インターフェイスに適用される DNS 設定。

properties.dscpConfiguration

SubResource

properties.enableAcceleratedNetworking

boolean

ネットワーク インターフェイスが高速ネットワーク対応かどうかを指定します。

properties.enableFpga

boolean

ネットワーク インターフェイスが FPGA ネットワーク対応かどうかを指定します。

properties.enableIPForwarding

boolean

この NIC で IP 転送が有効になっているかどうか。

properties.ipConfigurations

VirtualMachineNetworkInterfaceIPConfiguration[]

ネットワーク インターフェイスの IP 構成を指定します。

properties.networkSecurityGroup

SubResource

ネットワーク セキュリティ グループ。

properties.primary

boolean

仮想マシンに 1 つ以上のネットワーク インターフェイスがある場合に備えて、プライマリ ネットワーク インターフェイスを指定します。

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

ネットワーク インターフェイスに適用される DNS 設定。

名前 説明
dnsServers

string[]

DNS サーバーの IP アドレスの一覧

VirtualMachineNetworkInterfaceIPConfiguration

ネットワーク インターフェイスの IP 構成を指定します。

名前 説明
name

string

IP 構成名。

properties.applicationGatewayBackendAddressPools

SubResource[]

アプリケーション ゲートウェイのバックエンド アドレス プールへの参照の配列を指定します。 仮想マシンは、複数のアプリケーション ゲートウェイのバックエンド アドレス プールを参照できます。 複数の仮想マシンで同じアプリケーション ゲートウェイを使用することはできません。

properties.applicationSecurityGroups

SubResource[]

アプリケーション セキュリティ グループへの参照の配列を指定します。

properties.loadBalancerBackendAddressPools

SubResource[]

ロード バランサーのバックエンド アドレス プールへの参照の配列を指定します。 仮想マシンは、1 つのパブリック ロード バランサーと 1 つの内部ロード バランサーのバックエンド アドレス プールを参照できます。 [複数の仮想マシンで同じ Basic SKU ロード バランサーを使用できません]。

properties.primary

boolean

仮想マシンに 1 つ以上のネットワーク インターフェイスがある場合のプライマリ ネットワーク インターフェイスを指定します。

properties.privateIPAddressVersion

IPVersions

Api-Version 2017-03-30 以降で使用でき、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 と見なされます。 使用可能な値は、'IPv4' と 'IPv6' です。

properties.publicIPAddressConfiguration

VirtualMachinePublicIPAddressConfiguration

publicIPAddressConfiguration。

properties.subnet

SubResource

サブネットの識別子を指定します。

VirtualMachinePatchStatus

[プレビュー機能]仮想マシンのパッチ操作の状態。

名前 説明
availablePatchSummary

AvailablePatchSummary

仮想マシンの最新の評価操作の利用可能なパッチの概要。

configurationStatuses

InstanceViewStatus[]

指定した patchMode の有効化状態

lastPatchInstallationSummary

LastPatchInstallationSummary

仮想マシンの最新のインストール操作のインストールの概要。

VirtualMachinePriorityTypes

仮想マシンの優先度を指定します。 最小 api-version: 2019-03-01

名前 説明
Low

string

Regular

string

Spot

string

VirtualMachinePublicIPAddressConfiguration

publicIPAddressConfiguration。

名前 説明
name

string

publicIP アドレス構成名。

properties.deleteOption

DeleteOptions

VM が削除されたときのパブリック IP アドレスの動作を指定する

properties.dnsSettings

VirtualMachinePublicIPAddressDnsSettingsConfiguration

publicIP アドレスに適用される DNS 設定。

properties.idleTimeoutInMinutes

integer

パブリック IP アドレスのアイドル タイムアウト。

properties.ipTags

VirtualMachineIpTag[]

パブリック IP アドレスに関連付けられている IP タグの一覧。

properties.publicIPAddressVersion

IPVersions

Api-Version 2019-07-01 以降で使用できます。これは、特定の ipconfiguration が IPv4 か IPv6 かを表します。 既定値は IPv4 と見なされます。 使用可能な値は、'IPv4' と 'IPv6' です。

properties.publicIPAllocationMethod

PublicIPAllocationMethod

パブリック IP 割り当ての種類を指定する

properties.publicIPPrefix

SubResource

publicIP アドレスの割り当て元となる PublicIPPrefix。

sku

PublicIPAddressSku

パブリック IP SKU について説明します。 これは、OrchestrationMode でフレキシブルとしてのみ設定できます。

VirtualMachinePublicIPAddressDnsSettingsConfiguration

publicIP アドレスに適用される DNS 設定。

名前 説明
domainNameLabel

string

作成される PublicIPAddress リソースのドメイン名ラベル プレフィックス。 生成された名前ラベルは、ドメイン名ラベルと VM ネットワーク プロファイルの一意の ID を連結したものです。

domainNameLabelScope

DomainNameLabelScopeTypes

作成される PublicIPAddress リソースのドメイン名ラベル スコープ。 生成された名前ラベルは、ドメイン名ラベルのスコープと VM ネットワーク プロファイルの一意の ID に従って、ハッシュされたドメイン名ラベルとポリシーを連結したものです。

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

マネージド ディスクのセキュリティ プロファイルを指定します。

名前 説明
diskEncryptionSet

DiskEncryptionSetParameters

カスタマー マネージド キーで暗号化された ConfidentialVM OS ディスクと VMGuest BLOB に使用されるマネージド ディスクのカスタマー マネージド ディスク暗号化セット リソース ID を指定します。

securityEncryptionType

securityEncryptionTypes

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

VMGalleryApplication

VM/VMSS で使用できるようにするギャラリー アプリケーションを指定します

名前 説明
configurationReference

string

省略可能。指定された場合にパッケージの既定の構成を置き換える Azure BLOB への URI を指定します

enableAutomaticUpgrade

boolean

true に設定すると、新しいギャラリー アプリケーション バージョンが PIR/SIG で使用できる場合、VM/VMSS に対して自動的に更新されます

order

integer

省略可能。パッケージをインストールする必要がある順序を指定します

packageReferenceId

string

/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} の形式で GalleryApplicationVersion リソース ID を指定します

tags

string

オプション。より汎用的なコンテキストのパススルー値を指定します。

treatFailureAsDeploymentFailure

boolean

省略可能、true の場合、VmApplication 内の操作に対するエラーはデプロイに失敗します

VMSizeProperties

仮想マシンのサイズをカスタマイズするためのプロパティを指定します。 最小 api-version: 2021-07-01。 この機能はまだプレビュー モードであり、VirtualMachineScaleSet ではサポートされていません。 詳細については、「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

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

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

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

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

名前 説明
AutomaticByPlatform

string

ImageDefault

string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

名前 説明
Always

string

IfRequired

string

Never

string

Unknown

string

WindowsVMGuestPatchAutomaticByPlatformSettings

Windows 上の VM ゲスト修正プログラムのパッチ モード 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

Windows リモート管理リスナーを指定します。 これによって、リモートの Windows PowerShell が有効になります。

名前 説明
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 です。