Virtual Machines - List All

指定されたサブスクリプション内のすべての仮想マシンを一覧表示します。 応答の nextLink プロパティを使用して、仮想マシンの次のページを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines?api-version=2020-06-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines?api-version=2020-06-01&statusOnly={statusOnly}

URI パラメーター

Name In Required Type Description
subscriptionId
path True
  • string

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

api-version
query True
  • string

クライアント Api バージョン。

statusOnly
query
  • string

statusOnly = true を使用すると、サブスクリプション内のすべての Virtual Machines の実行時の状態を取得できます。

応答

Name Type Description
200 OK

OK

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザーアカウントの権限を借用する

定義

AdditionalCapabilities

仮想マシンまたは仮想マシンスケールセットの機能を有効または無効にします。

AdditionalUnattendContent

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

ApiError

Api エラー。

ApiErrorBase

Api エラーベース。

AvailablePatchSummary

利用可能な修正プログラムの概要について、仮想マシンインスタンスビューのプロパティについて説明します。

BillingProfile

Azure スポット VM または VMSS の課金に関連する詳細を指定します。

最小 api バージョン: 2019-03-01。

BootDiagnostics

ブート診断は、コンソールの出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。

コンソールログの出力を簡単に表示できます。

Azure では、ハイパーバイザーから VM のスクリーンショットを確認することもできます。

BootDiagnosticsInstanceView

仮想マシンのブート診断のインスタンスビュー。

CachingTypes

キャッシュの要件を指定します。

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

なし

ReadOnly

ReadWrite

既定値は、Standard storage の場合は None です。 Premium storage の場合は ReadOnly です。

ComponentNames

コンポーネントの名前。 現時点では、許可されている値は、"Microsoft-Windows-Shell-Setup" だけです。

DataDisk

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

DiagnosticsProfile

ブート診断設定の状態を指定します。

最小 api バージョン: 2015-06-15。

DiffDiskOptions

オペレーティングシステムディスクの一時ディスク設定を指定します。

DiffDiskPlacement

オペレーティングシステムディスクの一時ディスクの配置を指定します。 このプロパティは、一時的な OS ディスクプロビジョニング用のキャッシュディスクまたはリソースディスク領域を選択するために、ユーザーが要求で使用できます。 一時 OS のディスクサイズの要件の詳細については、「」の Windows VM https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements と LINUX vm の一時 os ディスクサイズの要件を参照してください。 https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

DiffDiskSettings

オペレーティングシステムディスクに指定できる一時ディスク設定のパラメーターについて説明します。

注: 一時ディスクの設定は、管理ディスクに対してのみ指定できます。

DiskCreateOptionTypes

仮想マシンの作成方法を指定します。

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

Attach \u2013 この値は、仮想マシンを作成するために特殊なディスクを使用する場合に使用します。

Fromimage \u2013 この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォームイメージを使用する場合は、上で説明した imageReference 要素も使用します。 Marketplace イメージを使用している場合は、前に説明した plan 要素も使用します。

DiskEncryptionSetParameters

ディスクに指定できるユーザー管理ディスク暗号化セットリソース id のパラメーターについて説明します。

注: ディスク暗号化セットのリソース id は、管理ディスクに対してのみ指定できます。 詳細については、「」を参照してください https://aka.ms/mdssewithcmkoverview

DiskEncryptionSettings

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

DiskInstanceView

ディスクのインスタンスビュー。

HardwareProfile

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

HyperVGenerationType

HyperVGeneration 型を指定します

ImageReference

使用するイメージに関する情報を指定します。 プラットフォームイメージ、marketplace イメージ、または仮想マシンイメージに関する情報を指定できます。 この要素は、プラットフォームイメージ、marketplace イメージ、または仮想マシンイメージを使用するが、他の作成操作では使用しない場合に必要です。 注: イメージ参照の発行元と提供プランは、スケールセットを作成するときにのみ設定できます。

InGuestPatchMode

IaaS 仮想マシンへのゲストパッチ適用のモードを指定します。

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

手動 -仮想マシンに対する修正プログラムの適用を制御します。 これを行うには、VM 内で手動で修正プログラムを適用します。 このモードでは、自動更新は無効になっています。WindowsConfiguration. Enable自動更新プロパティは false である必要があります

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

* * 自動 Byplatform * *-仮想マシンは、プラットフォームによって自動的に更新されます。 プロパティ provisionVMAgent と WindowsConfiguration. Enable自動更新は true でなければなりません

InnerError

内部エラーの詳細。

InstanceViewStatus

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

KeyVaultKeyReference

Key Vault キーへの参照を記述します。

KeyVaultSecretReference

Key Vault シークレットへの参照を記述します。

LastPatchInstallationSummary

最後にインストールされた修正プログラムの概要のプロパティについて説明します。

LinuxConfiguration

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

サポートされている Linux ディストリビューションの一覧については、「 linux on Azure-Endorsed ディストリビューション」を参照してください。

保証されていないディストリビューションの実行については、「 非保証のディストリビューションに関する情報」を参照してください。

MaintenanceOperationResultCodeTypes

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

MaintenanceRedeployStatus

メンテナンス操作の状態。

ManagedDiskParameters

管理ディスクのパラメーター。

NetworkInterfaceReference

ネットワークインターフェイスのリファレンスについて説明します。

NetworkProfile

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

OperatingSystemTypes

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

OSDisk

