Virtual Machine Scale Sets - List

リソース グループのすべての VM スケール セットの一覧を取得します。

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

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

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

subscriptionId
path True

string

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

api-version
query True

string

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

応答

名前 説明
200 OK

VirtualMachineScaleSetListResult

OK

Other Status Codes

CloudError

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

VirtualMachineScaleSet_List_MaximumSet_Gen
VirtualMachineScaleSet_List_MinimumSet_Gen

VirtualMachineScaleSet_List_MaximumSet_Gen

Sample Request

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

Sample Response

{
  "value": [
    {
      "name": "{virtualMachineScaleSetName}",
      "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}",
      "type": "Microsoft.Compute/virtualMachineScaleSets",
      "location": "eastus",
      "tags": {},
      "sku": {
        "name": "Standard_D2s_v3",
        "tier": "Standard",
        "capacity": 4
      },
      "properties": {
        "singlePlacementGroup": true,
        "upgradePolicy": {
          "mode": "Automatic",
          "automaticOSUpgradePolicy": {
            "enableAutomaticOSUpgrade": true,
            "disableAutomaticRollback": true,
            "useRollingUpgradePolicy": true,
            "osRollingUpgradeDeferral": true
          },
          "rollingUpgradePolicy": {
            "maxBatchInstancePercent": 49,
            "maxUnhealthyInstancePercent": 81,
            "maxUnhealthyUpgradedInstancePercent": 98,
            "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
            "enableCrossZoneUpgrade": true,
            "prioritizeUnhealthyInstances": true,
            "rollbackFailedInstancesOnPolicyBreach": true,
            "maxSurge": true
          }
        },
        "virtualMachineProfile": {
          "storageProfile": {
            "osDisk": {
              "createOption": "FromImage",
              "caching": "ReadWrite",
              "managedDisk": {
                "storageAccountType": "Premium_LRS",
                "diskEncryptionSet": {
                  "id": "aaaaaaaaaaaa"
                }
              },
              "diskSizeGB": 30,
              "name": "aaaaaaaaaaaaaaaaaaaaaaa",
              "writeAcceleratorEnabled": true,
              "diffDiskSettings": {
                "option": "Local",
                "placement": "CacheDisk"
              },
              "osType": "Windows",
              "image": {
                "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
              },
              "vhdContainers": [
                "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
              ]
            },
            "imageReference": {
              "publisher": "azuredatabricks",
              "offer": "databricks",
              "sku": "databricksworker",
              "version": "3.15.2",
              "exactVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
              "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaa",
              "id": "aaaaaaaaaa"
            },
            "dataDisks": []
          },
          "osProfile": {
            "computerNamePrefix": "{virtualMachineScaleSetName}",
            "adminUsername": "admin",
            "linuxConfiguration": {
              "disablePasswordAuthentication": true,
              "ssh": {
                "publicKeys": [
                  {
                    "path": "aaa",
                    "keyData": "aaaaaa"
                  }
                ]
              },
              "provisionVMAgent": true,
              "patchSettings": {
                "patchMode": "ImageDefault",
                "assessmentMode": "ImageDefault"
              }
            },
            "customData": "aaaaaaaaaaaaaaaaaa",
            "windowsConfiguration": {
              "provisionVMAgent": true,
              "enableAutomaticUpdates": true,
              "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
              "additionalUnattendContent": [
                {
                  "passName": "OobeSystem",
                  "componentName": "Microsoft-Windows-Shell-Setup",
                  "settingName": "AutoLogon",
                  "content": "aaaaaaaaaaaaaaaaaaaa"
                }
              ],
              "patchSettings": {
                "patchMode": "Manual",
                "enableHotpatching": true,
                "assessmentMode": "ImageDefault"
              },
              "winRM": {
                "listeners": [
                  {
                    "protocol": "Http",
                    "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
                  }
                ]
              }
            },
            "secrets": [
              {
                "sourceVault": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                },
                "vaultCertificates": [
                  {
                    "certificateUrl": "aaaaaaa",
                    "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
                  }
                ]
              }
            ]
          },
          "networkProfile": {
            "networkInterfaceConfigurations": [
              {
                "name": "myNic",
                "properties": {
                  "primary": true,
                  "ipConfigurations": [
                    {
                      "name": "myIPConfig",
                      "properties": {
                        "primary": true,
                        "subnet": {
                          "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                        },
                        "publicIPAddressConfiguration": {
                          "name": "aaaaaaaaaaaaaaaaaa",
                          "properties": {
                            "idleTimeoutInMinutes": 18,
                            "dnsSettings": {
                              "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
                            },
                            "ipTags": [
                              {
                                "ipTagType": "aaaaaaa",
                                "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
                              }
                            ],
                            "publicIPPrefix": {
                              "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                            },
                            "publicIPAddressVersion": "IPv4",
                            "deleteOption": "Delete"
                          },
                          "sku": {
                            "name": "Basic",
                            "tier": "Regional"
                          }
                        },
                        "privateIPAddressVersion": "IPv4",
                        "applicationGatewayBackendAddressPools": [
                          {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          }
                        ],
                        "applicationSecurityGroups": [
                          {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          }
                        ],
                        "loadBalancerBackendAddressPools": [
                          {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          }
                        ],
                        "loadBalancerInboundNatPools": [
                          {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          }
                        ]
                      }
                    }
                  ],
                  "networkSecurityGroup": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
                  },
                  "enableAcceleratedNetworking": true,
                  "enableFpga": true,
                  "dnsSettings": {
                    "dnsServers": [
                      "aaaaaaaaaaaa"
                    ]
                  },
                  "enableIPForwarding": true,
                  "deleteOption": "Delete"
                }
              }
            ],
            "healthProbe": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
            },
            "networkApiVersion": "2020-11-01"
          },
          "securityProfile": {
            "uefiSettings": {
              "secureBootEnabled": true,
              "vTpmEnabled": true
            },
            "encryptionAtHost": true,
            "securityType": "TrustedLaunch"
          },
          "diagnosticsProfile": {
            "bootDiagnostics": {
              "enabled": true,
              "storageUri": "aaaaaaaaaaaaaaaaaaa"
            }
          },
          "extensionProfile": {
            "extensions": [
              {
                "name": "aa",
                "type": "aaaaa",
                "properties": {
                  "forceUpdateTag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
                  "publisher": "aaaaaaaaaaaaa",
                  "type": "aaaaaaaa",
                  "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
                  "autoUpgradeMinorVersion": true,
                  "enableAutomaticUpgrade": true,
                  "settings": {},
                  "protectedSettings": {},
                  "provisioningState": "aaaaaaaaaaaaaa",
                  "provisionAfterExtensions": [
                    "aaaaaaaaaaaaaa"
                  ],
                  "suppressFailures": true
                },
                "id": "aaaaaaaaaaaaaaaaaaaaaa"
              }
            ],
            "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
          },
          "licenseType": "aaaa",
          "priority": "Regular",
          "evictionPolicy": "Deallocate",
          "billingProfile": {
            "maxPrice": 4
          },
          "scheduledEventsProfile": {
            "terminateNotificationProfile": {
              "notBeforeTimeout": "aa",
              "enable": true
            }
          },
          "userData": "aaaaaaaaaaaaaaaaaaaaaaaaa",
          "capacityReservation": {
            "capacityReservationGroup": {
              "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
            }
          },
          "applicationProfile": {
            "galleryApplications": [
              {
                "tags": "aaaaaaaaaaa",
                "order": 29,
                "packageReferenceId": "aaaaaaaaaa",
                "configurationReference": "aaaaa"
              }
            ]
          }
        },
        "provisioningState": "succeeded",
        "overprovision": true,
        "doNotRunExtensionsOnOverprovisionedVMs": true,
        "platformFaultDomainCount": 1,
        "automaticRepairsPolicy": {
          "enabled": true,
          "gracePeriod": "aaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "uniqueId": "aaaaaaaaaaaaaaaaaaaaaaa",
        "zoneBalance": true,
        "proximityPlacementGroup": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "hostGroup": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "additionalCapabilities": {
          "ultraSSDEnabled": true,
          "hibernationEnabled": true
        },
        "scaleInPolicy": {
          "rules": [
            "Default"
          ],
          "forceDeletion": true
        },
        "orchestrationMode": "Uniform",
        "spotRestorePolicy": {
          "enabled": true,
          "restoreTimeout": "aaaaaaaaaa"
        }
      },
      "plan": {
        "name": "aaaaaaaaaa",
        "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
        "product": "aaaaaaaaaaaaaaaaaaaa",
        "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
      },
      "identity": {
        "principalId": "aaaaaaaaaaaaaaa",
        "tenantId": "aaaaaaaaaaaaaaaa",
        "type": "SystemAssigned",
        "userAssignedIdentities": {
          "key3951": {
            "principalId": "aaaa",
            "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
          }
        }
      },
      "zones": [
        "aaaaaaa"
      ],
      "extendedLocation": {
        "name": "aaaaaaaaaaaaaaaaaaaaa",
        "type": "EdgeZone"
      }
    },
    {
      "name": "{virtualMachineScaleSetName}",
      "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}1",
      "type": "Microsoft.Compute/virtualMachineScaleSets",
      "location": "eastus",
      "tags": {},
      "sku": {
        "name": "Standard_D2s_v3",
        "tier": "Standard",
        "capacity": 4
      },
      "properties": {
        "singlePlacementGroup": true,
        "upgradePolicy": {
          "mode": "Automatic",
          "automaticOSUpgradePolicy": {
            "enableAutomaticOSUpgrade": true,
            "disableAutomaticRollback": true,
            "useRollingUpgradePolicy": true,
            "osRollingUpgradeDeferral": true
          },
          "rollingUpgradePolicy": {
            "maxBatchInstancePercent": 49,
            "maxUnhealthyInstancePercent": 81,
            "maxUnhealthyUpgradedInstancePercent": 98,
            "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
            "enableCrossZoneUpgrade": true,
            "prioritizeUnhealthyInstances": true,
            "maxSurge": true
          }
        },
        "virtualMachineProfile": {
          "storageProfile": {
            "osDisk": {
              "createOption": "FromImage",
              "caching": "ReadWrite",
              "managedDisk": {
                "storageAccountType": "Premium_LRS",
                "diskEncryptionSet": {
                  "id": "aaaaaaaaaaaa"
                }
              },
              "diskSizeGB": 30,
              "name": "a",
              "writeAcceleratorEnabled": true,
              "diffDiskSettings": {
                "option": "Local",
                "placement": "CacheDisk"
              },
              "osType": "Windows",
              "image": {
                "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
              },
              "vhdContainers": [
                "aaaaaaaaaaaaaaaa"
              ]
            },
            "imageReference": {
              "publisher": "azuredatabricks",
              "offer": "databricks",
              "sku": "databricksworker",
              "version": "3.15.2",
              "exactVersion": "aa",
              "sharedGalleryImageId": "aaaaaaa",
              "id": "aaa"
            },
            "dataDisks": []
          },
          "osProfile": {
            "computerNamePrefix": "{virtualMachineScaleSetName}",
            "adminUsername": "admin",
            "linuxConfiguration": {
              "disablePasswordAuthentication": true,
              "ssh": {
                "publicKeys": [
                  {
                    "path": "aaa",
                    "keyData": "aaaaaa"
                  }
                ]
              },
              "provisionVMAgent": true,
              "patchSettings": {
                "patchMode": "ImageDefault",
                "assessmentMode": "ImageDefault"
              }
            },
            "customData": "a",
            "windowsConfiguration": {
              "provisionVMAgent": true,
              "enableAutomaticUpdates": true,
              "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
              "additionalUnattendContent": [
                {
                  "passName": "OobeSystem",
                  "componentName": "Microsoft-Windows-Shell-Setup",
                  "settingName": "AutoLogon",
                  "content": "aaaaaaaaaaaaaaaaaaaa"
                }
              ],
              "patchSettings": {
                "patchMode": "Manual",
                "enableHotpatching": true,
                "assessmentMode": "ImageDefault"
              },
              "winRM": {
                "listeners": [
                  {
                    "protocol": "Http",
                    "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
                  }
                ]
              }
            },
            "secrets": [
              {
                "sourceVault": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                },
                "vaultCertificates": [
                  {
                    "certificateUrl": "aaaaaaa",
                    "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa"
                  }
                ]
              }
            ]
          },
          "networkProfile": {
            "networkInterfaceConfigurations": [
              {
                "name": "myNic1",
                "properties": {
                  "primary": true,
                  "ipConfigurations": [
                    {
                      "name": "myIPConfig",
                      "properties": {
                        "primary": true,
                        "subnet": {
                          "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet"
                        },
                        "publicIPAddressConfiguration": {
                          "name": "aaaaaaaaaaaaaaaaaa",
                          "properties": {
                            "idleTimeoutInMinutes": 18,
                            "dnsSettings": {
                              "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
                            },
                            "ipTags": [
                              {
                                "ipTagType": "aaaaaaa",
                                "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
                              }
                            ],
                            "publicIPPrefix": {
                              "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                            },
                            "publicIPAddressVersion": "IPv4",
                            "deleteOption": "Delete"
                          },
                          "sku": {
                            "name": "Basic",
                            "tier": "Regional"
                          }
                        },
                        "privateIPAddressVersion": "IPv4",
                        "applicationGatewayBackendAddressPools": [
                          {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          }
                        ],
                        "applicationSecurityGroups": [
                          {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          }
                        ],
                        "loadBalancerBackendAddressPools": [
                          {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          }
                        ],
                        "loadBalancerInboundNatPools": [
                          {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          }
                        ]
                      }
                    }
                  ],
                  "networkSecurityGroup": {
                    "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup"
                  },
                  "enableAcceleratedNetworking": true,
                  "enableFpga": true,
                  "dnsSettings": {
                    "dnsServers": [
                      "aaaaaaaaaaaa"
                    ]
                  },
                  "enableIPForwarding": true,
                  "deleteOption": "Delete"
                }
              }
            ],
            "healthProbe": {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57"
            },
            "networkApiVersion": "2020-11-01"
          },
          "securityProfile": {
            "uefiSettings": {
              "secureBootEnabled": true,
              "vTpmEnabled": true
            },
            "encryptionAtHost": true,
            "securityType": "TrustedLaunch"
          },
          "diagnosticsProfile": {
            "bootDiagnostics": {
              "enabled": true,
              "storageUri": "aaaaaaaaaaaaaaaaaaa"
            }
          },
          "extensionProfile": {
            "extensions": [
              {
                "name": "aa",
                "type": "aaaaa",
                "properties": {
                  "forceUpdateTag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
                  "publisher": "aaaaaaaaaaaaa",
                  "type": "aaaaaaaa",
                  "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
                  "autoUpgradeMinorVersion": true,
                  "enableAutomaticUpgrade": true,
                  "settings": {},
                  "protectedSettings": {},
                  "provisioningState": "aaaaaaaaaaaaaa",
                  "provisionAfterExtensions": [
                    "aaaaaaaaaaaaaa"
                  ],
                  "suppressFailures": true
                },
                "id": "aaaaaaaaaaaaaaaaaaaaaa"
              }
            ],
            "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
          },
          "licenseType": "aaaaaaaaaaaaaaaaaaaaaaa",
          "priority": "Regular",
          "evictionPolicy": "Deallocate",
          "billingProfile": {
            "maxPrice": 4
          },
          "scheduledEventsProfile": {
            "terminateNotificationProfile": {
              "notBeforeTimeout": "aa",
              "enable": true
            }
          },
          "userData": "aaaaaaaaaaaaaaaaaaaaaa",
          "capacityReservation": {
            "capacityReservationGroup": {
              "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
            }
          },
          "applicationProfile": {
            "galleryApplications": [
              {
                "tags": "aaaaaaaaaaa",
                "order": 29,
                "packageReferenceId": "aaaaaaaaaa",
                "configurationReference": "aaaaa"
              }
            ]
          }
        },
        "provisioningState": "succeeded",
        "overprovision": true,
        "doNotRunExtensionsOnOverprovisionedVMs": true,
        "platformFaultDomainCount": 1,
        "automaticRepairsPolicy": {
          "enabled": true,
          "gracePeriod": "aaaaaaaaaaaaaaaaaaaaaaaaa"
        },
        "uniqueId": "aaaaa",
        "zoneBalance": true,
        "proximityPlacementGroup": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "hostGroup": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "additionalCapabilities": {
          "ultraSSDEnabled": true,
          "hibernationEnabled": true
        },
        "scaleInPolicy": {
          "rules": [
            "Default"
          ],
          "forceDeletion": true
        },
        "orchestrationMode": "Uniform",
        "spotRestorePolicy": {
          "enabled": true,
          "restoreTimeout": "aaaaaaaaaa"
        }
      },
      "plan": {
        "name": "aaaaaaaaaa",
        "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
        "product": "aaaaaaaaaaaaaaaaaaaa",
        "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
      },
      "identity": {
        "principalId": "aaaaaaaaaaaaaaa",
        "tenantId": "aaaaaaaaaaaaaaaa",
        "type": "SystemAssigned",
        "userAssignedIdentities": {
          "key3951": {
            "principalId": "aaaa",
            "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
          }
        }
      },
      "zones": [
        "aaaaaaaa"
      ],
      "extendedLocation": {
        "name": "aaaaaaaaaaaaaaaaaaaaa",
        "type": "EdgeZone"
      }
    }
  ],
  "nextLink": "aaaaaaaaaaaaaaaaaaa"
}

