Virtual Machine Scale Set VMs - Get

VM スケール セットから仮想マシンを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}?api-version=2021-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}?$expand={$expand}&api-version=2021-03-01

URI パラメーター

Name In Required Type Description
instanceId
path True
  • string

仮想マシンのインスタンス ID。

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

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

vmScaleSetName
path True
  • string

VM スケール セットの名前。

api-version
query True
  • string

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

$expand
query

操作に適用する expand 式。 'InstanceView' は、仮想マシンのインスタンス ビューを取得します。 'UserData' は、仮想マシンの UserData を取得します。

応答

Name Type Description
200 OK

OK

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

Get VM scale set VM with UserData

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualmachines/0?api-version=2021-03-01

Sample Response

{
  "name": "{vmss-vm-name}",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
  "type": "Microsoft.Compute/virtualMachines",
  "location": "westus",
  "tags": {
    "myTag1": "tagValue1"
  },
  "properties": {
    "latestModelApplied": true,
    "modelDefinitionApplied": "VirtualMachineScaleSet",
    "networkProfileConfiguration": {
      "networkInterfaceConfigurations": [
        {
          "name": "vmsstestnetconfig5415",
          "properties": {
            "primary": true,
            "enableAcceleratedNetworking": false,
            "dnsSettings": {
              "dnsServers": []
            },
            "enableIPForwarding": false,
            "ipConfigurations": [
              {
                "name": "vmsstestnetconfig9693",
                "properties": {
                  "subnet": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
                  },
                  "privateIPAddressVersion": "IPv4"
                }
              }
            ]
          }
        }
      ]
    },
    "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
    "hardwareProfile": {},
    "storageProfile": {
      "imageReference": {
        "publisher": "MicrosoftWindowsServer",
        "offer": "WindowsServer",
        "sku": "2012-R2-Datacenter",
        "version": "4.127.20180315",
        "exactVersion": "4.127.20180315"
      },
      "osDisk": {
        "osType": "Windows",
        "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
        "createOption": "FromImage",
        "caching": "None",
        "managedDisk": {
          "storageAccountType": "Standard_LRS",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc"
        },
        "diskSizeGB": 127
      },
      "dataDisks": [
        {
          "lun": 1,
          "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
          "createOption": "Empty",
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d"
          },
          "diskSizeGB": 128,
          "toBeDetached": false
        }
      ]
    },
    "osProfile": {
      "computerName": "test000000",
      "adminUsername": "Foo12",
      "windowsConfiguration": {
        "provisionVMAgent": true,
        "enableAutomaticUpdates": true
      },
      "secrets": [],
      "allowExtensionOperations": true,
      "requireGuestProvisionSignal": true
    },
    "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415"
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": true
      }
    },
    "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": "westus",
      "tags": {
        "displayName": "CustomScriptExtension-DSC"
      },
      "properties": {
        "autoUpgradeMinorVersion": true,
        "provisioningState": "Succeeded",
        "publisher": "Microsoft.Compute",
        "type": "CustomScriptExtension",
        "typeHandlerVersion": "1.9",
        "settings": {}
      }
    }
  ]
}

定義

AdditionalCapabilities

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

AdditionalUnattendContent

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

ApiEntityReference

API エンティティ参照。

BootDiagnostics

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

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

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

BootDiagnosticsInstanceView

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

CachingTypes

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

ComponentNames

コンポーネントの名前。 現時点では、許可されている値は、Microsoft Windows の設定のみです。

DataDisk

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

DeleteOptions

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

DiagnosticsProfile

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

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

DiffDiskOptions

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

DiffDiskPlacement

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

DiffDiskSettings

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

注: エフェメラル ディスクの設定は、マネージド ディスクにのみ指定できます。

DiskCreateOptionTypes

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

指定できる値は次のとおりです。

Attach \u2013 この値は、特殊化されたディスクを使用して仮想マシンを作成するときに使用されます。

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

DiskDeleteOptionTypes

VM の削除時に OS ディスクを削除するかデタッチするか指定します。

指定できる値

削除 この値を使用すると、VM が削除された時点で OS ディスクが削除されます。

デタッチ この値を使用すると、VM が削除された後も OS ディスクが保持されます。