仮想マシンによって使用されるオペレーティングシステムディスクに関する情報を指定します。

ディスクの詳細については、「 Azure virtual machines のディスクと Vhd について」を参照してください。

OSProfile

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

PassNames

パス名。 現時点では、許可されている値は OobeSystem だけです。

PatchOperationStatus

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

PatchSettings
Plan

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

ProtocolTypes

WinRM リスナーのプロトコルを指定します。

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

ssl

RebootStatus

パッチ操作後のコンピューターの再起動ステータス。 修正プログラムの適用後に再起動が不要な場合は、"NotNeeded" 状態になります。 パッチが適用され、コンピューターが再起動する必要がある場合、"Required" は状態になります。 マシンの再起動が開始されると、"開始済み" は再起動の状態になります。 "Failed" は、マシンの再起動に失敗した場合の状態になります。 コンピューターが正常に再起動されると、"完了" という状態になります。

ResourceIdentityType

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

SecurityProfile

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

SettingNames

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

SshConfiguration

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

SshPublicKey

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

StatusLevelTypes

レベルコード。

StorageAccountTypes

管理ディスクのストレージアカウントの種類を指定します。 注: UltraSSD_LRS はデータディスクでのみ使用できます。 OS ディスクと共に使用することはできません。

StorageProfile

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

SubResource
UserAssignedIdentities

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

VaultCertificate

Key Vault 内の1つの証明書参照と、その証明書を VM 上に配置する必要がある場所について説明します。

VaultSecretGroup

すべて同じ Key Vault にある一連の証明書を記述します。

VirtualHardDisk

ディスクの uri について説明します。

VirtualMachine

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

VirtualMachineAgentInstanceView

仮想マシンで実行されている VM エージェントのインスタンスビュー。

VirtualMachineEvictionPolicyTypes

Azure スポット仮想マシンと Azure スポットスケールセットの削除ポリシーを指定します。

Azure スポット仮想マシンの場合、' 割り当て解除 ' と ' 削除 ' の両方がサポートされており、最小 api バージョンは2019-03-01 です。

Azure スポットスケールセットでは、' 割り当て解除 ' と ' 削除 ' の両方がサポートされており、最小 api バージョンは 2017-10-30-preview です。

VirtualMachineExtension

仮想マシンの拡張機能について説明します。

VirtualMachineExtensionHandlerInstanceView

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

VirtualMachineExtensionInstanceView

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

VirtualMachineHealthStatus

VM の正常性状態。

VirtualMachineIdentity

仮想マシンの id。

VirtualMachineInstanceView

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

VirtualMachineListResult

バーチャルマシン操作の応答の一覧です。

VirtualMachinePatchStatus

仮想マシンのパッチ操作の状態。

VirtualMachinePriorityTypes

仮想マシンの優先順位を指定します。

最小 api バージョン: 2019-03-01

VirtualMachineSizeTypes

仮想マシンのサイズを指定します。 仮想マシンのサイズの詳細については、「 仮想マシンのサイズ」を参照してください。

使用可能な VM サイズは、リージョンと可用性セットによって異なります。 使用可能なサイズの一覧を表示するには、次の Api を使用します。

可用性セット内の使用可能なすべての仮想マシンのサイズを一覧表示する

リージョン内の使用可能なすべての仮想マシンのサイズを一覧表示する

サイズ変更に使用可能なすべての仮想マシンのサイズを一覧表示します

WindowsConfiguration

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

WinRMConfiguration

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

WinRMListener

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

AdditionalCapabilities

仮想マシンまたは仮想マシンスケールセットの機能を有効または無効にします。

Name Type Description
ultraSSDEnabled
  • boolean

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

AdditionalUnattendContent

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

Name Type Description
componentName

コンポーネントの名前。 現時点では、許可されている値は、"Microsoft-Windows-Shell-Setup" だけです。

content
  • string

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

passName

パス名。 現時点では、許可されている値は OobeSystem だけです。

settingName

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

ApiError

Api エラー。

Name Type Description
code
  • string

エラー コード。

details

Api エラーの詳細

innererror

Api の内部エラー

message
  • string

エラー メッセージ。

target
  • string

特定のエラーの対象。

ApiErrorBase

Api エラーベース。

Name Type Description
code
  • string

エラー コード。

message
  • string

エラー メッセージ。

target
  • string

特定のエラーの対象。

AvailablePatchSummary

利用可能な修正プログラムの概要について、仮想マシンインスタンスビューのプロパティについて説明します。

Name Type Description
assessmentActivityId
  • string

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

criticalAndSecurityPatchCount
  • integer

まだインストールされていない、使用可能であると検出された、重要な更新プログラムまたはセキュリティ更新プログラムの数。

error

操作の実行中に発生したエラー。 詳細配列には、その一覧が含まれています。

lastModifiedTime
  • string

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

otherPatchCount
  • integer

Critical および security を除くすべての利用可能な更新プログラムの数。

rebootPending
  • boolean

VM の全体的な再起動の状態。 部分的にインストールされた修正プログラムのインストールを完了するには再起動が必要ですが、再起動がまだ行われていない場合は、true になります。

startTime
  • string

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

status

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

BillingProfile

Azure スポット VM または VMSS の課金に関連する詳細を指定します。

最小 api バージョン: 2019-03-01。

Name Type Description
maxPrice
  • number

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

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