VirtualMachineScaleSet_List_MinimumSet_Gen

Sample Request

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

Sample Response

{
  "value": [
    {
      "location": "eastus",
      "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}"
    },
    {
      "location": "eastus",
      "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}"
    }
  ]
}

定義

名前 説明
AdditionalCapabilities

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

AdditionalUnattendContent

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

ApiEntityReference

API エンティティ参照。

ApiError

API エラー。

ApiErrorBase

API エラーベース。

ApplicationProfile

VM/VMSS で使用できるようにする必要があるギャラリー アプリケーションの一覧が含まれます

AutomaticOSUpgradePolicy

OS の自動アップグレードを実行するために使用される構成パラメーター。

AutomaticRepairsPolicy

仮想マシン スケール セットの自動修復の構成パラメーターを指定します。

BillingProfile

Azure スポット VM または VMSS の課金関連の詳細を指定します。 最小 api-version: 2019-03-01。

BootDiagnostics

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

CachingTypes

キャッシュの要件を指定します。 使用できる値は、 None、ReadOnly、ReadWrite です。 既定値は、 標準ストレージの場合は [なし] です。Premium Storage の ReadOnly。

CapacityReservationProfile

容量予約プロファイルのパラメーター。

CloudError

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

ComponentNames

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

DeleteOptions

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