既定値は デタッチに設定 されています。 エフェメラル OS ディスクの場合、既定値は [削除] に 設定されます。 ユーザーは、エフェメラル OS ディスクの削除オプションを変更できません。

DiskDetachOptionTypes

ディスクのデタッチ中、または仮想マシンからのデタッチの実行中に既に実行されているデタッチ動作を指定します。 サポートされる値: ForceDetach

detachOption: ForceDetach は マネージド データ ディスクにのみ適用されます。 仮想マシンからの予期しない障害が原因でデータ ディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後のオプションとして強制デタッチを使用して、VM から強制的にディスクをデタッチします。 このデタッチ動作を使用すると、すべての書き込みがフラッシュされていない可能性があります。

この機能はまだプレビュー モードであり、VirtualMachineScaleSet ではサポートされていません。 データ ディスクを強制的にデタッチするには、detachOption: 'ForceDetach' を設定して、データ ディスクを 'true' に更新します。

DiskEncryptionSetParameters

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

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

DiskEncryptionSettings

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

DiskInstanceView

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

HardwareProfile

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

ImageReference

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

InstanceViewStatus

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

InstanceViewTypes

操作に適用する expand 式。 'InstanceView' は、仮想マシンのインスタンス ビューを取得します。 'UserData' は、仮想マシンの UserData を取得します。

IPVersion

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

IPVersions

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

KeyVaultKeyReference

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

KeyVaultSecretReference

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

LinuxConfiguration

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

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

LinuxPatchAssessmentMode

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

指定できる値は次のとおりです。

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

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

LinuxPatchSettings

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

LinuxVMGuestPatchMode

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

指定できる値は次のとおりです。

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

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

MaintenanceOperationResultCodeTypes

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

MaintenanceRedeployStatus

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

ManagedDiskParameters

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

NetworkApiVersion

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

NetworkInterfaceReference

ネットワーク インターフェイス参照について説明します。

NetworkProfile

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

OperatingSystemTypes

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

OSDisk

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

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

OSProfile

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

PassNames

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

PatchSettings

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

Plan

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

ProtocolTypes

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

指定できる値は次のとおりです。
http

https

PublicIPAddressSku

パブリック IP SKU について説明します

PublicIPAddressSkuName

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

PublicIPAddressSkuTier

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

PublicIPAllocationMethod

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

SecurityProfile

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

SecurityTypes

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、TrustedLaunch として設定されます。

既定値: このプロパティが TrustedLaunch に設定されていない限り、UefiSettings は有効になりません。

SettingNames

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

Sku

仮想マシン スケール セットの SKU について説明します。 注: スケール セットが現在オンのハードウェアで新しい VM SKU がサポートされていない場合は、SKU 名を変更する前に、スケール セット内の VM の割り当てを割り当てない必要があります。

SshConfiguration

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

SshPublicKey

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

StatusLevelTypes

レベル コード。

StorageAccountTypes

管理ディスクのストレージアカウントの種類を指定します。 管理対象 OS ディスクストレージアカウントの種類は、スケールセットの作成時にのみ設定できます。 注: UltraSSD_LRS はデータディスクでのみ使用できます。 OS ディスクと共に使用することはできません。

StorageProfile

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

SubResource
UefiSettings

仮想マシンの作成時に使用されるセキュア ブートや vTPM のようなセキュリティ設定を指定します。

最小 api-version: 2020-12-01

VaultCertificate

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

VaultSecretGroup

すべての証明書が同じ証明書に含Key Vault。

VirtualHardDisk

ディスクの URI を記述します。

VirtualMachineAgentInstanceView

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

VirtualMachineExtension

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

VirtualMachineExtensionHandlerInstanceView

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

VirtualMachineExtensionInstanceView

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

VirtualMachineHealthStatus

VM の正常性状態。

VirtualMachineIpTag

パブリック IP アドレスに関連付けられている IP タグを格納します。

VirtualMachineNetworkInterfaceConfiguration

仮想マシンのネットワーク インターフェイスの構成について説明します。

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

仮想マシンのネットワーク構成の DNS 設定について説明します。

VirtualMachineNetworkInterfaceIPConfiguration

仮想マシンのネットワークプロファイルの IP 構成について説明します。

VirtualMachinePublicIPAddressConfiguration

仮想マシンの IP 構成の PublicIPAddress 構成について説明します