また、現在の Azure スポット料金が VM/VMSS の作成後に maxPrice を超えた場合に、Azure スポット VM/VMSS を作成するためにも、maxPrice が使用されます。

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

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

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

MaxPrice を-1 に設定すると、Azure スポット VM/VMSS を削除しないことを示すことができます。 また、既定の最大価格は、提供されていない場合は-1 になります。

最小 api バージョン: 2019-03-01。

BootDiagnostics

ブート診断は、コンソールの出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。

コンソールログの出力を簡単に表示できます。

Azure では、ハイパーバイザーから VM のスクリーンショットを確認することもできます。

Name Type Description
enabled
  • boolean

仮想マシンでブート診断を有効にするかどうかを指定します。

storageUri
  • string

コンソール出力とスクリーンショットの配置に使用するストレージアカウントの Uri。

ブート診断を有効にしているときに storageUri が指定されていない場合は、管理対象ストレージが使用されます。

BootDiagnosticsInstanceView

仮想マシンのブート診断のインスタンスビュー。

Name Type Description
consoleScreenshotBlobUri
  • string

コンソールのスクリーンショット blob の URI。

注: 現在管理されている記憶域でブート診断が有効になっている場合、この設定は設定され ません

serialConsoleLogBlobUri
  • string

シリアルコンソールのログ blob の Uri。

注: 現在管理されている記憶域でブート診断が有効になっている場合、この設定は設定され ません

status

VM のブート診断の状態情報。

注: ブート診断を有効にするときにエラーが発生した場合にのみ設定されます。

CachingTypes

キャッシュの要件を指定します。

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

なし

ReadOnly

ReadWrite

既定値は、Standard storage の場合は None です。 Premium storage の場合は ReadOnly です。

Name Type Description
None
  • string
ReadOnly
  • string
ReadWrite
  • string

ComponentNames

コンポーネントの名前。 現時点では、許可されている値は、"Microsoft-Windows-Shell-Setup" だけです。

Name Type Description
Microsoft-Windows-Shell-Setup
  • string

DataDisk

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

Name Type Description
caching

キャッシュの要件を指定します。

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

なし

ReadOnly

ReadWrite

既定値は 、Standard storage の場合は None です。Premium storage 用に ReadOnly

createOption

仮想マシンの作成方法を指定します。

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

Attach \u2013 この値は、仮想マシンを作成するために特殊なディスクを使用する場合に使用します。

Fromimage \u2013 この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォームイメージを使用する場合は、上で説明した imageReference 要素も使用します。 Marketplace イメージを使用している場合は、前に説明した plan 要素も使用します。

diskIOPSReadWrite
  • integer

StorageAccountType が UltraSSD_LRS 場合に、管理ディスクの Read-Write IOPS を指定します。 VirtualMachine ScaleSet VM ディスクに対してのみ返されます。 VirtualMachine Scale Set の更新プログラムによってのみ更新できます。

diskMBpsReadWrite
  • integer

StorageAccountType が UltraSSD_LRS 場合に、管理ディスクの帯域幅 (MB/秒) を指定します。 VirtualMachine ScaleSet VM ディスクに対してのみ返されます。 VirtualMachine Scale Set の更新プログラムによってのみ更新できます。

diskSizeGB
  • integer

空のデータディスクのサイズを gb 単位で指定します。 この要素は、仮想マシンイメージ内のディスクのサイズを上書きするために使用できます。

この値は 1023 GB を超えることはできません

image

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

lun
  • integer

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

managedDisk

管理ディスクのパラメーター。

name
  • string

ディスク名。

toBeDetached
  • boolean

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

vhd

仮想ハードディスク。

writeAcceleratorEnabled
  • boolean

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

DiagnosticsProfile

ブート診断設定の状態を指定します。

最小 api バージョン: 2015-06-15。

Name Type Description
bootDiagnostics

ブート診断は、コンソールの出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。

コンソールログの出力を簡単に表示できます。

Azure では、ハイパーバイザーから VM のスクリーンショットを確認することもできます。

DiffDiskOptions

オペレーティングシステムディスクの一時ディスク設定を指定します。

Name Type Description
Local
  • string

DiffDiskPlacement

オペレーティングシステムディスクの一時ディスクの配置を指定します。 このプロパティは、一時的な OS ディスクプロビジョニング用のキャッシュディスクまたはリソースディスク領域を選択するために、ユーザーが要求で使用できます。 一時 OS のディスクサイズの要件の詳細については、「」の Windows VM https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements と LINUX vm の一時 os ディスクサイズの要件を参照してください。 https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

Name Type Description
CacheDisk
  • string
ResourceDisk
  • string

DiffDiskSettings

オペレーティングシステムディスクに指定できる一時ディスク設定のパラメーターについて説明します。

注: 一時ディスクの設定は、管理ディスクに対してのみ指定できます。

Name Type Description
option

オペレーティングシステムディスクの一時ディスク設定を指定します。

placement

オペレーティングシステムディスクの一時ディスクの配置を指定します。

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

CacheDisk

Resourcedisk.filesystem

既定値: Cachedisk が VM サイズ用に構成されている場合は、 resourcedisk が使用されます。

https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes キャッシュディスクを公開する vm サイズを確認するには、「」の Windows VM の vm サイズに関するドキュメントを参照してください。

DiskCreateOptionTypes

仮想マシンの作成方法を指定します。

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

Attach \u2013 この値は、仮想マシンを作成するために特殊なディスクを使用する場合に使用します。