DiagnosticsProfile

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

DiffDiskOptions

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

DiffDiskPlacement

オペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 このプロパティは、要求のユーザーが、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスク、リソース ディスク、または nvme ディスク領域の場所を選択するために使用できます。 エフェメラル OS ディスク サイズの要件の詳細については、Windows VM のエフェメラル OS ディスク サイズ要件と Linux VM https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirementshttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirementsを参照してください。 NvmeDisk の最小 api-version: 2024-03-01。

DiffDiskSettings

オペレーティング システム ディスクに指定できるエフェメラル ディスク設定のパラメーターについて説明します。 メモ: エフェメラル ディスクの設定は、マネージド ディスクに対してのみ指定できます。

DiskControllerTypes
DiskCreateOptionTypes

スケール セット内の仮想マシンの作成方法を指定します。 使用できる値は FromImage のみです。 この値は、イメージを使用して仮想マシンを作成する場合に使用されます。 プラットフォーム イメージを使用している場合は、上記の imageReference 要素も使用します。 マーケットプレース イメージを使用している場合は、前に説明した plan 要素も使用します。

DiskDeleteOptionTypes

VMSS Flex の削除時に OS ディスクを削除するかデタッチするかを指定します (この機能は、フレキシブル オーケストレーション モードの VMSS でのみ使用できます)。

指定できる値

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

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

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

DiskEncryptionSetParameters

ディスクに指定できるカスタマー マネージド ディスク暗号化セット リソース ID のパラメーターについて説明します。 メモ: ディスク暗号化セットのリソース ID は、マネージド ディスクに対してのみ指定できます。 詳細については、こちらをご覧 https://aka.ms/mdssewithcmkoverview ください。

DomainNameLabelScopeTypes

ドメイン名ラベルスコープ。ドメイン名ラベル スコープと vm インデックスからポリシーに従って生成されたハッシュドメイン名ラベルの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります。

EncryptionIdentity

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

EventGridAndResourceGraph

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

ExtendedLocation

拡張場所の複合型。

ExtendedLocationTypes

拡張場所の型。

ImageReference

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

InnerError

内部エラーの詳細。

InstanceViewStatus

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

IPVersion

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

KeyVaultSecretReference

Key Vault シークレットへの参照について説明します

LinuxConfiguration

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

LinuxPatchAssessmentMode

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

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

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

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

LinuxPatchSettings

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

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

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

LinuxVMGuestPatchAutomaticByPlatformSettings

Linux のパッチ設定でパッチ モード AutomaticByPlatform が選択されている場合に適用する追加の設定を指定します。

LinuxVMGuestPatchMode

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

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

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

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

Mode

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

NetworkApiVersion

は、オーケストレーション モード 'フレキシブル' を使用して仮想マシン スケール セットのネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API バージョンを指定します

NetworkInterfaceAuxiliaryMode

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

NetworkInterfaceAuxiliarySku

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

OperatingSystemTypes

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

OrchestrationMode

仮想マシン スケール セットのオーケストレーション モードを指定します。

OSImageNotificationProfile
PassNames

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

PatchSettings

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

Plan

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

PriorityMixPolicy

フレキシブル オーケストレーション モードのスケール セット内のスポットおよび標準の優先度 VM のターゲット分割を指定します。 このプロパティを使用すると、お客様は、VMSS Flex インスタンスのスケールアウト時に作成される通常の優先度 VM の基本数と、このベース ターゲットに到達した後のスポットと通常の優先度 VM の間の分割を指定できます。

ProtocolTypes

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

ProxyAgentSettings

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

PublicIPAddressSku

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

PublicIPAddressSkuName

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

PublicIPAddressSkuTier

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

RepairAction

スケール セット内の異常な仮想マシンの修復に使用される修復アクションの種類 (置換、再起動、再イメージ化)。 既定値は replace です。

ResiliencyPolicy

回復性ポリシー (resilientVMCreationPolicy または resilientVMDeletionPolicy) について説明します。

ResilientVMCreationPolicy

回復性のある VM の作成の実行中に使用される構成パラメーター。

ResilientVMDeletionPolicy

回復性のある VM の削除の実行中に使用される構成パラメーター。

ResourceIdentityType

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

RollingUpgradePolicy

ローリング アップグレードの実行中に使用される構成パラメーター。

ScaleInPolicy

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

ScheduledEventsAdditionalPublishingTargets
ScheduledEventsPolicy

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

ScheduledEventsProfile
securityEncryptionTypes

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

SecurityPostureReference

スケール セット内のすべての仮想マシンに使用するセキュリティ体制を指定します。 最小 api-version: 2023-03-01

SecurityProfile

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

SecurityTypes

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

ServiceArtifactReference

'latest' イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス成果物参照 ID を指定します。 最小 api-version: 2022-11-01

SettingNames

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

Sku

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

SpotRestorePolicy

仮想マシン スケール セットの Spot-Try-Restore プロパティを指定します。 このプロパティを使用すると、お客様は、容量の可用性と価格の制約に基づいて、削除されたスポット VMSS VM インスタンスの自動復元を日和見的に有効または無効にすることができます。

SshConfiguration

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

SshPublicKey

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

StatusLevelTypes

レベル コード。

StorageAccountTypes

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

SubResource
TerminateNotificationProfile
UefiSettings

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

UpgradeMode

スケール セット内の仮想マシンへのアップグレードのモードを指定します。

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

手動 - スケール セット内の仮想マシンへの更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。

自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。

UpgradePolicy

アップグレード ポリシー (自動、手動、またはローリング) について説明します。

UserAssignedIdentities

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

UserInitiatedReboot

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

UserInitiatedRedeploy

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

VaultCertificate

Key Vault内の 1 つの証明書参照と、VM 上の証明書の存在場所について説明します。

VaultSecretGroup

すべて同じKey Vault内にある証明書のセットについて説明します。

VirtualHardDisk

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

VirtualMachineEvictionPolicyTypes

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

VirtualMachineExtension

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

VirtualMachineExtensionInstanceView

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

VirtualMachinePriorityTypes

スケール セット内の仮想マシンの優先度を指定します。 最小 api-version: 2017-10-30-preview。

VirtualMachineScaleSet

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

VirtualMachineScaleSetDataDisk

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

VirtualMachineScaleSetExtension

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

VirtualMachineScaleSetExtensionProfile

仮想マシン スケール セット拡張機能プロファイルについて説明します。

VirtualMachineScaleSetHardwareProfile

仮想マシン スケール セットのハードウェア設定を指定します。

VirtualMachineScaleSetIdentity

仮想マシン スケール セットの ID。

VirtualMachineScaleSetIPConfiguration

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

VirtualMachineScaleSetIpTag

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

VirtualMachineScaleSetListResult

仮想マシンの操作応答を一覧表示します。

VirtualMachineScaleSetManagedDiskParameters

ScaleSet マネージド ディスクのパラメーターについて説明します。

VirtualMachineScaleSetNetworkConfiguration

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

VirtualMachineScaleSetNetworkConfigurationDnsSettings

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

VirtualMachineScaleSetNetworkProfile

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

VirtualMachineScaleSetOSDisk

仮想マシン スケール セットのオペレーティング システム ディスクについて説明します。

VirtualMachineScaleSetOSProfile

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

VirtualMachineScaleSetPublicIPAddressConfiguration

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

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

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

VirtualMachineScaleSetScaleInRules

仮想マシン スケール セットのスケーリング時に従う規則。

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

既定 仮想マシン スケール セットをスケールインすると、ゾーン スケール セットの場合、スケール セットは最初にゾーン間でバランスが取られます。 その後、可能な限り障害ドメイン間でバランスが取れます。 各障害ドメイン内では、削除用に選択された仮想マシンは、スケールインから保護されていない最新のマシンになります。

OldestVM 仮想マシン スケール セットがスケールインされている場合、スケール インから保護されていない最も古い仮想マシンが削除対象として選択されます。 ゾーン仮想マシン スケール セットの場合、スケール セットは最初にゾーン間で分散されます。 各ゾーン内では、保護されていない最も古い仮想マシンが削除対象として選択されます。

