VirtualMachine interface
仮想マシンについて説明します。
- Extends
プロパティ
| additional |
仮想マシンで有効または無効になっている追加の機能を指定します。 |
| application |
VM/VMSS で使用できるようにするギャラリー アプリケーションを指定します。 |
| availability |
仮想マシンを割り当てる可用性セットに関する情報を指定します。 同じ可用性セットで指定された仮想マシンは、可用性を最大化するために異なるノードに割り当てられます。 可用性セットの詳細については、「可用性セットの概要 を参照してください。 Azure の計画メンテナンスの詳細については、「Azure の仮想マシンのメンテナンスと更新プログラム」を参照してください。 現時点では、VM は作成時にのみ可用性セットに追加できます。 VM が追加される可用性セットは、可用性セット リソースと同じリソース グループの下に存在する必要があります。 既存の VM を可用性セットに追加することはできません。 このプロパティは、null 以外の properties.virtualMachineScaleSet 参照と共に存在できません。 |
| billing |
Azure スポット仮想マシンの課金関連の詳細を指定します。 最小 API バージョン: 2019-03-01。 |
| capacity |
仮想マシンの割り当てに使用される容量予約に関する情報を指定します。 最小 API バージョン: 2021-04-01。 |
| diagnostics |
ブート診断設定の状態を指定します。 最小 API バージョン: 2015-06-15。 |
| etag | Etag は、VM の作成/更新/取得応答で返されるプロパティです。これにより、お客様は、オプティミスティック更新を保証するためにヘッダーで指定できます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| eviction |
Azure スポット仮想マシンと Azure スポット スケール セットの削除ポリシーを指定します。 Azure Spot 仮想マシンでは、"割り当て解除" と "削除" の両方がサポートされており、最小 API バージョンは 2019-03-01 です。 Azure スポット スケール セットの場合、"割り当て解除" と "削除" の両方がサポートされ、最小 API バージョンは 2017-10-30-preview です。 |
| extended |
仮想マシンの拡張された場所。 |
| extensions |
すべての拡張機能の割り当て時間を指定します。 期間は 15 分から 120 分 (含む) で、ISO 8601 形式で指定する必要があります。 既定値は 90 分 (PT1H30M) です。 最小 API バージョン: 2020-06-01。 |
| hardware |
仮想マシンのハードウェア設定を指定します。 |
| host | 仮想マシンが存在する専用ホストに関する情報を指定します。 最小 API バージョン: 2018-10-01。 |
| host |
仮想マシンが存在する専用ホスト グループに関する情報を指定します。 注: ユーザーは、host プロパティと hostGroup プロパティの両方を指定できません。 最小 API バージョン: 2020-06-01。 |
| identity | 構成されている場合は、仮想マシンの ID。 |
| instance |
仮想マシン インスタンス ビュー。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| license |
使用されているイメージまたはディスクがオンプレミスでライセンスされていることを指定します。 |
| managed |
VM が VMSS の一部である場合、ManagedBy は仮想マシン スケール セット (VMSS) flex ARM resourceID に設定されます。 このプロパティは、内部リソース グループの削除の最適化のためにプラットフォームによって使用されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| network |
仮想マシンのネットワーク インターフェイスを指定します。 |
| os |
仮想マシンの作成時に使用されるオペレーティング システムの設定を指定します。 一部の設定は、VM をプロビジョニングした後は変更できません。 |
| placement | [配置] セクションでは、仮想マシンのハードウェア配置に対するユーザー定義の制約を指定します。 このプロパティは、VM がプロビジョニングされた後は変更できません。 最小 API バージョン: 2024-11-01。 |
| plan | 仮想マシンの作成に使用されるマーケットプレース イメージに関する情報を指定します。 この要素は、Marketplace イメージにのみ使用されます。 API からマーケットプレース イメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portal で、使用するマーケットプレース イメージを見つけて、[プログラムでデプロイする ] をクリック>。 必要な情報を入力し、[保存 クリックします。 |
| platform |
仮想マシンを作成するスケール セットの論理障害ドメインを指定します。 既定では、仮想マシンは、使用可能な障害ドメイン間のバランスを最適に維持する障害ドメインに自動的に割り当てられます。 これは、この仮想マシンの 'virtualMachineScaleSet' プロパティが設定されている場合にのみ適用されます。 参照される仮想マシン スケール セットの 'platformFaultDomainCount' が 1 より大きい必要があります。 このプロパティは、仮想マシンが作成された後は更新できません。 障害ドメインの割り当ては、仮想マシン インスタンス ビューで表示できます。 最小 API バージョン: 2020‐12‐01。 |
| priority | 仮想マシンの優先順位を指定します。 最小 API バージョン: 2019-03-01 |
| provisioning |
プロビジョニング状態。応答にのみ表示されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| proximity |
仮想マシンを割り当てる近接通信配置グループに関する情報を指定します。 最小 API バージョン: 2018-04-01。 |
| resources | 仮想マシンの子拡張機能リソース。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| scheduled |
仮想マシンの再デプロイ、再起動、ScheduledEventsAdditionalPublishingTargets Scheduled Event 関連の構成を指定します。 |
| scheduled |
スケジュールされたイベント関連の構成を指定します。 |
| security |
仮想マシンのセキュリティ関連のプロファイル設定を指定します。 |
| storage |
仮想マシン ディスクのストレージ設定を指定します。 |
| time |
仮想マシン リソースが作成された時刻を指定します。 最小 API バージョン: 2021-11-01。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| user |
VM の UserData。base-64 でエンコードする必要があります。 顧客はここでシークレットを渡すべきではありません。 最小 API バージョン: 2021-03-01。 |
| virtual |
仮想マシンを割り当てる仮想マシン スケール セットに関する情報を指定します。 同じ仮想マシン スケール セットで指定された仮想マシンは、可用性を最大化するために異なるノードに割り当てられます。 現時点では、VM は作成時にのみ仮想マシン スケール セットに追加できます。 既存の VM を仮想マシン スケール セットに追加することはできません。 このプロパティは、null 以外の properties.availabilitySet 参照と共に存在できません。 最小 API バージョン: 2019‐03‐01。 |
| vm |
すべての Azure IaaS VM SMBIOS でエンコードおよび格納され、プラットフォーム BIOS コマンドを使用して読み取ることができる 128 ビット識別子である VM の一意の ID を指定します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| zones | 可用性ゾーン。 |
継承されたプロパティ
| id | リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| location | リソースが存在する地理的な場所 |
| name | リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| system |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
| tags | リソース タグ。 |
| type | リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
プロパティの詳細
additionalCapabilities
仮想マシンで有効または無効になっている追加の機能を指定します。
additionalCapabilities?: AdditionalCapabilitiesプロパティ値
applicationProfile
VM/VMSS で使用できるようにするギャラリー アプリケーションを指定します。
applicationProfile?: ApplicationProfileプロパティ値
availabilitySet
仮想マシンを割り当てる可用性セットに関する情報を指定します。 同じ可用性セットで指定された仮想マシンは、可用性を最大化するために異なるノードに割り当てられます。 可用性セットの詳細については、「可用性セットの概要 を参照してください。 Azure の計画メンテナンスの詳細については、「Azure の仮想マシンのメンテナンスと更新プログラム」を参照してください。 現時点では、VM は作成時にのみ可用性セットに追加できます。 VM が追加される可用性セットは、可用性セット リソースと同じリソース グループの下に存在する必要があります。 既存の VM を可用性セットに追加することはできません。 このプロパティは、null 以外の properties.virtualMachineScaleSet 参照と共に存在できません。
availabilitySet?: SubResourceプロパティ値
billingProfile
Azure スポット仮想マシンの課金関連の詳細を指定します。 最小 API バージョン: 2019-03-01。
billingProfile?: BillingProfileプロパティ値
capacityReservation
仮想マシンの割り当てに使用される容量予約に関する情報を指定します。 最小 API バージョン: 2021-04-01。
capacityReservation?: CapacityReservationProfileプロパティ値
diagnosticsProfile
ブート診断設定の状態を指定します。 最小 API バージョン: 2015-06-15。
diagnosticsProfile?: DiagnosticsProfileプロパティ値
etag
Etag は、VM の作成/更新/取得応答で返されるプロパティです。これにより、お客様は、オプティミスティック更新を保証するためにヘッダーで指定できます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
etag?: stringプロパティ値
string
evictionPolicy
Azure スポット仮想マシンと Azure スポット スケール セットの削除ポリシーを指定します。 Azure Spot 仮想マシンでは、"割り当て解除" と "削除" の両方がサポートされており、最小 API バージョンは 2019-03-01 です。 Azure スポット スケール セットの場合、"割り当て解除" と "削除" の両方がサポートされ、最小 API バージョンは 2017-10-30-preview です。
evictionPolicy?: stringプロパティ値
string
extendedLocation
extensionsTimeBudget
すべての拡張機能の割り当て時間を指定します。 期間は 15 分から 120 分 (含む) で、ISO 8601 形式で指定する必要があります。 既定値は 90 分 (PT1H30M) です。 最小 API バージョン: 2020-06-01。
extensionsTimeBudget?: stringプロパティ値
string
hardwareProfile
host
hostGroup
仮想マシンが存在する専用ホスト グループに関する情報を指定します。 注: ユーザーは、host プロパティと hostGroup プロパティの両方を指定できません。 最小 API バージョン: 2020-06-01。
hostGroup?: SubResourceプロパティ値
identity
instanceView
仮想マシン インスタンス ビュー。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
instanceView?: VirtualMachineInstanceViewプロパティ値
licenseType
使用されているイメージまたはディスクがオンプレミスでライセンスされていることを指定します。
Windows Server オペレーティング システムに使用できる値は次のとおりです。
Windows_Client
Windows_Server
Linux Server オペレーティング システムで使用できる値は次のとおりです。
RHEL_BYOS (RHEL の場合)
SLES_BYOS (SUSE の場合)
詳細については、「Windows Server の Azure ハイブリッド使用特典の」を参照してください。
Linux Server の Azure ハイブリッド使用特典の
最小 API バージョン: 2015-06-15
licenseType?: stringプロパティ値
string
managedBy
VM が VMSS の一部である場合、ManagedBy は仮想マシン スケール セット (VMSS) flex ARM resourceID に設定されます。 このプロパティは、内部リソース グループの削除の最適化のためにプラットフォームによって使用されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
managedBy?: stringプロパティ値
string
networkProfile
osProfile
仮想マシンの作成時に使用されるオペレーティング システムの設定を指定します。 一部の設定は、VM をプロビジョニングした後は変更できません。
osProfile?: OSProfileプロパティ値
placement
[配置] セクションでは、仮想マシンのハードウェア配置に対するユーザー定義の制約を指定します。 このプロパティは、VM がプロビジョニングされた後は変更できません。 最小 API バージョン: 2024-11-01。
placement?: Placementプロパティ値
plan
仮想マシンの作成に使用されるマーケットプレース イメージに関する情報を指定します。 この要素は、Marketplace イメージにのみ使用されます。 API からマーケットプレース イメージを使用する前に、プログラムで使用するためにイメージを有効にする必要があります。 Azure portal で、使用するマーケットプレース イメージを見つけて、[プログラムでデプロイする ] をクリック>。 必要な情報を入力し、[保存 クリックします。
plan?: Planプロパティ値
platformFaultDomain
仮想マシンを作成するスケール セットの論理障害ドメインを指定します。 既定では、仮想マシンは、使用可能な障害ドメイン間のバランスを最適に維持する障害ドメインに自動的に割り当てられます。 これは、この仮想マシンの 'virtualMachineScaleSet' プロパティが設定されている場合にのみ適用されます。 参照される仮想マシン スケール セットの 'platformFaultDomainCount' が 1 より大きい必要があります。 このプロパティは、仮想マシンが作成された後は更新できません。 障害ドメインの割り当ては、仮想マシン インスタンス ビューで表示できます。 最小 API バージョン: 2020‐12‐01。
platformFaultDomain?: numberプロパティ値
number
priority
仮想マシンの優先順位を指定します。 最小 API バージョン: 2019-03-01
priority?: stringプロパティ値
string
provisioningState
プロビジョニング状態。応答にのみ表示されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
provisioningState?: stringプロパティ値
string
proximityPlacementGroup
仮想マシンを割り当てる近接通信配置グループに関する情報を指定します。 最小 API バージョン: 2018-04-01。
proximityPlacementGroup?: SubResourceプロパティ値
resources
仮想マシンの子拡張機能リソース。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
resources?: VirtualMachineExtension[]プロパティ値
scheduledEventsPolicy
仮想マシンの再デプロイ、再起動、ScheduledEventsAdditionalPublishingTargets Scheduled Event 関連の構成を指定します。
scheduledEventsPolicy?: ScheduledEventsPolicyプロパティ値
scheduledEventsProfile
スケジュールされたイベント関連の構成を指定します。
scheduledEventsProfile?: ScheduledEventsProfileプロパティ値
securityProfile
storageProfile
timeCreated
仮想マシン リソースが作成された時刻を指定します。 最小 API バージョン: 2021-11-01。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
timeCreated?: Dateプロパティ値
Date
userData
VM の UserData。base-64 でエンコードする必要があります。 顧客はここでシークレットを渡すべきではありません。 最小 API バージョン: 2021-03-01。
userData?: stringプロパティ値
string
virtualMachineScaleSet
仮想マシンを割り当てる仮想マシン スケール セットに関する情報を指定します。 同じ仮想マシン スケール セットで指定された仮想マシンは、可用性を最大化するために異なるノードに割り当てられます。 現時点では、VM は作成時にのみ仮想マシン スケール セットに追加できます。 既存の VM を仮想マシン スケール セットに追加することはできません。 このプロパティは、null 以外の properties.availabilitySet 参照と共に存在できません。 最小 API バージョン: 2019‐03‐01。
virtualMachineScaleSet?: SubResourceプロパティ値
vmId
すべての Azure IaaS VM SMBIOS でエンコードおよび格納され、プラットフォーム BIOS コマンドを使用して読み取ることができる 128 ビット識別子である VM の一意の ID を指定します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
vmId?: stringプロパティ値
string
zones
可用性ゾーン。
zones?: string[]プロパティ値
string[]
継承されたプロパティの詳細
id
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
id?: stringプロパティ値
string
location
リソースが存在する地理的な場所
location: stringプロパティ値
string
TrackedResource.location から継承
name
リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
name?: stringプロパティ値
string
systemData
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
systemData?: SystemDataプロパティ値
trackedResource.systemData から継承
tags
リソース タグ。
tags?: {[propertyName: string]: string}プロパティ値
{[propertyName: string]: string}
type
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
type?: stringプロパティ値
string
trackedResource.type