Fromimage \u2013 この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォームイメージを使用する場合は、上で説明した imageReference 要素も使用します。 Marketplace イメージを使用している場合は、前に説明した plan 要素も使用します。

Name Type Description
Attach
  • string
Empty
  • string
FromImage
  • string

DiskEncryptionSetParameters

ディスクに指定できるユーザー管理ディスク暗号化セットリソース id のパラメーターについて説明します。

注: ディスク暗号化セットのリソース id は、管理ディスクに対してのみ指定できます。 詳細については、「」を参照してください https://aka.ms/mdssewithcmkoverview

Name Type Description
id
  • string

リソース Id

DiskEncryptionSettings

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

Name Type Description
diskEncryptionKey

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

enabled
  • boolean

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

keyEncryptionKey

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

DiskInstanceView

ディスクのインスタンスビュー。

Name Type Description
encryptionSettings

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

最小 api バージョン: 2015-06-15

name
  • string

ディスク名。

statuses

リソースの状態情報。

HardwareProfile

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

Name Type Description
vmSize

仮想マシンのサイズを指定します。 仮想マシンのサイズの詳細については、「 仮想マシンのサイズ」を参照してください。

使用可能な VM サイズは、リージョンと可用性セットによって異なります。 使用可能なサイズの一覧を表示するには、次の Api を使用します。

可用性セット内の使用可能なすべての仮想マシンのサイズを一覧表示する

リージョン内の使用可能なすべての仮想マシンのサイズを一覧表示する

サイズ変更に使用可能なすべての仮想マシンのサイズを一覧表示します

HyperVGenerationType

HyperVGeneration 型を指定します

Name Type Description
V1
  • string
V2
  • string

ImageReference

使用するイメージに関する情報を指定します。 プラットフォームイメージ、marketplace イメージ、または仮想マシンイメージに関する情報を指定できます。 この要素は、プラットフォームイメージ、marketplace イメージ、または仮想マシンイメージを使用するが、他の作成操作では使用しない場合に必要です。 注: イメージ参照の発行元と提供プランは、スケールセットを作成するときにのみ設定できます。

Name Type Description
exactVersion
  • string

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

id
  • string

リソース Id

offer
  • string

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

publisher
  • string

イメージの発行元。

sku
  • string

イメージ SKU。

version
  • string

仮想マシンの作成に使用されるプラットフォームイメージまたは marketplace イメージのバージョンを指定します。 使用できる形式は、Major. Minor. Build または ' latest ' です。 メジャー、マイナー、およびビルドは10進数です。 デプロイ時に使用可能な最新バージョンのイメージを使用するには、'latest' を指定します。 "Latest" を使用する場合でも、新しいバージョンが使用可能になった場合でも、デプロイ時に VM イメージが自動的に更新されることはありません。

InGuestPatchMode

IaaS 仮想マシンへのゲストパッチ適用のモードを指定します。

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

手動 -仮想マシンに対する修正プログラムの適用を制御します。 これを行うには、VM 内で手動で修正プログラムを適用します。 このモードでは、自動更新は無効になっています。WindowsConfiguration. Enable自動更新プロパティは false である必要があります

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

* * 自動 Byplatform * *-仮想マシンは、プラットフォームによって自動的に更新されます。 プロパティ provisionVMAgent と WindowsConfiguration. Enable自動更新は true でなければなりません

Name Type Description
AutomaticByOS
  • string
AutomaticByPlatform
  • string
Manual
  • string

InnerError

内部エラーの詳細。

Name Type Description
errordetail
  • string

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

exceptiontype
  • string

例外の種類。

InstanceViewStatus

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

Name Type Description
code
  • string

ステータス コード。

displayStatus
  • string

ステータスのローカライズ可能な短いラベル。

level

レベルコード。

message
  • string

アラートやエラーメッセージなどの詳細なステータスメッセージ。

time
  • string

状態の時刻。

KeyVaultKeyReference

Key Vault キーへの参照を記述します。

Name Type Description
keyUrl
  • string

Key Vault のキー暗号化キーを参照している URL。

sourceVault

キーを格納している Key Vault の相対 URL。

KeyVaultSecretReference

Key Vault シークレットへの参照を記述します。

Name Type Description
secretUrl
  • string

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

sourceVault

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

LastPatchInstallationSummary

最後にインストールされた修正プログラムの概要のプロパティについて説明します。

Name Type Description
error

操作の実行中に発生したエラー。 詳細配列には、その一覧が含まれています。

excludedPatchCount
  • integer

お客様が指定した除外リストによって明示的に除外された、使用可能なすべての修正プログラムの数。

failedPatchCount
  • integer

インストールに失敗した修正プログラムの数。

installationActivityId
  • string

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

installedPatchCount
  • integer

正常にインストールされた更新プログラムの数。

lastModifiedTime
  • string

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

maintenanceWindowExceeded
  • boolean

操作がすべての目的のアクションを完了する前に、実行時間が切れたかどうかを示します。

notSelectedPatchCount
  • integer

利用可能なすべての修正プログラムのうち、分類または包含一覧のエントリと一致しなかったためインストールされないものの数。

pendingPatchCount
  • integer

修正プログラムのインストール操作の間にインストールされることが予想される、すべての利用可能な修正プログラムの数。

rebootStatus