VirtualMachinePublicIPAddressDnsSettingsConfiguration

仮想マシンのネットワーク構成の DNS 設定について説明します。

VirtualMachineScaleSetIPConfiguration

仮想マシンスケールセットのネットワークプロファイルの IP 構成について説明します。

VirtualMachineScaleSetIpTag

パブリック IP アドレスに関連付けられている IP タグを格納します。

VirtualMachineScaleSetNetworkConfiguration

仮想マシン スケール セットのネットワーク プロファイルのネットワーク構成について説明します。

VirtualMachineScaleSetNetworkConfigurationDnsSettings

仮想マシンスケールセットのネットワーク構成の DNS 設定について説明します。

VirtualMachineScaleSetPublicIPAddressConfiguration

仮想マシン スケール セットの IP 構成の PublicIPAddress 構成について説明します

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

仮想マシン スケール セットのネットワーク構成の DNS 設定について説明します。

VirtualMachineScaleSetVM

仮想マシン スケール セットの仮想マシンについて説明します。

VirtualMachineScaleSetVMInstanceView

仮想マシン スケール セット VM のインスタンス ビュー。

VirtualMachineScaleSetVMNetworkProfileConfiguration

仮想マシンスケールセットの VM ネットワークプロファイルについて説明します。

VirtualMachineScaleSetVMProtectionPolicy

仮想マシンスケールセット VM の保護ポリシー。

VirtualMachineSizeTypes

仮想マシンのサイズを指定します。

Enum データ型は現在非推奨とされており、12月23日2023によって削除されます。

使用可能なサイズの一覧を取得するには、次の Api を使用することをお勧めします。

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

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

サイズ変更に使用可能なすべての仮想マシンのサイズを一覧表示します。 仮想マシンのサイズの詳細については、「 仮想マシンのサイズ」を参照してください。

使用可能な VM サイズは、リージョンと可用性セットによって異なります。

WindowsConfiguration

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

WindowsPatchAssessmentMode

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

指定できる値は次のとおりです。

Imagedefault -仮想マシンでの修正プログラムの評価のタイミングを制御します。

自動 byplatform -プラットフォームは、定期的な修正プログラムの評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。

WindowsVMGuestPatchMode

柔軟に OrchestrationMode を使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンに対する VM ゲスト修正のモードを指定します。

指定できる値は次のとおりです。

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

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

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

WinRMConfiguration

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

WinRMListener

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

AdditionalCapabilities

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

Name Type Description
ultraSSDEnabled
  • boolean

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

AdditionalUnattendContent

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

Name Type Description
componentName

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

content
  • string

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

passName

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

settingName

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

ApiEntityReference

API エンティティ参照。

Name Type Description
id
  • string

/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... の形式の ARM リソース ID。

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

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

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

ComponentNames

コンポーネントの名前。 現時点では、許可されている値は、Microsoft Windows の設定のみです。

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

DataDisk

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

Name Type Description
caching

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

指定できる値は次のとおりです。

なし

ReadOnly

ReadWrite

既定値: Standard ストレージの場合はなし。ストレージの ReadOnly プレミアムする

createOption

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

指定できる値は次のとおりです。

Attach \u2013 この値は、特殊化されたディスクを使用して仮想マシンを作成するときに使用されます。

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

deleteOption

VM の削除時にデータ ディスクを削除するかデタッチするか指定します。

指定できる値

削除 この値を使用すると、VM が削除された時点でデータ ディスクが削除されます。

デタッチ この値を使用すると、VM が削除された後もデータ ディスクが保持されます。

既定値はデタッチに設定 されています

detachOption

ディスクのデタッチ中、または仮想マシンからのデタッチの実行中に既に実行されているデタッチ動作を指定します。 サポートされる値: ForceDetach

detachOption: ForceDetach は マネージド データ ディスクにのみ適用されます。 仮想マシンからの予期しない障害が原因でデータ ディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後のオプションとして強制デタッチを使用して、VM から強制的にディスクをデタッチします。 このデタッチ動作を使用すると、すべての書き込みがフラッシュされていない可能性があります。

この機能はまだプレビュー モードであり、VirtualMachineScaleSet ではサポートされていません。 データ ディスクを強制的にデタッチするには、detachOption: 'ForceDetach' を設定して、データ ディスクを 'true' に更新します。

