次の方法で共有


VirtualMachine interface

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

Extends

プロパティ

additionalCapabilities

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

applicationProfile

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

availabilitySet

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

billingProfile

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

capacityReservation

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

diagnosticsProfile

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

etag

Etag は、VM の Create/Update/Get 応答で返されるプロパティです。これにより、顧客はヘッダーで提供して、オプティミスティック更新を保証できます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

evictionPolicy

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

extendedLocation

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

extensionsTimeBudget

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

hardwareProfile

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

host

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

hostGroup

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

identity

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

instanceView

仮想マシン インスタンス ビュー。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

licenseType

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

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

managedBy

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

networkProfile

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

osProfile

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

plan

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

platformFaultDomain

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

priority

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

provisioningState

プロビジョニング状態。これは応答にのみ表示されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

proximityPlacementGroup

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

resources

仮想マシンの子拡張機能リソース。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

scheduledEventsPolicy

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

scheduledEventsProfile

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

securityProfile

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

storageProfile

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

timeCreated

仮想マシン リソースが作成された時刻を指定します。 最小 api-version: 2021-11-01。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

userData

VM の UserData。Base-64 でエンコードする必要があります。 顧客はここでシークレットを渡すべきではありません。 最小 api-version: 2021-03-01。

virtualMachineScaleSet

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

vmId

すべての Azure IaaS VM SMBIOS にエンコードおよび格納され、プラットフォーム BIOS コマンドを使用して読み取ることができる 128 ビット識別子である VM の一意の ID を指定します。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

zones

仮想マシン ゾーン。

継承されたプロパティ

id

リソース ID 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

location

リソースの場所

name

リソース名注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

tags

リソース タグ

type

リソースの種類注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

additionalCapabilities

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

additionalCapabilities?: AdditionalCapabilities

プロパティ値

applicationProfile

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

applicationProfile?: ApplicationProfile

プロパティ値

availabilitySet

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

availabilitySet?: SubResource

プロパティ値

billingProfile

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

billingProfile?: BillingProfile

プロパティ値

capacityReservation

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

capacityReservation?: CapacityReservationProfile

プロパティ値

diagnosticsProfile

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

diagnosticsProfile?: DiagnosticsProfile

プロパティ値

etag

Etag は、VM の Create/Update/Get 応答で返されるプロパティです。これにより、顧客はヘッダーで提供して、オプティミスティック更新を保証できます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

etag?: string

プロパティ値

string

evictionPolicy

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

evictionPolicy?: string

プロパティ値

string

extendedLocation

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

extendedLocation?: ExtendedLocation

プロパティ値

extensionsTimeBudget

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

extensionsTimeBudget?: string

プロパティ値

string

hardwareProfile

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

hardwareProfile?: HardwareProfile

プロパティ値

host

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

host?: SubResource

プロパティ値

hostGroup

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

hostGroup?: SubResource

プロパティ値

identity

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

identity?: VirtualMachineIdentity

プロパティ値

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-version: 2015-06-15

licenseType?: string

プロパティ値

string

managedBy

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

managedBy?: string

プロパティ値

string

networkProfile

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

networkProfile?: NetworkProfile

プロパティ値

osProfile

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

osProfile?: OSProfile

プロパティ値

plan

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

plan?: Plan

プロパティ値

platformFaultDomain

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

platformFaultDomain?: number

プロパティ値

number

priority

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

priority?: string

プロパティ値

string

provisioningState

プロビジョニング状態。これは応答にのみ表示されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

provisioningState?: string

プロパティ値

string

proximityPlacementGroup

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

proximityPlacementGroup?: SubResource

プロパティ値

resources

仮想マシンの子拡張機能リソース。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

resources?: VirtualMachineExtension[]

プロパティ値

scheduledEventsPolicy

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

scheduledEventsPolicy?: ScheduledEventsPolicy

プロパティ値

scheduledEventsProfile

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

scheduledEventsProfile?: ScheduledEventsProfile

プロパティ値

securityProfile

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

securityProfile?: SecurityProfile

プロパティ値

storageProfile

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

storageProfile?: StorageProfile

プロパティ値

timeCreated

仮想マシン リソースが作成された時刻を指定します。 最小 api-version: 2021-11-01。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

timeCreated?: Date

プロパティ値

Date

userData

VM の UserData。Base-64 でエンコードする必要があります。 顧客はここでシークレットを渡すべきではありません。 最小 api-version: 2021-03-01。

userData?: string

プロパティ値

string

virtualMachineScaleSet

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

virtualMachineScaleSet?: SubResource

プロパティ値

vmId

すべての Azure IaaS VM SMBIOS にエンコードおよび格納され、プラットフォーム BIOS コマンドを使用して読み取ることができる 128 ビット識別子である VM の一意の ID を指定します。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

vmId?: string

プロパティ値

string

zones

仮想マシン ゾーン。

zones?: string[]

プロパティ値

string[]

継承されたプロパティの詳細

id

リソース ID 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id?: string

プロパティ値

string

Resource.idから継承

location

リソースの場所

location: string

プロパティ値

string

Resource.locationから継承

name

リソース名注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name?: string

プロパティ値

string

Resource.nameから継承

tags

リソース タグ

tags?: {[propertyName: string]: string}

プロパティ値

{[propertyName: string]: string}

Resource.tagsから継承

type

リソースの種類注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

type?: string

プロパティ値

string

Resource.typeから継承