NewestVM 仮想マシン スケール セットがスケールインされている場合、スケール インから保護されていない最新の仮想マシンが削除用に選択されます。 ゾーン仮想マシン スケール セットの場合、スケール セットは最初にゾーン間で分散されます。 各ゾーン内では、保護されていない最新の仮想マシンが削除対象として選択されます。

VirtualMachineScaleSetStorageProfile

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

VirtualMachineScaleSetVMProfile

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

VMDiskSecurityProfile

マネージド ディスクのセキュリティ プロファイル設定を指定します。 メモ: これは、機密 VM にのみ設定できます。

VMGalleryApplication

コンピューティング ギャラリー アプリケーションのバージョンを参照するために必要な情報を指定します

VMSizeProperties

仮想マシンの VM サイズ プロパティの設定を指定します。

WindowsConfiguration

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

WindowsPatchAssessmentMode

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

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

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

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

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

WindowsVMGuestPatchAutomaticByPlatformSettings

Windows のパッチ設定でパッチ モード AutomaticByPlatform が選択されている場合に適用する追加の設定を指定します。

WindowsVMGuestPatchMode

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

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

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

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

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

WinRMConfiguration

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

WinRMListener

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

AdditionalCapabilities

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

名前 説明
hibernationEnabled

boolean

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

ultraSSDEnabled

boolean

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

AdditionalUnattendContent

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

名前 説明
componentName

ComponentNames

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

content

string

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

passName

PassNames

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

settingName

SettingNames

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

ApiEntityReference

API エンティティ参照。

名前 説明
id

string

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

ApiError

API エラー。

名前 説明
code

string

エラー コード。

details

ApiErrorBase[]

Api エラーの詳細

innererror

InnerError

Api の内部エラー

message

string

エラー メッセージ。

target

string

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

ApiErrorBase

API エラーベース。

名前 説明
code

string

エラー コード。

message

string

エラー メッセージ。

target

string

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

ApplicationProfile

VM/VMSS で使用できるようにする必要があるギャラリー アプリケーションの一覧が含まれます

名前 説明
galleryApplications

VMGalleryApplication[]

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

AutomaticOSUpgradePolicy

OS の自動アップグレードを実行するために使用される構成パラメーター。

名前 説明
disableAutomaticRollback

boolean

OS イメージのロールバック機能を無効にするかどうか。 既定値は false です。

enableAutomaticOSUpgrade

boolean

新しいバージョンの OS イメージが使用可能になったときに、スケール セット インスタンスに OS アップグレードを自動的に適用するかどうかを示します。 既定値は false です。 Windows ベースのスケール セットに対してこれが true に設定されている場合、 enableAutomaticUpdates は自動的に false に設定され、true に設定することはできません。

osRollingUpgradeDeferral

boolean

OS の自動アップグレードを延期する必要があるかどうかを示します。 遅延 OS アップグレードでは、IMDS タグ "Platform.PendingOSUpgrade" を介して、ローリング アップグレードからの OS アップグレードが受信されたことを VM ごとに高度な通知が送信されます。 その後、アップグレードは、ApproveRollingUpgrade 呼び出しによってアップグレードが承認されるまで延期されます。

useRollingUpgradePolicy

boolean

OS の自動アップグレード中にローリング アップグレード ポリシーを使用するかどうかを示します。 既定値は false です。 VMSS でポリシーが定義されていない場合、OS の自動アップグレードは既定のポリシーにフォールバックします。

AutomaticRepairsPolicy

仮想マシン スケール セットの自動修復の構成パラメーターを指定します。

名前 説明
enabled

boolean

仮想マシン スケール セットで自動修復を有効にするかどうかを指定します。 既定値は false です。

gracePeriod

string

VM の状態の変更により自動修復が中断される時間。 猶予期間は、状態の変更が完了した後に開始されます。 これは、早期または偶発的な修復を回避するのに役立ちます。 期間は ISO 8601 形式で指定する必要があります。 許容される最小猶予期間は 10 分 (PT10M) です。これも既定値です。 許可される猶予期間の上限は 90 分 (PT90M) です。

repairAction

RepairAction

スケール セット内の異常な仮想マシンの修復に使用される修復アクションの種類 (置換、再起動、再イメージ化)。 既定値は replace です。

BillingProfile

Azure スポット VM または VMSS の課金関連の詳細を指定します。 最小 api-version: 2019-03-01。

名前 説明
maxPrice

number

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

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

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

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

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

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

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

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

BootDiagnostics

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

名前 説明
enabled

boolean

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

storageUri

string

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

CachingTypes

キャッシュの要件を指定します。 使用できる値は、 None、ReadOnly、ReadWrite です。 既定値は、 標準ストレージの場合は [なし] です。Premium Storage の ReadOnly。

名前 説明
None

string

ReadOnly

string

ReadWrite

string

CapacityReservationProfile

容量予約プロファイルのパラメーター。

名前 説明
capacityReservationGroup

SubResource

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

CloudError

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

名前 説明
error

ApiError

API エラー。

ComponentNames

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

名前 説明
Microsoft-Windows-Shell-Setup

string

DeleteOptions

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

名前 説明
Delete

string

Detach

string

DiagnosticsProfile

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

名前 説明
bootDiagnostics

BootDiagnostics

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

DiffDiskOptions

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

名前 説明
Local

string

DiffDiskPlacement

オペレーティング システム ディスクのエフェメラル ディスクの配置を指定します。 このプロパティは、要求のユーザーが、エフェメラル OS ディスク プロビジョニング用のキャッシュ ディスク、リソース ディスク、または nvme ディスク領域の場所を選択するために使用できます。 エフェメラル OS ディスク サイズの要件の詳細については、Windows VM のエフェメラル OS ディスク サイズ要件と Linux VM https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirementshttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirementsを参照してください。 NvmeDisk の最小 api-version: 2024-03-01。

名前 説明
CacheDisk

string

NvmeDisk

string

ResourceDisk

string

DiffDiskSettings

オペレーティング システム ディスクに指定できるエフェメラル ディスク設定のパラメーターについて説明します。 メモ: エフェメラル ディスクの設定は、マネージド ディスクに対してのみ指定できます。

名前 説明
option

DiffDiskOptions

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

placement

DiffDiskPlacement

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

DiskControllerTypes

名前 説明
NVMe

string

SCSI

string

DiskCreateOptionTypes

スケール セット内の仮想マシンの作成方法を指定します。 使用できる値は FromImage のみです。 この値は、イメージを使用して仮想マシンを作成する場合に使用されます。 プラットフォーム イメージを使用している場合は、上記の imageReference 要素も使用します。 マーケットプレース イメージを使用している場合は、前に説明した plan 要素も使用します。

名前 説明
Attach

string

Copy

string

Empty

string

FromImage

string

Restore

string

DiskDeleteOptionTypes

VMSS Flex の削除時に OS ディスクを削除するかデタッチするかを指定します (この機能は、フレキシブル オーケストレーション モードの VMSS でのみ使用できます)。

指定できる値

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

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

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

名前 説明
Delete

string

Detach

string

DiskEncryptionSetParameters

ディスクに指定できるカスタマー マネージド ディスク暗号化セット リソース ID のパラメーターについて説明します。 メモ: ディスク暗号化セットのリソース ID は、マネージド ディスクに対してのみ指定できます。 詳細については、こちらをご覧 https://aka.ms/mdssewithcmkoverview ください。

名前 説明
id

string

リソース ID

DomainNameLabelScopeTypes

ドメイン名ラベルスコープ。ドメイン名ラベル スコープと vm インデックスからポリシーに従って生成されたハッシュドメイン名ラベルの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります。

名前 説明
NoReuse

string

ResourceGroupReuse

string

SubscriptionReuse

string

TenantReuse

string

EncryptionIdentity

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

名前 説明
userAssignedIdentityResourceId

string

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

EventGridAndResourceGraph

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

名前 説明
enable

boolean

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

ExtendedLocation

拡張場所の複合型。

名前 説明
name

string

拡張場所の名前。

type

ExtendedLocationTypes

拡張された場所の型。

ExtendedLocationTypes

拡張場所の型。

名前 説明
EdgeZone

string

ImageReference

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

名前 説明
communityGalleryImageId

string

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

exactVersion

string

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

id

string

リソース ID

offer

string

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

publisher

string

イメージの発行元。

sharedGalleryImageId

string

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

sku

string

イメージ SKU。

version

string

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

InnerError

内部エラーの詳細。

名前 説明
errordetail

string

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

exceptiontype

string

例外の種類。

InstanceViewStatus

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

名前 説明
code

string

ステータス コード。

displayStatus

string

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

level

StatusLevelTypes

レベル コード。

message

string

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

time

string

状態の時刻。

IPVersion

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

名前 説明
IPv4

string

IPv6

string

KeyVaultSecretReference

Key Vault シークレットへの参照について説明します

名前 説明
secretUrl

string

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