diskIOPSReadWrite
  • integer

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

diskMBpsReadWrite
  • integer

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

diskSizeGB
  • integer

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

この値は 1023 GB より大きくすることはできません

image

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

lun
  • integer

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

managedDisk

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

name
  • string

ディスク名。

toBeDetached
  • boolean

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

vhd

仮想ハード ディスク。

writeAcceleratorEnabled
  • boolean

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

DeleteOptions

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

Name Type Description
Delete
  • string
Detach
  • string

DiagnosticsProfile

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

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

Name Type Description
bootDiagnostics

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

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

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

DiffDiskOptions

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

Name Type Description
Local
  • string

DiffDiskPlacement

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

Name Type Description
CacheDisk
  • string
ResourceDisk
  • string

DiffDiskSettings

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

注: エフェメラル ディスクの設定は、マネージド ディスクにのみ指定できます。

Name Type Description
option

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

placement

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

指定できる値は次のとおりです。

CacheDisk

ResourceDisk

既定値: VM サイズに対して CacheDisk が構成されている場合は 、それ以外の場合は ResourceDisk が使用されます。

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

DiskCreateOptionTypes

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

指定できる値は次のとおりです。

Attach \u2013 この値は、特殊化されたディスクを使用して仮想マシンを作成するときに使用されます。

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

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

DiskDeleteOptionTypes

VM の削除時に OS ディスクを削除するかデタッチするか指定します。

指定できる値

削除 この値を使用すると、VM が削除された時点で OS ディスクが削除されます。

デタッチ この値を使用すると、VM が削除された後も OS ディスクが保持されます。

既定値は デタッチに設定 されています。 エフェメラル OS ディスクの場合、既定値は [削除] に 設定されます。 ユーザーは、エフェメラル OS ディスクの削除オプションを変更できません。

Name Type Description
Delete
  • string
Detach
  • string

DiskDetachOptionTypes

ディスクのデタッチ中、または仮想マシンからのデタッチの実行中に既に実行されているデタッチ動作を指定します。 サポートされる値: ForceDetach

detachOption: ForceDetach は マネージド データ ディスクにのみ適用されます。 仮想マシンからの予期しない障害が原因でデータ ディスクの以前のデタッチ試行が完了せず、ディスクがまだ解放されていない場合は、最後のオプションとして強制デタッチを使用して、VM から強制的にディスクをデタッチします。 このデタッチ動作を使用すると、すべての書き込みがフラッシュされていない可能性があります。

この機能はまだプレビュー モードであり、VirtualMachineScaleSet ではサポートされていません。 データ ディスクを強制的にデタッチするには、detachOption: 'ForceDetach' を設定して、データ ディスクを 'true' に更新します。

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

仮想マシンのサイズを指定します。

Enum データ型は現在非推奨とされており、12月23日2023によって削除されます。

使用可能なサイズの一覧を取得するには、次の Api を使用することをお勧めします。

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

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

サイズ変更に使用可能なすべての仮想マシンのサイズを一覧表示します。 仮想マシンのサイズの詳細については、「 仮想マシンのサイズ」を参照してください。

使用可能な VM サイズは、リージョンと可用性セットによって異なります。

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 イメージが自動的に更新されることはありません。

InstanceViewStatus

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

Name Type Description
code
  • string

ステータス コード。

displayStatus
  • string

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

level

レベルコード。

message
  • string

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

time
  • string

状態の時刻。

InstanceViewTypes

操作に適用する expand 式。 'InstanceView' は、仮想マシンのインスタンス ビューを取得します。 'UserData' は、仮想マシンの UserData を取得します。

Name Type Description
instanceView
  • string
userData
  • string

IPVersion

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

Name Type Description
IPv4
  • string
IPv6
  • string

IPVersions

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

Name Type Description
IPv4
  • string
IPv6
  • 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。

LinuxConfiguration

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

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

Name Type Description
disablePasswordAuthentication
  • boolean

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

patchSettings

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

provisionVMAgent
  • boolean

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

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

ssh

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

LinuxPatchAssessmentMode

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

指定できる値は次のとおりです。

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

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

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

LinuxPatchSettings

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

Name Type Description
assessmentMode

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

指定できる値は次のとおりです。