パッチ操作後のコンピューターの再起動ステータス。 修正プログラムの適用後に再起動が不要な場合は、"NotNeeded" 状態になります。 パッチが適用され、コンピューターが再起動する必要がある場合、"Required" は状態になります。 マシンの再起動が開始されると、"開始済み" は再起動の状態になります。 "Failed" は、マシンの再起動に失敗した場合の状態になります。 コンピューターが正常に再起動されると、"完了" という状態になります。

startTime
  • string

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

startedBy
  • string

操作を開始したユーザーまたはシステムアカウント

status

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

LinuxConfiguration

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

サポートされている Linux ディストリビューションの一覧については、「 linux on Azure-Endorsed ディストリビューション」を参照してください。

保証されていないディストリビューションの実行については、「 非保証のディストリビューションに関する情報」を参照してください。

Name Type Description
disablePasswordAuthentication
  • boolean

パスワード認証を無効にするかどうかを指定します。

provisionVMAgent
  • boolean

仮想マシン上に仮想マシン エージェントをプロビジョニングするかどうかを示します。

このプロパティが要求本文で指定されていない場合、既定の動作では true に設定されます。 これにより、後で拡張機能を VM に追加できるように、vm エージェントが vm にインストールされるようになります。

ssh

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

MaintenanceOperationResultCodeTypes

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

Name Type Description
MaintenanceAborted
  • string
MaintenanceCompleted
  • string
None
  • string
RetryLater
  • string

MaintenanceRedeployStatus

メンテナンス操作の状態。

Name Type Description
isCustomerInitiatedMaintenanceAllowed
  • boolean

顧客がメンテナンスの実行を許可されている場合は True。

lastOperationMessage
  • string

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

lastOperationResultCode

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

maintenanceWindowEndTime
  • string

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

maintenanceWindowStartTime
  • string

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

preMaintenanceWindowEndTime
  • string

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

preMaintenanceWindowStartTime
  • string

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

ManagedDiskParameters

管理ディスクのパラメーター。

Name Type Description
diskEncryptionSet

管理ディスクのユーザー管理ディスク暗号化セットリソース id を指定します。

id
  • string

リソース Id

storageAccountType

管理ディスクのストレージアカウントの種類を指定します。 注: UltraSSD_LRS はデータディスクでのみ使用できます。 OS ディスクと共に使用することはできません。

NetworkInterfaceReference

ネットワークインターフェイスのリファレンスについて説明します。

Name Type Description
id
  • string

リソース Id

properties.primary
  • boolean

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

NetworkProfile

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

Name Type Description
networkInterfaces

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

OperatingSystemTypes

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

Name Type Description
Linux
  • string
Windows
  • string

OSDisk

仮想マシンによって使用されるオペレーティングシステムディスクに関する情報を指定します。

ディスクの詳細については、「 Azure virtual machines のディスクと Vhd について」を参照してください。

Name Type Description
caching

キャッシュの要件を指定します。

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

なし

ReadOnly

ReadWrite

既定値は、Standard storage の場合は None です。 Premium storage の場合は ReadOnly です。

createOption

仮想マシンの作成方法を指定します。

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

Attach \u2013 この値は、仮想マシンを作成するために特殊なディスクを使用する場合に使用します。

Fromimage \u2013 この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォームイメージを使用する場合は、上で説明した imageReference 要素も使用します。 Marketplace イメージを使用している場合は、前に説明した plan 要素も使用します。

diffDiskSettings

仮想マシンによって使用されるオペレーティングシステムディスクの一時ディスク設定を指定します。

diskSizeGB
  • integer

空のデータディスクのサイズを gb 単位で指定します。 この要素は、仮想マシンイメージ内のディスクのサイズを上書きするために使用できます。

この値は 1023 GB を超えることはできません

encryptionSettings

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

最小 api バージョン: 2015-06-15

image

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

managedDisk

管理ディスクのパラメーター。

name
  • string

ディスク名。

osType

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

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

Windows

Linux

vhd

仮想ハードディスク。

writeAcceleratorEnabled
  • boolean

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

OSProfile

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

Name Type Description
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"、"test3"、"root"、"server"、"owner"、"support"、"support_388945a0"、"sys"、"test2"、""、"user4"、"user5"。

最小長 (Linux): 1 文字

最大長 (Linux): 64 文字