sourceVault

SubResource

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

LinuxConfiguration

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

名前 説明
disablePasswordAuthentication

boolean

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

enableVMAgentPlatformUpdates

boolean

Linux 仮想マシンに対して VMAgent Platform Updatesが有効かどうかを示します。 既定値は false です。

patchSettings

LinuxPatchSettings

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

provisionVMAgent

boolean

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

ssh

SshConfiguration

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

LinuxPatchAssessmentMode

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

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

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

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

名前 説明
AutomaticByPlatform

string

ImageDefault

string

LinuxPatchSettings

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

名前 説明
assessmentMode

LinuxPatchAssessmentMode

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

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

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

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

automaticByPlatformSettings

LinuxVMGuestPatchAutomaticByPlatformSettings

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

patchMode

LinuxVMGuestPatchMode

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

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

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

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

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

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

名前 説明
Always

string

IfRequired

string

Never

string

Unknown

string

LinuxVMGuestPatchAutomaticByPlatformSettings

Linux のパッチ設定でパッチ モード AutomaticByPlatform が選択されている場合に適用する追加の設定を指定します。

名前 説明
bypassPlatformSafetyChecksOnUserSchedule

boolean

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

rebootSetting

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

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

LinuxVMGuestPatchMode

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

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

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

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

名前 説明
AutomaticByPlatform

string

ImageDefault

string

Mode

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

名前 説明
Audit

string

Enforce

string

NetworkApiVersion

は、オーケストレーション モード 'フレキシブル' を使用して仮想マシン スケール セットのネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API バージョンを指定します

名前 説明
2020-11-01

string

NetworkInterfaceAuxiliaryMode

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

名前 説明
AcceleratedConnections

string

Floating

string

None

string

NetworkInterfaceAuxiliarySku

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

名前 説明
A1

string

A2

string

A4

string

A8

string

None

string

OperatingSystemTypes

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

名前 説明
Linux

string

Windows

string

OrchestrationMode

仮想マシン スケール セットのオーケストレーション モードを指定します。

名前 説明
Flexible

string

Uniform

string

OSImageNotificationProfile

名前 説明
enable

boolean

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

notBeforeTimeout

string

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

PassNames

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

名前 説明
OobeSystem

string

PatchSettings

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

名前 説明
assessmentMode

WindowsPatchAssessmentMode

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

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

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

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

automaticByPlatformSettings

WindowsVMGuestPatchAutomaticByPlatformSettings

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

enableHotpatching

boolean

再起動を必要とせずに、お客様が Azure VM にパッチを適用できるようにします。 enableHotpatching の場合、'provisionVMAgent' を true に設定し、'patchMode' を 'AutomaticByPlatform' に設定する必要があります。

patchMode

WindowsVMGuestPatchMode

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

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

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

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

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

Plan

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

名前 説明
name

string

プラン ID。

product

string

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

promotionCode

string

販売促進コード。

publisher

string

発行元 ID。

PriorityMixPolicy

フレキシブル オーケストレーション モードのスケール セット内のスポットおよび標準の優先度 VM のターゲット分割を指定します。 このプロパティを使用すると、お客様は、VMSS Flex インスタンスのスケールアウト時に作成される通常の優先度 VM の基本数と、このベース ターゲットに到達した後のスポットと通常の優先度 VM の間の分割を指定できます。

名前 説明
baseRegularPriorityCount

integer

スケールアウト時にこのスケール セットで作成される通常の優先度 VM の基本数。

regularPriorityPercentageAboveBase

integer

基本の通常の優先度の数に達した後の、通常の優先度を使用すると予想される VM インスタンスの割合。

ProtocolTypes

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

名前 説明
Http

string

Https

string

ProxyAgentSettings

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

名前 説明
enabled

boolean

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

keyIncarnationId

integer

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

mode

Mode

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

PublicIPAddressSku

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

名前 説明
name

PublicIPAddressSkuName

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

tier

PublicIPAddressSkuTier

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

PublicIPAddressSkuName

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

名前 説明
Basic

string

Standard

string

PublicIPAddressSkuTier

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

名前 説明
Global

string

Regional

string

RepairAction

スケール セット内の異常な仮想マシンの修復に使用される修復アクションの種類 (置換、再起動、再イメージ化)。 既定値は replace です。

名前 説明
Reimage

string

Replace

string

Restart

string

ResiliencyPolicy

回復性ポリシー (resilientVMCreationPolicy または resilientVMDeletionPolicy) について説明します。

名前 説明
resilientVMCreationPolicy

ResilientVMCreationPolicy

回復性のある VM の作成の実行中に使用される構成パラメーター。

resilientVMDeletionPolicy

ResilientVMDeletionPolicy

回復性のある VM の削除の実行中に使用される構成パラメーター。

ResilientVMCreationPolicy

回復性のある VM の作成の実行中に使用される構成パラメーター。

名前 説明
enabled

boolean

仮想マシン スケール セットで回復性のある VM の作成を有効にするかどうかを指定します。 既定値は false です。

ResilientVMDeletionPolicy

回復性のある VM の削除の実行中に使用される構成パラメーター。

名前 説明
enabled

boolean

仮想マシン スケール セットで回復性のある VM の削除を有効にするかどうかを指定します。 既定値は false です。

ResourceIdentityType

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

名前 説明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

RollingUpgradePolicy

ローリング アップグレードの実行中に使用される構成パラメーター。

名前 説明
enableCrossZoneUpgrade

boolean

アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、Update Domain と maxBatchInstancePercent を考慮してください。

maxBatchInstancePercent

integer

1 つのバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計の最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるために、バッチ内のインスタンスの割合が減少する可能性があります。 このパラメーターの既定値は 20% です。

maxSurge

boolean

既存の仮想マシンを更新するのではなく、新しい仮想マシンを作成してスケール セットをアップグレードします。 既存の仮想マシンは、バッチごとに新しい仮想マシンが作成されると削除されます。

maxUnhealthyInstancePercent

integer

アップグレードの結果として、またはローリング アップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計に対する最大割合。 この制約は、バッチを開始する前にチェックされます。 このパラメーターの既定値は 20% です。

maxUnhealthyUpgradedInstancePercent

integer

異常な状態にあることが検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に発生します。 この割合を超えた場合、ローリング 更新プログラムは中止されます。 このパラメーターの既定値は 20% です。

pauseTimeBetweenBatches

string

すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。 既定値は 0 秒 (PT0S) です。

prioritizeUnhealthyInstances

boolean

正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。

rollbackFailedInstancesOnPolicyBreach

boolean

ローリング アップグレード ポリシーに違反した場合、失敗したインスタンスを以前のモデルにロールバックします。

ScaleInPolicy

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

名前 説明
forceDeletion

boolean

このプロパティを使用すると、仮想マシン スケール セットをスケールインするときに、削除のために選択した仮想マシンを強制的に削除する必要があるかどうかを指定できます。(プレビューの機能)

rules

VirtualMachineScaleSetScaleInRules[]

仮想マシン スケール セットのスケーリング時に従う規則。

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

既定 仮想マシン スケール セットをスケールインすると、ゾーン スケール セットの場合、スケール セットは最初にゾーン間でバランスが取られます。 その後、可能な限り障害ドメイン間でバランスが取れます。 各障害ドメイン内では、削除用に選択された仮想マシンは、スケールインから保護されていない最新のマシンになります。

OldestVM 仮想マシン スケール セットがスケールインされている場合、スケール インから保護されていない最も古い仮想マシンが削除対象として選択されます。 ゾーン仮想マシン スケール セットの場合、スケール セットは最初にゾーン間で分散されます。 各ゾーン内では、保護されていない最も古い仮想マシンが削除対象として選択されます。

NewestVM 仮想マシン スケール セットがスケールインされている場合、スケール インから保護されていない最新の仮想マシンが削除用に選択されます。 ゾーン仮想マシン スケール セットの場合、スケール セットは最初にゾーン間で分散されます。 各ゾーン内では、保護されていない最新の仮想マシンが削除対象として選択されます。

ScheduledEventsAdditionalPublishingTargets

名前 説明
eventGridAndResourceGraph

EventGridAndResourceGraph

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

ScheduledEventsPolicy

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

名前 説明
scheduledEventsAdditionalPublishingTargets

ScheduledEventsAdditionalPublishingTargets

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

userInitiatedReboot

UserInitiatedReboot

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

userInitiatedRedeploy

UserInitiatedRedeploy

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

ScheduledEventsProfile

名前 説明
osImageNotificationProfile

OSImageNotificationProfile

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

terminateNotificationProfile

TerminateNotificationProfile

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

securityEncryptionTypes

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

名前 説明
DiskWithVMGuestState

string

NonPersistedTPM

string

VMGuestStateOnly

string

SecurityPostureReference

スケール セット内のすべての仮想マシンに使用するセキュリティ体制を指定します。 最小 api-version: 2023-03-01

名前 説明
excludeExtensions

VirtualMachineExtension[]