Imagedefault -仮想マシンでの修正プログラムの評価のタイミングを制御します。

自動 byplatform -プラットフォームは、定期的な修正プログラムの評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。

patchMode

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

指定できる値は次のとおりです。

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

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

LinuxVMGuestPatchMode

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

指定できる値は次のとおりです。

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

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

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

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

マネージド ディスクのストレージ アカウントの種類を指定します。 マネージド OS ディスク ストレージ アカウントの種類は、スケール セットを作成するときにのみ設定できます。 注: UltraSSD_LRSディスクでのみ使用できる場合、OS ディスクでは使用できません。

NetworkApiVersion

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

Name Type Description
2020-11-01
  • string

NetworkInterfaceReference

ネットワーク インターフェイス参照について説明します。

Name Type Description
id
  • string

リソース ID

properties.deleteOption

VM が削除された場合のネットワーク インターフェイスの実行を指定する

properties.primary
  • boolean

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

NetworkProfile

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

Name Type Description
networkApiVersion

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

networkInterfaceConfigurations

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

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 です。 プレミアムストレージの場合は ReadOnly です。

createOption

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

指定できる値は次のとおりです。

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

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

deleteOption

VM の削除時に OS ディスクを削除するか、デタッチするかを指定します。

指定できる値

削除 この値を使用すると、VM が削除されるときに OS ディスクが削除されます。

デタッチ この値を使用した場合、os ディスクは VM が削除された後も保持されます。

既定値は デタッチに設定 されています。 エフェメラル OS ディスクの場合、既定値は [削除] に 設定されます。 ユーザーは、エフェメラル OS ディスクの削除オプションを変更できません。

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 文字。

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

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

windowsConfiguration

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

PassNames

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

Name Type Description
OobeSystem
  • string

PatchSettings

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

Name Type Description
assessmentMode

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

指定できる値は次のとおりです。

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

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

enableHotpatching
  • boolean

再起動を必要とせずに Azure VM に修正プログラムを適用できます。 enableHotpatching では、'provisionVMAgent' を true に設定し、'patchMode' を 'AutomaticByPlatform' に設定する必要があります。

patchMode

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

指定できる値は次のとおりです。

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

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

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

Plan

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

Name Type Description
name
  • string

プラン ID。

product
  • string

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

promotionCode
  • string

販売促進コード。

publisher
  • string

発行元 ID。

ProtocolTypes

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

指定できる値は次のとおりです。
http

https

Name Type Description
Http
  • string
Https
  • string

PublicIPAddressSku

パブリック IP SKU について説明します

Name Type Description
name

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

tier

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

PublicIPAddressSkuName

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

Name Type Description
Basic
  • string
Standard
  • string

PublicIPAddressSkuTier

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

Name Type Description
Global
  • string
Regional
  • string

PublicIPAllocationMethod

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

Name Type Description
Dynamic
  • string
Static
  • string

SecurityProfile

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

Name Type Description
encryptionAtHost
  • boolean

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

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

securityType

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするために TrustedLaunch として設定されています。

既定値: このプロパティが TrustedLaunch として設定されている場合を除き、UefiSettings は有効になりません。

uefiSettings

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

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

SecurityTypes

仮想マシンの SecurityType を指定します。 UefiSettings を有効にするには、TrustedLaunch として設定されます。

既定値: このプロパティが TrustedLaunch に設定されていない限り、UefiSettings は有効になりません。

Name Type Description
TrustedLaunch
  • string

SettingNames

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

Name Type Description
AutoLogon
  • string
FirstLogonCommands
  • string

Sku

仮想マシン スケール セットの SKU について説明します。 注: スケール セットが現在オンのハードウェアで新しい VM SKU がサポートされていない場合は、SKU 名を変更する前に、スケール セット内の VM の割り当てを割り当てない必要があります。

Name Type Description
capacity
  • integer

スケール セット内の仮想マシンの数を指定します。

name
  • string

SKU 名。

tier
  • string

スケール セット内の仮想マシンのレベルを指定します。

有効値は次のとおりです。

Standard

Basic

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 キーを作成する」を参照してください https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed) 。

path
  • string

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

StatusLevelTypes

レベル コード。

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

StorageAccountTypes