最大長 (Windows): 20 文字

  • Linux VM へのルートアクセスについては、「 Azure の linux 仮想マシンでの root 権限の使用」を参照してください。
  • このフィールドで使用しない、Linux 上の組み込みシステムユーザーの一覧については、「 Azure での linux のユーザー名の選択」を参照してください。

  • 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

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

    サポートされている Linux ディストリビューションの一覧については、「 linux on Azure-Endorsed ディストリビューション」を参照してください。

    保証されていないディストリビューションの実行については、「 非保証のディストリビューションに関する情報」を参照してください。

    requireGuestProvisionSignal
    • boolean

    バーチャルマシンのプロビジョニングの成功を推測するために、ゲストプロビジョニングシグナルが必要かどうかを指定します。 注: このプロパティはプライベートテスト専用であり、すべてのお客様がプロパティを false に設定することはできません。

    secrets

    仮想マシンにインストールする必要がある証明書のセットを指定します。

    windowsConfiguration

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

    PassNames

    パス名。 現時点では、許可されている値は OobeSystem だけです。

    Name Type Description
    OobeSystem
    • string

    PatchOperationStatus

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

    Name Type Description
    CompletedWithWarnings
    • string
    Failed
    • string
    InProgress
    • string
    Succeeded
    • string

    PatchSettings

    Name Type Description
    patchMode

    IaaS 仮想マシンへのゲストパッチ適用のモードを指定します。

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

    手動 -仮想マシンに対する修正プログラムの適用を制御します。 これを行うには、VM 内で手動で修正プログラムを適用します。 このモードでは、自動更新は無効になっています。WindowsConfiguration. Enable自動更新プロパティは false である必要があります

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

    * * 自動 Byplatform * *-仮想マシンは、プラットフォームによって自動的に更新されます。 プロパティ provisionVMAgent と WindowsConfiguration. Enable自動更新は true でなければなりません

    Plan

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

    Name Type Description
    name
    • string

    プラン ID。

    product
    • string

    Marketplace からのイメージの製品を指定します。 これは、imageReference 要素のオファーと同じ値です。

    promotionCode
    • string

    販売促進コード。

    publisher
    • string

    発行者 ID。

    ProtocolTypes

    WinRM リスナーのプロトコルを指定します。

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

    ssl

    Name Type Description
    Http
    • string
    Https
    • string

    RebootStatus

    パッチ操作後のコンピューターの再起動ステータス。 修正プログラムの適用後に再起動が不要な場合は、"NotNeeded" 状態になります。 パッチが適用され、コンピューターが再起動する必要がある場合、"Required" は状態になります。 マシンの再起動が開始されると、"開始済み" は再起動の状態になります。 "Failed" は、マシンの再起動に失敗した場合の状態になります。 コンピューターが正常に再起動されると、"完了" という状態になります。

    Name Type Description
    Completed
    • string
    Failed
    • string
    NotNeeded
    • string
    Required
    • string
    Started
    • string

    ResourceIdentityType

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

    Name Type Description
    None
    • string
    SystemAssigned
    • string
    SystemAssigned, UserAssigned
    • string
    UserAssigned
    • string

    SecurityProfile

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

    Name Type Description
    encryptionAtHost
    • boolean

    このプロパティは、仮想マシンまたは仮想マシンスケールセットのホストの暗号化を有効または無効にする要求でユーザーが使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。

    既定: リソースに対してこのプロパティが true に設定されていない限り、ホストでの暗号化は無効になります。

    SettingNames

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

    Name Type Description
    AutoLogon
    • string
    FirstLogonCommands
    • string

    SshConfiguration

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

    Name Type Description
    publicKeys

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

    SshPublicKey

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

    Name Type Description
    keyData
    • string

    Ssh を介して VM で認証するために使用される SSH 公開キー証明書。 キーは、2048ビットと ssh rsa 形式である必要があります。

    Ssh キーを作成する方法については、「 Azure での Linux vm 用の linux および Mac での ssh キーの作成」を参照してください。

    path
    • string

    Ssh 公開キーが格納される、作成された VM の完全なパスを指定します。 ファイルが既に存在する場合は、指定したキーがそのファイルに追加されます。 例:/home/user/.ssh/authorized_keys

    StatusLevelTypes

    レベルコード。

    Name Type Description
    Error
    • string
    Info
    • string
    Warning
    • string

    StorageAccountTypes

    管理ディスクのストレージアカウントの種類を指定します。 注: UltraSSD_LRS はデータディスクでのみ使用できます。 OS ディスクと共に使用することはできません。

    Name Type Description
    Premium_LRS
    • string
    StandardSSD_LRS
    • string
    Standard_LRS
    • string
    UltraSSD_LRS
    • string

    StorageProfile

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

    Name Type Description
    dataDisks

    仮想マシンにデータ ディスクを追加するために使用されるパラメーターを指定します。

    ディスクの詳細については、「 Azure virtual machines のディスクと Vhd について」を参照してください。

    imageReference

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

    osDisk

    仮想マシンによって使用されるオペレーティングシステムディスクに関する情報を指定します。

    ディスクの詳細については、「 Azure virtual machines のディスクと Vhd について」を参照してください。

    SubResource

    Name Type Description
    id
    • string

    リソース Id

    UserAssignedIdentities

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

    Name Type Description

    VaultCertificate

    Key Vault 内の1つの証明書参照と、その証明書を VM 上に配置する必要がある場所について説明します。

    Name Type Description
    certificateStore
    • string

    Windows Vm の場合は、証明書を追加する仮想マシン上の証明書ストアを指定します。 指定された証明書ストアは、暗黙的に LocalMachine アカウントに含まれています。

    Linux Vm の場合、証明書ファイルは/var/lib/waagent ディレクトリに配置され、 < > X509 証明書ファイルには UppercaseThumbprint、 < > 秘密キーには UppercaseThumbprint というファイル名が付けられます。 これらのファイルはどちらも、pem 形式です。

    certificateUrl
    • string

    これは、シークレットとして Key Vault にアップロードされた証明書の URL です。 Key Vault にシークレットを追加する方法については、「キー またはシークレットをキーコンテナーに追加する」を参照してください。 この場合、証明書は、UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。

    {
    "data": "Base64 でエンコードされた証明書の <>",
    "dataType": "pfx",
    "password": "pfx ファイルの <>"
    }

    VaultSecretGroup

    すべて同じ Key Vault にある一連の証明書を記述します。

    Name Type Description
    sourceVault

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

    vaultCertificates

    証明書を含む SourceVault 内の key vault 参照の一覧。

    VirtualHardDisk

    ディスクの uri について説明します。

    Name Type Description
    uri
    • string

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

    VirtualMachine

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

    Name Type Description
    id
    • string

    リソース Id

    identity

    仮想マシンの id (構成されている場合)。

    location
    • string

    リソースの場所

    name
    • string

    リソース名

    plan

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

    properties.additionalCapabilities

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

    properties.availabilitySet

    仮想マシンの割り当て先となる可用性セットに関する情報を指定します。 同じ可用性セットで指定された仮想マシンは、可用性を最大化するために別々のノードに割り当てられます。 可用性セットの詳細については、「 仮想マシンの可用性管理」を参照してください。

    Azure の計画済みメンテナンスの詳細については、「 azure での仮想マシンの計画的なメンテナンス」を参照してください。

    現時点では、VM は作成時に可用性セットにのみ追加できます。 VM が追加される可用性セットは、可用性セットリソースと同じリソースグループに属する必要があります。 既存の VM を可用性セットに追加することはできません。

    このプロパティは、null 以外のプロパティ virtualMachineScaleSet 参照と共に存在することはできません。

    properties.billingProfile

    Azure スポットの仮想マシンの課金に関連する詳細を指定します。

    最小 api バージョン: 2019-03-01。

    properties.diagnosticsProfile

    ブート診断設定の状態を指定します。

    最小 api バージョン: 2015-06-15。

    properties.evictionPolicy

    Azure スポット仮想マシンと Azure スポットスケールセットの削除ポリシーを指定します。

    Azure スポット仮想マシンの場合、' 割り当て解除 ' と ' 削除 ' の両方がサポートされており、最小 api バージョンは2019-03-01 です。

    Azure スポットスケールセットでは、' 割り当て解除 ' と ' 削除 ' の両方がサポートされており、最小 api バージョンは 2017-10-30-preview です。

    properties.extensionsTimeBudget
    • string

    すべての拡張機能を開始する時間の alloted を指定します。 期間は15分から120分の範囲で指定する必要があり、ISO 8601 形式で指定する必要があります。 既定値は90分 (PT1H30M) です。

    最小 api バージョン: 2020-06-01

    properties.hardwareProfile

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

    properties.host

    バーチャルマシンが存在する専用ホストに関する情報を指定します。

    最小 api バージョン: 2018-10-01。

    properties.hostGroup

    バーチャルマシンが存在する専用のホストグループに関する情報を指定します。

    最小 api バージョン: 2020-06-01。

    注: ユーザーは、ホストと hostGroup の両方のプロパティを指定することはできません。

    properties.instanceView

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

    properties.licenseType
    • string

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

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

    Windows_Client

    Windows_Server

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

    RHEL_BYOS (RHEL)

    SLES_BYOS (SUSE の場合)

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

    Linux サーバー向けの Azure ハイブリッド使用特典

    最小 api バージョン: 2015-06-15

    properties.networkProfile

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

    properties.osProfile

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

    properties.priority

    仮想マシンの優先順位を指定します。

    最小 api バージョン: 2019-03-01

    properties.provisioningState
    • string

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

    properties.proximityPlacementGroup

    仮想マシンの割り当て先となる近接配置グループに関する情報を指定します。

    最小 api バージョン: 2018-04-01。

    properties.securityProfile

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

    properties.storageProfile

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

    properties.virtualMachineScaleSet

    仮想マシンを割り当てる仮想マシンスケールセットに関する情報を指定します。 同じ仮想マシンスケールセットに指定された仮想マシンは、可用性を最大化するために、異なるノードに割り当てられます。 現時点では、VM は作成時に仮想マシンスケールセットにのみ追加できます。 既存の VM を仮想マシンスケールセットに追加することはできません。

    このプロパティは、null 以外のプロパティ availabilitySet 参照と共に存在することはできません。

    Api ‐の最小バージョン: 2019 ‐03‐01

    properties.vmId
    • string

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

    resources

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

    tags
    • object

    リソース タグ

    type
    • string

    リソースの種類

    zones
    • string[]

    仮想マシンゾーン。

    VirtualMachineAgentInstanceView

    仮想マシンで実行されている VM エージェントのインスタンスビュー。

    Name Type Description
    extensionHandlers

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

    statuses

    リソースの状態情報。

    vmAgentVersion
    • string

    VM エージェントの完全バージョン。

    VirtualMachineEvictionPolicyTypes

    Azure スポット仮想マシンと Azure スポットスケールセットの削除ポリシーを指定します。

    Azure スポット仮想マシンの場合、' 割り当て解除 ' と ' 削除 ' の両方がサポートされており、最小 api バージョンは2019-03-01 です。

    Azure スポットスケールセットでは、' 割り当て解除 ' と ' 削除 ' の両方がサポートされており、最小 api バージョンは 2017-10-30-preview です。

    Name Type Description
    Deallocate
    • string
    Delete
    • string

    VirtualMachineExtension

    仮想マシンの拡張機能について説明します。

    Name Type Description
    id
    • string

    リソース Id

    location
    • string

    リソースの場所

    name
    • string

    リソース名

    properties.autoUpgradeMinorVersion
    • boolean

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

    properties.enableAutomaticUpgrade
    • boolean

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

    properties.forceUpdateTag
    • string

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

    properties.instanceView

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

    properties.protectedSettings
    • object

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

    properties.provisioningState
    • string

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

    properties.publisher
    • string

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

    properties.settings
    • object

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

    properties.type
    • string

    拡張機能の種類を指定します。例として "CustomScriptExtension" があります。

    properties.typeHandlerVersion
    • string

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

    tags
    • object

    リソース タグ

    type
    • string

    リソースの種類

    VirtualMachineExtensionHandlerInstanceView

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

    Name Type Description
    status

    拡張機能ハンドラーの状態。

    type
    • string

    拡張機能の種類を指定します。例として "CustomScriptExtension" があります。

    typeHandlerVersion
    • string

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

    VirtualMachineExtensionInstanceView

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

    Name Type Description
    name
    • string

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

    statuses

    リソースの状態情報。

    substatuses

    リソースの状態情報。

    type
    • string

    拡張機能の種類を指定します。例として "CustomScriptExtension" があります。

    typeHandlerVersion
    • string

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

    VirtualMachineHealthStatus

    VM の正常性状態。

    Name Type Description
    status

    VM の正常性状態の情報。

    VirtualMachineIdentity

    仮想マシンの id。

    Name Type Description
    principalId
    • string

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

    tenantId
    • string

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

    type

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

    userAssignedIdentities

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

    VirtualMachineInstanceView

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

    Name Type Description
    assignedHost
    • string

    自動配置が有効になっている専用のホストグループにバーチャルマシンが関連付けられている場合に、バーチャルマシンが自動配置によって割り当てられる専用ホストのリソース id。

    最小 api バージョン: 2020-06-01。

    bootDiagnostics

    ブート診断は、コンソールの出力とスクリーンショットを表示して VM の状態を診断できるデバッグ機能です。

    コンソールログの出力を簡単に表示できます。

    Azure では、ハイパーバイザーから VM のスクリーンショットを確認することもできます。

    computerName
    • string

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

    disks

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

    extensions

    拡張機能の情報です。

    hyperVGeneration

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

    maintenanceRedeployStatus

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

    osName
    • string

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

    osVersion
    • string

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

    patchStatus

    仮想マシンのパッチ操作の状態。

    platformFaultDomain
    • integer

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

    platformUpdateDomain
    • integer

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

    rdpThumbPrint
    • string

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

    statuses

    リソースの状態情報。

    vmAgent

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

    vmHealth

    VM の正常性状態。

    VirtualMachineListResult

    バーチャルマシン操作の応答の一覧です。

    Name Type Description
    nextLink
    • string

    Vm の次のページをフェッチする URI。 この URI を使用して ListNext () を呼び出し、Virtual Machines の次のページをフェッチします。

    value

    仮想マシンの一覧。

    VirtualMachinePatchStatus

    仮想マシンのパッチ操作の状態。

    Name Type Description
    availablePatchSummary

    バーチャルマシンの最新の評価操作の利用可能な修正プログラムの概要です。

    lastPatchInstallationSummary

    仮想マシンに対する最新のインストール操作の概要です。

    VirtualMachinePriorityTypes

    仮想マシンの優先順位を指定します。

    最小 api バージョン: 2019-03-01

    Name Type Description
    Low
    • string
    Regular
    • string
    Spot
    • string

    VirtualMachineSizeTypes

    仮想マシンのサイズを指定します。 仮想マシンのサイズの詳細については、「 仮想マシンのサイズ」を参照してください。

    使用可能な VM サイズは、リージョンと可用性セットによって異なります。 使用可能なサイズの一覧を表示するには、次の Api を使用します。

    可用性セット内の使用可能なすべての仮想マシンのサイズを一覧表示する

    リージョン内の使用可能なすべての仮想マシンのサイズを一覧表示する

    サイズ変更に使用可能なすべての仮想マシンのサイズを一覧表示します

    Name Type Description
    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

    WindowsConfiguration

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

    Name Type Description
    additionalUnattendContent

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

    enableAutomaticUpdates
    • boolean

    Windows 仮想マシンに対して自動更新が有効になっているかどうかを示します。 既定値は、true です。

    仮想マシンスケールセットの場合、このプロパティは更新でき、更新は OS 再プロビジョニングで有効になります。

    patchSettings

    ゲスト内修正プログラム (Kb) に関連する設定を指定します。

    provisionVMAgent
    • boolean

    仮想マシン上に仮想マシン エージェントをプロビジョニングするかどうかを示します。

    このプロパティが要求本文で指定されていない場合、既定の動作では true に設定されます。 これにより、後で拡張機能を VM に追加できるように、vm エージェントが vm にインストールされるようになります。

    timeZone
    • string

    仮想マシンのタイムゾーンを指定します。 例: "太平洋標準時"。

    指定できる値は、 TimeZoneInfoによって返されるタイムゾーンの値をTimeZoneInfo.Idことができます。

    winRM

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

    WinRMConfiguration

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

    Name Type Description
    listeners

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

    WinRMListener

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

    Name Type Description
    certificateUrl
    • string

    これは、シークレットとして Key Vault にアップロードされた証明書の URL です。 Key Vault にシークレットを追加する方法については、「キー またはシークレットをキーコンテナーに追加する」を参照してください。 この場合、証明書は、UTF-8 でエンコードされた次の JSON オブジェクトの Base64 エンコードである必要があります。

    {
    "data": "Base64 でエンコードされた証明書の <>",
    "dataType": "pfx",
    "password": "pfx ファイルの <>"
    }

    protocol

    WinRM リスナーのプロトコルを指定します。

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

    ssl