セキュリティ体制を適用するときに除外する仮想マシン拡張機能の一覧。

id

string

/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}の形式のセキュリティ体制参照 ID|{major.*}|latest

SecurityProfile

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

名前 説明
encryptionAtHost

boolean

このプロパティは、要求のユーザーが仮想マシンまたは仮想マシン スケール セットの Host Encryption を有効または無効にするために使用できます。 これにより、ホスト自体のリソース/一時ディスクを含むすべてのディスクの暗号化が有効になります。 既定の動作は次のとおりです。このプロパティがリソースに対して true に設定されていない限り、ホストでの暗号化は無効になります。

encryptionIdentity

EncryptionIdentity

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

proxyAgentSettings

ProxyAgentSettings

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

securityType

SecurityTypes

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

uefiSettings

UefiSettings

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

SecurityTypes

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

名前 説明
ConfidentialVM

string

TrustedLaunch

string

ServiceArtifactReference

'latest' イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス成果物参照 ID を指定します。 最小 api-version: 2022-11-01

名前 説明
id

string

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} の形式のサービス成果物参照 ID

SettingNames

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

名前 説明
AutoLogon

string

FirstLogonCommands

string

Sku

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

名前 説明
capacity

integer

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

name

string

SKU 名。

tier

string

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

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

Standard

Basic

SpotRestorePolicy

仮想マシン スケール セットの Spot-Try-Restore プロパティを指定します。 このプロパティを使用すると、お客様は、容量の可用性と価格の制約に基づいて、削除されたスポット VMSS VM インスタンスの自動復元を日和見的に有効または無効にすることができます。

名前 説明
enabled

boolean

容量の可用性と価格の制約に基づいて、削除された VMSS SPOT インスタンスを日和見的に復元しようとするスポット-Try-Restore 機能を有効にします

restoreTimeout

string

プラットフォームが VMSS SPOT インスタンスの復元を試行しない ISO 8601 期間として表されるタイムアウト値

SshConfiguration

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

名前 説明
publicKeys

SshPublicKey[]

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

SshPublicKey

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

名前 説明
keyData

string

SSH を使用して VM で認証するために使用される SSH 公開キー証明書。 キーは、少なくとも 2048 ビットで、ssh-rsa 形式である必要があります。 ssh キーの作成については、「Azure で Linux VM 用の Linux と Mac で SSH キーを作成する」を参照してください。https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

path

string

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

StatusLevelTypes

レベル コード。

名前 説明
Error

string

Info

string

Warning

string

StorageAccountTypes

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

名前 説明
PremiumV2_LRS

string

Premium_LRS

string

Premium_ZRS

string

StandardSSD_LRS

string

StandardSSD_ZRS

string

Standard_LRS

string

UltraSSD_LRS

string

SubResource

名前 説明
id

string

リソース ID

TerminateNotificationProfile

名前 説明
enable

boolean

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

notBeforeTimeout

string

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

UefiSettings

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

名前 説明
secureBootEnabled

boolean

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

vTpmEnabled

boolean

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

UpgradeMode

スケール セット内の仮想マシンへのアップグレードのモードを指定します。

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

手動 - スケール セット内の仮想マシンへの更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。

自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。

名前 説明
Automatic

string

Manual

string

Rolling

string

UpgradePolicy

アップグレード ポリシー (自動、手動、またはローリング) について説明します。

名前 説明
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

OS の自動アップグレードを実行するために使用される構成パラメーター。

mode

UpgradeMode

スケール セット内の仮想マシンへのアップグレードモードを指定します。

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

手動 - スケール セット内の仮想マシンへの更新プログラムの適用を制御します。 これを行うには、manualUpgrade アクションを使用します。

自動 - スケール セット内のすべての仮想マシンが同時に自動的に更新されます。

rollingUpgradePolicy

RollingUpgradePolicy

ローリング アップグレードの実行中に使用される構成パラメーター。

UserAssignedIdentities

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

名前 説明

UserInitiatedReboot

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

名前 説明
automaticallyApprove

boolean

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

UserInitiatedRedeploy

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

名前 説明
automaticallyApprove

boolean

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

VaultCertificate

Key Vault内の 1 つの証明書参照と、VM 上の証明書の存在場所について説明します。

名前 説明
certificateStore

string

Windows VM の場合は、証明書を追加する仮想マシン上の証明書ストアを指定します。 指定された証明書ストアは、LocalMachine アカウントに暗黙的に含まれます。 Linux VM の場合、証明書ファイルは /var/lib/waagent ディレクトリの下に配置され、X509 証明書ファイルのファイル名 <は UppercaseThumbprint.crt>、 <秘密キーの場合は UppercaseThumbprint.prv> です。 これらのファイルはどちらも .pem 形式です。

certificateUrl

string

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

{
"data":"",
"dataType":"pfx",
"password":""
}
仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault 仮想マシン拡張機能を使用することをお勧めします。

VaultSecretGroup

すべて同じKey Vault内にある証明書のセットについて説明します。

名前 説明
sourceVault

SubResource

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

vaultCertificates

VaultCertificate[]

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

VirtualHardDisk

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

名前 説明
uri

string

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

VirtualMachineEvictionPolicyTypes

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

名前 説明
Deallocate

string

Delete

string

VirtualMachineExtension

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

名前 説明
id

string

リソース ID

location

string

リソースの場所

name

string

リソース名

properties.autoUpgradeMinorVersion

boolean

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

properties.enableAutomaticUpgrade

boolean

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

properties.forceUpdateTag

string

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

properties.instanceView

VirtualMachineExtensionInstanceView

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

properties.protectedSettings

object

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

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

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

properties.provisionAfterExtensions

string[]

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

properties.provisioningState

string

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

properties.publisher

string

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

properties.settings

object

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

properties.suppressFailures

boolean

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

properties.type

string

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

properties.typeHandlerVersion

string

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

tags

object

リソース タグ

type

string

リソースの種類

VirtualMachineExtensionInstanceView

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

名前 説明
name

string

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

statuses

InstanceViewStatus[]

リソースの状態情報。

substatuses

InstanceViewStatus[]

リソースの状態情報。

type

string

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

typeHandlerVersion

string

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

VirtualMachinePriorityTypes

スケール セット内の仮想マシンの優先度を指定します。 最小 api-version: 2017-10-30-preview。

名前 説明
Low

string

Regular

string

Spot

string

VirtualMachineScaleSet

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

名前 説明
etag

string

Etag は、VMSS の作成/更新/取得応答で返されるプロパティです。これにより、お客様はヘッダーで指定して、楽観的な更新を保証できます

extendedLocation

ExtendedLocation

仮想マシン スケール セットの拡張された場所。

id

string

リソース ID

identity

VirtualMachineScaleSetIdentity

構成されている場合は、仮想マシン スケール セットの ID。

location

string

リソースの場所

name

string

リソース名

plan

Plan

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

properties.additionalCapabilities

AdditionalCapabilities

仮想マシン スケール セットのVirtual Machinesで有効または無効にされる追加機能を指定します。 たとえば、ストレージ アカウントの種類を持つマネージド データ ディスクのアタッチをサポートする機能がVirtual MachinesにあるかどうかUltraSSD_LRS。

properties.automaticRepairsPolicy

AutomaticRepairsPolicy

自動修復のポリシー。

properties.constrainedMaximumCapacity

boolean

True に設定するか、省略する必要がある省略可能なプロパティ。

properties.doNotRunExtensionsOnOverprovisionedVMs

boolean

オーバープロビジョニングが有効になっている場合、拡張機能は、最終的に保持される要求された数の VM でのみ起動されます。 そのため、このプロパティを使用すると、追加のオーバープロビジョニングされた VM で拡張機能が実行されなくなります。

properties.hostGroup

SubResource

仮想マシン スケール セットが存在する専用ホスト グループに関する情報を指定します。 最小 api-version: 2020-06-01。

properties.orchestrationMode

OrchestrationMode

仮想マシン スケール セットのオーケストレーション モードを指定します。

properties.overprovision

boolean

仮想マシン スケール セットをオーバープロビジョニングするかどうかを指定します。

properties.platformFaultDomainCount

integer

各配置グループの障害ドメイン数。

properties.priorityMixPolicy

PriorityMixPolicy

同じ VMSS Flex インスタンス内でスポットと通常の優先度の VM を混在するために必要なターゲットを指定します。

properties.provisioningState

string

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

properties.proximityPlacementGroup

SubResource

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

properties.resiliencyPolicy

ResiliencyPolicy

回復性のポリシー

properties.scaleInPolicy

ScaleInPolicy

仮想マシン スケール セットのVirtual Machinesでスケーリングするときに適用されるポリシーを指定します。

properties.scheduledEventsPolicy

ScheduledEventsPolicy

ScheduledEventsPolicy。

properties.singlePlacementGroup

boolean

true の場合、スケール セットは 1 つの配置グループ (最大サイズは 100 仮想マシン) に制限されます。 注: singlePlacementGroup が true の場合は、false に変更される可能性があります。 ただし、singlePlacementGroup が false の場合は、true に変更できません。