管理ディスクのストレージアカウントの種類を指定します。 管理対象 OS ディスクストレージアカウントの種類は、スケールセットの作成時にのみ設定できます。 注: UltraSSD_LRS はデータディスクでのみ使用できます。 OS ディスクと共に使用することはできません。

Name Type Description
Premium_LRS
  • string
Premium_ZRS
  • string
StandardSSD_LRS
  • string
StandardSSD_ZRS
  • 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

UefiSettings

仮想マシンの作成時に使用されるセキュア ブートや vTPM のようなセキュリティ設定を指定します。

最小 api-version: 2020-12-01

Name Type Description
secureBootEnabled
  • boolean

仮想マシンでセキュア ブートを有効にするかどうかを指定します。

最小 api-version: 2020-12-01

vTpmEnabled
  • boolean

仮想マシンで vTPM を有効にするかどうかを指定します。

最小 api-version: 2020-12-01

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 ファイルの <>"
}
仮想マシンに証明書をインストールするには、 Linux 用の Azure Key Vault 仮想マシン拡張機能、またはWindows 用の Azure Key Vault 仮想マシン拡張機能を使用することをお勧めします。

VaultSecretGroup

すべての証明書が同じ証明書に含Key Vault。

Name Type Description
sourceVault

コンテナーの相対 URL Key Vault VaultCertificates 内のすべての証明書を含む必要があります。

vaultCertificates

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

VirtualHardDisk

ディスクの URI を記述します。

Name Type Description
uri
  • string

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

VirtualMachineAgentInstanceView

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

Name Type Description
extensionHandlers

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

statuses

リソースの状態情報。

vmAgentVersion
  • string

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

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 の正常性状態の情報。

VirtualMachineIpTag

パブリック IP アドレスに関連付けられている IP タグを格納します。

Name Type Description
ipTagType
  • string

IP タグの種類。 例: FirstPartyUsage。

tag
  • string

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

VirtualMachineNetworkInterfaceConfiguration

仮想マシンのネットワーク インターフェイスの構成について説明します。

Name Type Description
name
  • string

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

properties.deleteOption

VM が削除された場合のネットワーク インターフェイスの実行を指定する

properties.dnsSettings

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

properties.dscpConfiguration
properties.enableAcceleratedNetworking
  • boolean

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

properties.enableFpga
  • boolean

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

properties.enableIPForwarding
  • boolean

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

properties.ipConfigurations

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

properties.networkSecurityGroup

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

properties.primary
  • boolean

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

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

仮想マシンのネットワーク構成の DNS 設定について説明します。

Name Type Description
dnsServers
  • string[]

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

VirtualMachineNetworkInterfaceIPConfiguration

仮想マシンのネットワークプロファイルの IP 構成について説明します。

Name Type Description
name
  • string

IP 構成の名前。

properties.applicationGatewayBackendAddressPools

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

properties.applicationSecurityGroups

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

properties.loadBalancerBackendAddressPools

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

properties.primary
  • boolean

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

properties.privateIPAddressVersion

Api-Version 2017-03-30 以降で使用できます。これは、特定の ip 構成が IPv4 と IPv6 のどちらであるかを表します。 既定値は IPv4 として取得されます。 指定できる値は ' IPv4 ' と ' IPv6 ' です。

properties.publicIPAddressConfiguration

PublicIPAddressConfiguration。

properties.subnet

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

VirtualMachinePublicIPAddressConfiguration

仮想マシンの IP 構成の PublicIPAddress 構成について説明します

Name Type Description
name
  • string

publicIP アドレス構成名。

properties.deleteOption

VM が削除された場合のパブリック IP アドレスの変更を指定する

properties.dnsSettings

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

properties.idleTimeoutInMinutes
  • integer

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

properties.ipTags

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

properties.publicIPAddressVersion

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

properties.publicIPAllocationMethod

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

properties.publicIPPrefix

publicIP アドレスの割り当てに使用する PublicIPPrefix。

sku

パブリック IP SKU について説明します

VirtualMachinePublicIPAddressDnsSettingsConfiguration

仮想マシンのネットワーク構成の DNS 設定について説明します。

Name Type Description
domainNameLabel
  • string

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

VirtualMachineScaleSetIPConfiguration

仮想マシンスケールセットのネットワークプロファイルの IP 構成について説明します。

Name Type Description
id
  • string

リソース Id

name
  • string

IP 構成の名前。

properties.applicationGatewayBackendAddressPools

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

properties.applicationSecurityGroups

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

properties.loadBalancerBackendAddressPools

ロードバランサーのバックエンドアドレスプールへの参照の配列を指定します。 スケールセットでは、1つのパブリックおよび1つの内部ロードバランサーのバックエンドアドレスプールを参照できます。 複数のスケールセットで同じ basic sku ロードバランサーを使用することはできません。

properties.loadBalancerInboundNatPools

ロードバランサーの受信 Nat プールへの参照の配列を指定します。 スケールセットでは、1つのパブリックおよび1つの内部ロードバランサーの受信 nat プールを参照できます。 複数のスケールセットで同じ basic sku ロードバランサーを使用することはできません。

properties.primary
  • boolean

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

properties.privateIPAddressVersion

Api-Version 2017-03-30 以降で使用できます。これは、特定の ip 構成が IPv4 と IPv6 のどちらであるかを表します。 既定値は IPv4 として取得されます。 指定できる値は ' IPv4 ' と ' IPv6 ' です。

properties.publicIPAddressConfiguration

PublicIPAddressConfiguration。

properties.subnet

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

VirtualMachineScaleSetIpTag

パブリック IP アドレスに関連付けられている IP タグを格納します。

Name Type Description
ipTagType
  • string

IP タグの種類。 例: FirstPartyUsage。

tag
  • string

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

VirtualMachineScaleSetNetworkConfiguration

仮想マシン スケール セットのネットワーク プロファイルのネットワーク構成について説明します。

Name Type Description
id
  • string

リソース ID

name
  • string

ネットワーク構成名。

properties.deleteOption

VM が削除された場合のネットワーク インターフェイスの実行を指定する

properties.dnsSettings

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

properties.enableAcceleratedNetworking
  • boolean

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

properties.enableFpga
  • boolean

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

properties.enableIPForwarding
  • boolean

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

properties.ipConfigurations

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

properties.networkSecurityGroup

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

properties.primary
  • boolean

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

VirtualMachineScaleSetNetworkConfigurationDnsSettings

仮想マシンスケールセットのネットワーク構成の DNS 設定について説明します。

Name Type Description
dnsServers
  • string[]

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

VirtualMachineScaleSetPublicIPAddressConfiguration

仮想マシン スケール セットの IP 構成の PublicIPAddress 構成について説明します

Name Type Description
name
  • string

publicIP アドレス構成名。

properties.deleteOption

VM が削除された場合のパブリック IP の実行を指定する

properties.dnsSettings

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

properties.idleTimeoutInMinutes
  • integer

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

properties.ipTags

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

properties.publicIPAddressVersion

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

properties.publicIPPrefix

publicIP アドレスの割り当てに使用する PublicIPPrefix。

sku

パブリック IP SKU について説明します

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

仮想マシン スケール セットのネットワーク構成の DNS 設定について説明します。

Name Type Description
domainNameLabel
  • string

ドメイン名ラベル。ドメイン名ラベルと vm インデックスを連結すると、作成される PublicIPAddress リソースのドメイン名ラベルになります

VirtualMachineScaleSetVM

仮想マシン スケール セットの仮想マシンについて説明します。

Name Type Description
id
  • string

リソース ID

instanceId
  • string

仮想マシン インスタンス ID。

location
  • string

リソースの場所

name
  • string

リソース名

plan

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

properties.additionalCapabilities

スケール セット内の仮想マシンで有効または無効になっている追加の機能を指定します。 たとえば、仮想マシンに、ストレージ アカウントの種類を使用したマネージド データ ディスクのアタッチをサポートUltraSSD_LRSかどうかなどです。

properties.availabilitySet

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

Azure の計画メンテナンスの詳細については、「Azure でのサービスのメンテナンスと 更新Virtual Machines参照してください。

現時点では、VM は作成時にのみ可用性セットに追加できます。 既存の VM を可用性セットに追加することはできません。

properties.diagnosticsProfile

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

最小 api-version: 2015-06-15。

properties.hardwareProfile

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

properties.instanceView

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

properties.latestModelApplied
  • boolean

最新のモデルが仮想マシンに適用されているかどうかを指定します。