properties.spotRestorePolicy

SpotRestorePolicy

仮想マシン スケール セットのスポット リストア プロパティを指定します。

properties.timeCreated

string

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

properties.uniqueId

string

仮想マシン スケール セットを一意に識別する ID を指定します。

properties.upgradePolicy

UpgradePolicy

アップグレード ポリシー。

properties.virtualMachineProfile

VirtualMachineScaleSetVMProfile

仮想マシン プロファイル。

properties.zoneBalance

boolean

ゾーンの停止が発生した場合に仮想マシンの配布を x ゾーン間で厳密に行うかどうか。 zoneBalance プロパティは、スケール セットの zones プロパティに複数のゾーンが含まれている場合にのみ設定できます。 ゾーンが指定されていない場合、またはゾーンが 1 つしか指定されていない場合は、zoneBalance プロパティを設定しないでください。

sku

Sku

仮想マシン スケール セット SKU。

tags

object

リソース タグ

type

string

リソースの種類

zones

string[]

仮想マシン スケール セット ゾーン。 注: 可用性ゾーンは、スケール セットを作成するときにのみ設定できます

VirtualMachineScaleSetDataDisk

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

名前 説明
caching

CachingTypes

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

createOption

DiskCreateOptionTypes

作成オプション。

deleteOption

DiskDeleteOptionTypes

VMSS Flex の削除時にデータ ディスクを削除するかデタッチするかを指定します (この機能は、フレキシブル オーケストレーション モードの VMSS でのみ使用できます)。

指定できる値

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

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

既定値は Delete に設定 されています

diskIOPSReadWrite

integer

マネージド ディスクの Read-Write IOPS を指定します。 StorageAccountType がUltraSSD_LRS場合にのみ使用する必要があります。 指定しない場合、既定値は diskSizeGB に基づいて割り当てられます。

diskMBpsReadWrite

integer

マネージド ディスクの帯域幅を 1 秒あたりの MB 単位で指定します。 StorageAccountType がUltraSSD_LRS場合にのみ使用する必要があります。 指定しない場合、既定値は diskSizeGB に基づいて割り当てられます。

diskSizeGB

integer

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

lun

integer

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

managedDisk

VirtualMachineScaleSetManagedDiskParameters

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

name

string

ディスク名。

writeAcceleratorEnabled

boolean

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

VirtualMachineScaleSetExtension

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

名前 説明
id

string

リソース ID

name

string

拡張機能の名前です。

properties.autoUpgradeMinorVersion

boolean

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

properties.enableAutomaticUpgrade

boolean

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

properties.forceUpdateTag

string

値が指定され、前の値と異なる場合、拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーは強制的に更新されます。

properties.protectedSettings

object

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

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

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

properties.provisionAfterExtensions

string[]

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

properties.provisioningState

string

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

properties.publisher

string

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

properties.settings

object

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

properties.suppressFailures

boolean

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

properties.type

string

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

properties.typeHandlerVersion

string

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

type

string

リソースの種類

VirtualMachineScaleSetExtensionProfile

仮想マシン スケール セット拡張機能プロファイルについて説明します。

名前 説明
extensions

VirtualMachineScaleSetExtension[]

仮想マシン スケール セットの子拡張機能リソース。

extensionsTimeBudget

string

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

VirtualMachineScaleSetHardwareProfile

仮想マシン スケール セットのハードウェア設定を指定します。

名前 説明
vmSizeProperties

VMSizeProperties

仮想マシンのサイズをカスタマイズするためのプロパティを指定します。 最小 api-version: 2021-11-01。 詳細については、「 VM のカスタマイズ 」の手順に従ってください。

VirtualMachineScaleSetIdentity

仮想マシン スケール セットの ID。

名前 説明
principalId

string

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

tenantId

string

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

type

ResourceIdentityType

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

userAssignedIdentities

UserAssignedIdentities

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

VirtualMachineScaleSetIPConfiguration

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

名前 説明
name

string

IP 構成名。

properties.applicationGatewayBackendAddressPools

SubResource[]

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

properties.applicationSecurityGroups

SubResource[]

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

properties.loadBalancerBackendAddressPools

SubResource[]

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

properties.loadBalancerInboundNatPools

SubResource[]

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

properties.primary

boolean

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

properties.privateIPAddressVersion

IPVersion

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

properties.publicIPAddressConfiguration

VirtualMachineScaleSetPublicIPAddressConfiguration

publicIPAddressConfiguration。

properties.subnet

ApiEntityReference

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

VirtualMachineScaleSetIpTag

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

名前 説明
ipTagType

string

IP タグの種類。 例: FirstPartyUsage。

tag

string

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

VirtualMachineScaleSetListResult

仮想マシンの操作応答を一覧表示します。

名前 説明
nextLink

string

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

value

VirtualMachineScaleSet[]

仮想マシン スケール セットの一覧。

VirtualMachineScaleSetManagedDiskParameters

ScaleSet マネージド ディスクのパラメーターについて説明します。

名前 説明
diskEncryptionSet

DiskEncryptionSetParameters

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

securityProfile

VMDiskSecurityProfile

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

storageAccountType

StorageAccountTypes

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

VirtualMachineScaleSetNetworkConfiguration

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

名前 説明
name

string

ネットワーク構成名。

properties.auxiliaryMode

NetworkInterfaceAuxiliaryMode

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

properties.auxiliarySku

NetworkInterfaceAuxiliarySku

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

properties.deleteOption

DeleteOptions

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

properties.disableTcpStateTracking

boolean

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

properties.dnsSettings

VirtualMachineScaleSetNetworkConfigurationDnsSettings

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

properties.enableAcceleratedNetworking

boolean

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

properties.enableFpga

boolean

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

properties.enableIPForwarding

boolean

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

properties.ipConfigurations

VirtualMachineScaleSetIPConfiguration[]

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

properties.networkSecurityGroup

SubResource

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

properties.primary

boolean

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

VirtualMachineScaleSetNetworkConfigurationDnsSettings

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

名前 説明
dnsServers

string[]

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

VirtualMachineScaleSetNetworkProfile

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

名前 説明
healthProbe

ApiEntityReference

仮想マシン スケール セット内のインスタンスの正常性を判断するために使用されるロード バランサー プローブへの参照。 参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}' の形式になります。

networkApiVersion

NetworkApiVersion

は、オーケストレーション モード 'フレキシブル' を使用して仮想マシン スケール セットのネットワーク インターフェイス構成でネットワーク リソースを作成するときに使用される Microsoft.Network API バージョンを指定します

networkInterfaceConfigurations

VirtualMachineScaleSetNetworkConfiguration[]

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

VirtualMachineScaleSetOSDisk

仮想マシン スケール セットのオペレーティング システム ディスクについて説明します。

名前 説明
caching

CachingTypes

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

createOption

DiskCreateOptionTypes

スケール セット内の仮想マシンの作成方法を指定します。 使用できる値は FromImage のみです。 この値は、イメージを使用して仮想マシンを作成するときに使用されます。 プラットフォーム イメージを使用している場合は、上記の imageReference 要素も使用します。 マーケットプレース イメージを使用している場合は、前に説明した plan 要素も使用します。

deleteOption

DiskDeleteOptionTypes

VMSS Flex の削除時に OS ディスクを削除するかデタッチするかを指定します (この機能は、フレキシブル オーケストレーション モードの VMSS でのみ使用できます)。

指定できる値

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

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

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

diffDiskSettings

DiffDiskSettings

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

diskSizeGB

integer

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

image

VirtualHardDisk

スケール セットの基にするアンマネージド ユーザー イメージに関する情報を指定します。

managedDisk

VirtualMachineScaleSetManagedDiskParameters

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

name

string

ディスク名。

osType

OperatingSystemTypes

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

vhdContainers

string[]

スケール セットのオペレーティング システム ディスクを格納するために使用されるコンテナー URL を指定します。

writeAcceleratorEnabled

boolean

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

VirtualMachineScaleSetOSProfile

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

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

管理者アカウントの名前を指定します。

Windows のみの制限: "." で終わることはできません。

許可されていない値: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1"、"123"、"a"、"actuser"、"adm"、"admin2"、"aspnet"、"backup"、"console"、"david"、"guest"、"john"、"owner"、"root"、"server"、"sql"、"support"、"support_388945a0"、"sys"、"test2"、"test3"、"user4"、"user5"。

最小長 (Linux): 1 文字

最大長 (Linux): 64 文字

最大長 (Windows): 20 文字

allowExtensionOperations

boolean

仮想マシン スケール セットで拡張機能の操作を許可するかどうかを指定します。 これは、仮想マシン スケール セットに拡張機能が存在しない場合にのみ False に設定できます。

computerNamePrefix

string

スケール セット内のすべての仮想マシンのコンピューター名プレフィックスを指定します。 コンピューター名のプレフィックスは、1 から 15 文字の長さにする必要があります。

customData

string

カスタム データの Base 64 エンコード文字列を指定します。 Base 64 エンコード文字列は、仮想マシン上にファイルとして保存されるバイナリ配列にデコードされます。 バイナリ配列の長さは最大 65535 バイトです。 VM に cloud-init を使用する場合は、「cloud-init を使用して作成時に Linux VM をカスタマイズする」を参照してください。

linuxConfiguration

LinuxConfiguration

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

requireGuestProvisionSignal

boolean

True に設定するか、省略する必要がある省略可能なプロパティ。

secrets

VaultSecretGroup[]

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

windowsConfiguration

WindowsConfiguration

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

VirtualMachineScaleSetPublicIPAddressConfiguration

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

名前 説明
name

string

publicIP アドレス構成名。

properties.deleteOption

DeleteOptions

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

properties.dnsSettings

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

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

properties.idleTimeoutInMinutes

integer

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

properties.ipTags

VirtualMachineScaleSetIpTag[]

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

properties.publicIPAddressVersion

IPVersion

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

properties.publicIPPrefix

SubResource

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

sku

PublicIPAddressSku

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

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

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

名前 説明
domainNameLabel

string

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

domainNameLabelScope

DomainNameLabelScopeTypes

ドメイン名ラベルスコープ。ドメイン名ラベル スコープと vm インデックスからポリシーに従って生成されたハッシュドメイン名ラベルの連結は、作成される PublicIPAddress リソースのドメイン名ラベルになります。

VirtualMachineScaleSetScaleInRules

仮想マシン スケール セットのスケーリング時に従う規則。

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

既定 仮想マシン スケール セットをスケールインすると、ゾーン スケール セットの場合、スケール セットは最初にゾーン間でバランスが取られます。 その後、可能な限り障害ドメイン間でバランスが取れます。 各障害ドメイン内では、削除用に選択された仮想マシンは、スケールインから保護されていない最新のマシンになります。

OldestVM 仮想マシン スケール セットがスケールインされている場合、スケール インから保護されていない最も古い仮想マシンが削除対象として選択されます。 ゾーン仮想マシン スケール セットの場合、スケール セットは最初にゾーン間で分散されます。 各ゾーン内では、保護されていない最も古い仮想マシンが削除対象として選択されます。

NewestVM 仮想マシン スケール セットがスケールインされている場合、スケール インから保護されていない最新の仮想マシンが削除用に選択されます。 ゾーン仮想マシン スケール セットの場合、スケール セットは最初にゾーン間で分散されます。 各ゾーン内では、保護されていない最新の仮想マシンが削除対象として選択されます。

名前 説明
Default

string

NewestVM

string

OldestVM

string

VirtualMachineScaleSetStorageProfile

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

名前 説明
dataDisks

VirtualMachineScaleSetDataDisk[]

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

diskControllerType

DiskControllerTypes[]

スケール セット内の仮想マシン用に構成されたディスク コントローラーの種類を指定します。 最小 api-version: 2022-08-01

imageReference

ImageReference

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

osDisk

VirtualMachineScaleSetOSDisk

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

VirtualMachineScaleSetVMProfile

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

名前 説明
applicationProfile

ApplicationProfile

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

billingProfile

BillingProfile

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

capacityReservation

CapacityReservationProfile

スケール セットの容量予約関連の詳細を指定します。 最小 api-version: 2021-04-01。

diagnosticsProfile

DiagnosticsProfile

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

evictionPolicy

VirtualMachineEvictionPolicyTypes

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

extensionProfile

VirtualMachineScaleSetExtensionProfile

スケール セット内の仮想マシンにインストールされる拡張機能の設定のコレクションを指定します。

hardwareProfile

VirtualMachineScaleSetHardwareProfile

スケール セットのハードウェア プロファイル関連の詳細を指定します。 最小 api-version: 2021-11-01。

licenseType

string

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

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

Windows_Client

Windows_Server

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

RHEL_BYOS (RHEL の場合)

SLES_BYOS (SUSE の場合)

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

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

最小 api-version: 2015-06-15

networkProfile

VirtualMachineScaleSetNetworkProfile

スケール セット内の仮想マシンのネットワーク インターフェイスのプロパティを指定します。

osProfile

VirtualMachineScaleSetOSProfile

スケール セット内の仮想マシンのオペレーティング システム設定を指定します。

priority

VirtualMachinePriorityTypes

スケール セット内の仮想マシンの優先度を指定します。 最小 api-version: 2017-10-30-preview。

scheduledEventsProfile

ScheduledEventsProfile

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

securityPostureReference

SecurityPostureReference

スケール セット内のすべての仮想マシンに使用するセキュリティ体制を指定します。 最小 api-version: 2023-03-01

securityProfile

SecurityProfile

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

serviceArtifactReference

ServiceArtifactReference

'latest' イメージ バージョンを使用する場合に、スケール セット内のすべての仮想マシンに同じイメージ バージョンを設定するために使用されるサービス成果物参照 ID を指定します。 最小 api-version: 2022-11-01

storageProfile

VirtualMachineScaleSetStorageProfile

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

timeCreated

string

仮想マシン スケール セットのこの VM プロファイルが作成された時間を指定します。 このプロパティの最小 API バージョンは 2024-03-01 です。 この値は、最小 api-version 2024-03-01 で VMSS VM プロファイルを作成または更新するときに、VMSS Flex VM タグに追加されます。

userData

string

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

VMDiskSecurityProfile

マネージド ディスクのセキュリティ プロファイル設定を指定します。 メモ: これは、機密 VM にのみ設定できます。

名前 説明
diskEncryptionSet

DiskEncryptionSetParameters

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

securityEncryptionType

securityEncryptionTypes

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

VMGalleryApplication

コンピューティング ギャラリー アプリケーションのバージョンを参照するために必要な情報を指定します

名前 説明
configurationReference

string

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

enableAutomaticUpgrade

boolean

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

order

integer

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

packageReferenceId

string

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

tags

string

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

treatFailureAsDeploymentFailure

boolean

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

VMSizeProperties

仮想マシンの VM サイズ プロパティの設定を指定します。

名前 説明
vCPUsAvailable

integer

VM で使用できる vCPU の数を指定します。 このプロパティが要求本文で指定されていない場合、既定の動作では、リージョン内 の使用可能なすべての仮想マシン サイズを一覧表示するの API 応答で公開されている VM サイズで使用可能な vCPU の値に設定します。

vCPUsPerCore

integer

vCPU と物理コアの比率を指定します。 このプロパティが要求本文で指定されていない場合、既定の動作は、 リージョン内の使用可能なすべての仮想マシン サイズを一覧表示する の API 応答で公開される VM サイズの vCPUPerCore の値に設定されます。 このプロパティを 1 に設定すると、ハイパースレッディングが無効になります。

WindowsConfiguration

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

名前 説明
additionalUnattendContent

AdditionalUnattendContent[]

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

enableAutomaticUpdates

boolean

Windows 仮想マシンに対して自動Updatesが有効になっているかどうかを示します。 既定値は true です。 仮想マシン スケール セットの場合、このプロパティを更新でき、更新は OS の再プロビジョニングで有効になります。

enableVMAgentPlatformUpdates

boolean

Windows 仮想マシンに対して VMAgent Platform Updatesが有効になっているかどうかを示します。 既定値は false です。

patchSettings

PatchSettings

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

provisionVMAgent

boolean

仮想マシン上に仮想マシン エージェントをプロビジョニングするかどうかを示します。 このプロパティが要求本文で指定されていない場合、既定では true に設定されます。 これにより、VM エージェントが VM にインストールされ、後で拡張機能を VM に追加できるようになります。

timeZone

string

仮想マシンのタイム ゾーンを指定します。 たとえば、"太平洋標準時" などです。 指定できる値は、TimeZoneInfo.GetSystemTimeZones によって返されるタイム ゾーンの値 TimeZoneInfo.Id できます。

winRM

WinRMConfiguration

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

WindowsPatchAssessmentMode

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

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

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

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

名前 説明
AutomaticByPlatform

string

ImageDefault

string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

名前 説明
Always

string

IfRequired

string

Never

string

Unknown

string

WindowsVMGuestPatchAutomaticByPlatformSettings

Windows のパッチ設定でパッチ モード AutomaticByPlatform が選択されている場合に適用する追加の設定を指定します。

名前 説明
bypassPlatformSafetyChecksOnUserSchedule

boolean

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

rebootSetting

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

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

WindowsVMGuestPatchMode

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

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

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

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

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

名前 説明
AutomaticByOS

string

AutomaticByPlatform

string

Manual

string

WinRMConfiguration

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

名前 説明
listeners

WinRMListener[]

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

WinRMListener

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

名前 説明
certificateUrl

string

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

{
"data":"",
"dataType":"pfx",
"password":""
}
仮想マシンに証明書をインストールするには、Linux 用の Azure Key Vault 仮想マシン拡張機能または Windows 用 Azure Key Vault 仮想マシン拡張機能を使用することをお勧めします。

protocol

ProtocolTypes

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