properties.licenseType
  • string

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

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

Windows_Client

Windows_Server

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

RHEL_BYOS (RHEL の場合)

SLES_BYOS (SUSE の場合)

詳細については、「Azure Hybrid Use Benefit for Windows Server」を参照してください。

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

最小 api-version: 2015-06-15

properties.modelDefinitionApplied
  • string

仮想マシンに適用されるモデルが仮想マシン スケール セットのモデルか、仮想マシンのカスタマイズされたモデルかを指定します。

properties.networkProfile

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

properties.networkProfileConfiguration

仮想マシンのネットワーク プロファイル構成を指定します。

properties.osProfile

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

properties.protectionPolicy

仮想マシンの保護ポリシーを指定します。

properties.provisioningState
  • string

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

properties.securityProfile

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

properties.storageProfile

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

properties.userData
  • string

VM の UserData。base-64 でエンコードする必要があります。 お客様は、ここにシークレットを渡さ " を行う必要があります。

最小 api-version: 2021-03-01

properties.vmId
  • string

Azure VM の一意の ID。

resources

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

sku

仮想マシン SKU。

tags
  • object

リソース タグ

type
  • string

リソースの種類

zones
  • string[]

仮想マシン ゾーン。

VirtualMachineScaleSetVMInstanceView

仮想マシン スケール セット VM のインスタンス ビュー。

Name Type Description
assignedHost
  • string

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

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

bootDiagnostics

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

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

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

disks

ディスク情報。

extensions

拡張機能の情報です。

maintenanceRedeployStatus

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

placementGroupId
  • string

VM が実行されている配置グループ。 VM の割り当てが解除されている場合、その VM には、"の" のようになります。

platformFaultDomain
  • integer

障害ドメインの数。

platformUpdateDomain
  • integer

更新ドメインの数。

rdpThumbPrint
  • string

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

statuses

リソースの状態情報。

vmAgent

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

vmHealth

VM の正常性状態。

VirtualMachineScaleSetVMNetworkProfileConfiguration

仮想マシンスケールセットの VM ネットワークプロファイルについて説明します。

Name Type Description
networkInterfaceConfigurations

ネットワーク構成の一覧。

VirtualMachineScaleSetVMProtectionPolicy

仮想マシンスケールセット VM の保護ポリシー。

Name Type Description
protectFromScaleIn
  • boolean

スケールイン操作中に、仮想マシンスケールセットの VM を削除対象として考慮しないことを示します。

protectFromScaleSetActions
  • boolean

仮想マシンスケールセットで開始されたモデルの更新またはアクション (スケールインを含む) を仮想マシンスケールセットの VM に適用しないことを示します。

VirtualMachineSizeTypes

仮想マシンのサイズを指定します。

Enum データ型は現在非推奨とされており、12月23日2023によって削除されます。

使用可能なサイズの一覧を取得するには、次の Api を使用することをお勧めします。

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

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

サイズ変更に使用可能なすべての仮想マシンのサイズを一覧表示します。 仮想マシンのサイズの詳細については、「 仮想マシンのサイズ」を参照してください。

使用可能な VM サイズは、リージョンと可用性セットによって異なります。

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

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

provisionVMAgent
  • boolean

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

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

timeZone
  • string

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

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

winRM

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

WindowsPatchAssessmentMode

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

指定できる値は次のとおりです。

Imagedefault -仮想マシンでの修正プログラムの評価のタイミングを制御します。

自動 byplatform -プラットフォームは、定期的な修正プログラムの評価をトリガーします。 プロパティ provisionVMAgent は true である必要があります。

Name Type Description
AutomaticByPlatform
  • string
ImageDefault
  • string

WindowsVMGuestPatchMode

柔軟に OrchestrationMode を使用して、仮想マシンスケールセットに関連付けられている IaaS 仮想マシンまたは仮想マシンに対する VM ゲスト修正のモードを指定します。

指定できる値は次のとおりです。

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

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

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

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

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":"",
"dataType":"pfx",
"password":""
}
仮想マシンに証明書をインストールするには、Linux用の Azure Key Vault 仮想マシン拡張機能または Azure Key Vault 仮想マシン拡張機能を Windows 用に使用Windows。

protocol

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

指定できる値は次のとおりです。
http

ssl