{ "swagger": "2.0", "info": { "title": "ComputeManagementClient", "description": "The Compute Management Client.", "version": "2024-07-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachineScaleSets": { "get": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_ListByLocation", "description": "Gets all the VM scale sets under the specified subscription for the specified location.", "parameters": [ { "name": "location", "in": "path", "required": true, "type": "string", "description": "The location for which VM scale sets under the subscription are queried.", "pattern": "^[-\\w\\._]+$" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Lists all the VM scale sets under the specified subscription for the specified location.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListBySubscription_ByLocation.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { "put": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_CreateOrUpdate", "description": "Create or update a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set to create or update." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineScaleSet" }, "description": "The scale set object." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "x-ms-client-name": "IfMatch", "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "x-ms-client-name": "IfNoneMatch", "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSet" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/VirtualMachineScaleSet" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Create a scale set with password authentication.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPasswordAuthentication.json" }, "Create a scale set with ssh authentication.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSshAuthentication.json" }, "Create a scale set with premium storage.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPremiumStorage.json" }, "Create a scale set with empty data disks on each vm.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEmptyDataDisksOnEachVm.json" }, "Create a scale set with an azure load balancer.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureLoadBalancer.json" }, "Create a scale set with an azure application gateway.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureApplicationGateway.json" }, "Create a scale set with boot diagnostics.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithBootDiagnostics.json" }, "Create a scale set with managed boot diagnostics.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithManagedBootDiagnostics.json" }, "Create a scale set with a marketplace image plan.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAMarketplaceImagePlan.json" }, "Create a scale set from a custom image.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromACustomImage.json" }, "Create a platform-image scale set with unmanaged os disks.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_PlatformImageWithUnmanagedOsDisks.json" }, "Create a custom-image scale set from an unmanaged generalized os image.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_CustomImageFromAnUnmanagedGeneralizedOsImage.json" }, "Create a scale set with virtual machines in different zones.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMsInDifferentZones.json" }, "Create a scale set with ephemeral os disks.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiffOsDisk.json" }, "Create a scale set with terminate scheduled events enabled.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithTerminateScheduledEventEnabled.json" }, "Create a scale set with OS image scheduled events enabled.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithOSImageScheduledEventEnabled.json" }, "Create a scale set with automatic repairs enabled": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAutomaticRepairs.json" }, "Create a scale set with DiskEncryptionSet resource in os disk and data disk.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskEncryptionSetResource.json" }, "Create a scale set with ephemeral os disks using placement property.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacement.json" }, "Create a scale set with ephemeral os disk provisioning in Nvme disk using placement property.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacementAsNvmeDisk.json" }, "Create a scale set with extension time budget.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsTimeBudget.json" }, "Create a scale set with Host Encryption using encryptionAtHost property.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEncryptionAtHost.json" }, "Create a scale set with Fpga Network Interfaces.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithFpgaNetworkInterface.json" }, "Create a scale set with Network Interfaces with public ip address dns settings.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithNetworkInterfaceWithDnsSettings.json" }, "Create a scale set with Uefi Settings of secureBoot and vTPM.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUefiSettings.json" }, "Create a scale set with ProxyAgent Settings of enabled and mode.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProxyAgentSettings.json" }, "Create a scale set from a generalized shared image.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromAGeneralizedSharedImage.json" }, "Create a scale set from a specialized shared image.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromASpecializedSharedImage.json" }, "Create a scale set with userData.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUserData.json" }, "Create a scale set with Application Profile": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithApplicationProfile.json" }, "Create a scale set with scaleInPolicy.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithScaleInPolicy.json" }, "Create a VMSS with an extension that has suppressFailures enabled": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsSuppressFailuresEnabled.json" }, "Create or update a scale set with capacity reservation.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithCapacityReservation.json" }, "Create a scale set with spot restore policy": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSpotRestorePolicy.json" }, "Create a scale set with priority mix policy": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPriorityMixPolicy.json" }, "Create a scale set with sku profile": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSkuProfile.json" }, "Create a VMSS with an extension with protectedSettingsFromKeyVault": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProtectedSettingsFromKeyVault.json" }, "Create a scale set with vm size properties": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMSizeProperties.json" }, "Create a scale set with SecurityType as ConfidentialVM": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVM.json" }, "Create a scale set with Disk Controller Type": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskControllerType.json" }, "Create a scale set where nic config has DisableTcpStateTracking property": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithDisableTcpStateTrackingNetworkInterface.json" }, "Create a scale set with Service Artifact Reference": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithServiceArtifactReference.json" }, "Create a scale set with Security Posture Reference": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityPostureReference.json" }, "Create a scale set with Resilient VM Creation enabled": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMCreationPolicy.json" }, "Create a scale set with Resilient VM Deletion enabled": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMDeletionPolicy.json" }, "Create a scale set with SecurityType as ConfidentialVM and NonPersistedTPM securityEncryptionType": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json" }, "Create a scale set with zonalPlatformFaultDomainAlignMode as Aligned": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithZonalPlatformFaultDomainAlignMode.json" } } }, "patch": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_Update", "description": "Update a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set to create or update." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetUpdate" }, "description": "The scale set object." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "x-ms-client-name": "IfMatch", "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "x-ms-client-name": "IfNoneMatch", "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSet" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_Update_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_Update_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MinimumSet_Gen.json" } } }, "delete": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_Delete", "description": "Deletes a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "forceDeletion", "in": "query", "required": false, "type": "boolean", "description": "Optional parameter to force delete a VM scale set. (Feature in Preview)" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Force Delete a VM scale set.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Delete_Force.json" } } }, "get": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_Get", "description": "Display information about a virtual machine scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "The expand expression to apply on the operation. 'UserData' retrieves the UserData property of the VM scale set that was provided by the user during the VM scale set Create/Update operation", "enum": [ "userData" ], "x-ms-enum": { "name": "ExpandTypesForGetVMScaleSets", "modelAsString": true } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSet" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get a virtual machine scale set placed on a dedicated host group through automatic placement.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json" }, "Get a virtual machine scale set with UserData": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json" }, "Get a virtual machine scale set": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json" }, "Get VM scale set VM with Disk Controller Type": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_Deallocate", "description": "Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "vmInstanceIDs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" }, "description": "A list of virtual machine instance IDs from the VM scale set." }, { "name": "hibernate", "in": "query", "required": false, "type": "boolean", "description": "Optional parameter to hibernate a virtual machine from the VM scale set. (This feature is available for VMSS with Flexible OrchestrationMode only)" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_Deallocate_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_Deallocate_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_DeleteInstances", "description": "Deletes virtual machines in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "vmInstanceIDs", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" }, "description": "A list of virtual machine instance IDs from the VM scale set." }, { "name": "forceDeletion", "in": "query", "required": false, "type": "boolean", "description": "Optional parameter to force delete virtual machines from the VM scale set. (Feature in Preview)" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_DeleteInstances_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_DeleteInstances_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { "get": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_GetInstanceView", "description": "Gets the status of a VM scale set instance.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetInstanceView" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets": { "get": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_List", "description": "Gets a list of all VM scale sets under a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "VirtualMachineScaleSet_List_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_List_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}": { "put": { "tags": [ "VirtualMachineScaleSetExtensions" ], "operationId": "VirtualMachineScaleSetExtensions_CreateOrUpdate", "description": "The operation to create or update an extension.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set where the extension should be create or updated." }, { "name": "vmssExtensionName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set extension." }, { "name": "extensionParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetExtension" }, "description": "Parameters supplied to the Create VM scale set Extension operation." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetExtension" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetExtension" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetExtension_CreateOrUpdate_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MaximumSet_Gen.json" }, "VirtualMachineScaleSetExtension_CreateOrUpdate_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MinimumSet_Gen.json" } } }, "patch": { "tags": [ "VirtualMachineScaleSetExtensions" ], "operationId": "VirtualMachineScaleSetExtensions_Update", "description": "The operation to update an extension.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set where the extension should be updated." }, { "name": "vmssExtensionName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set extension." }, { "name": "extensionParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetExtensionUpdate" }, "description": "Parameters supplied to the Update VM scale set Extension operation." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetExtension" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetExtension" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetExtension_Update_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MaximumSet_Gen.json" }, "VirtualMachineScaleSetExtension_Update_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MinimumSet_Gen.json" } } }, "delete": { "tags": [ "VirtualMachineScaleSetExtensions" ], "operationId": "VirtualMachineScaleSetExtensions_Delete", "description": "The operation to delete the extension.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set where the extension should be deleted." }, { "name": "vmssExtensionName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set extension." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetExtension_Delete_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MaximumSet_Gen.json" }, "VirtualMachineScaleSetExtension_Delete_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MinimumSet_Gen.json" } } }, "get": { "tags": [ "VirtualMachineScaleSetExtensions" ], "operationId": "VirtualMachineScaleSetExtensions_Get", "description": "The operation to get the extension.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set containing the extension." }, { "name": "vmssExtensionName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set extension." }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "The expand expression to apply on the operation." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetExtension" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualMachineScaleSetExtension_Get_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MaximumSet_Gen.json" }, "VirtualMachineScaleSetExtension_Get_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions": { "get": { "tags": [ "VirtualMachineScaleSetExtensions" ], "operationId": "VirtualMachineScaleSetExtensions_List", "description": "Gets a list of all extensions in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set containing the extension." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "VirtualMachineScaleSetExtension_List_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MaximumSet_Gen.json" }, "VirtualMachineScaleSetExtension_List_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets": { "get": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_ListAll", "description": "Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.", "parameters": [ { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "VirtualMachineScaleSet_ListAll_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_ListAll_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus": { "get": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_ListSkus", "description": "Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "VirtualMachineScaleSet_ListSkus_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_ListSkus_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory": { "get": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_GetOSUpgradeHistory", "description": "Gets list of OS upgrades on a VM scale set instance.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_PowerOff", "description": "Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges. Additionally, this operation is not allowed on virtual machines in a VM scale set that are being deallocated or have already been deallocated.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "vmInstanceIDs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" }, "description": "A list of virtual machine instance IDs from the VM scale set." }, { "name": "skipShutdown", "in": "query", "required": false, "type": "boolean", "default": false, "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_PowerOff_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_PowerOff_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_Restart", "description": "Restarts one or more virtual machines in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "vmInstanceIDs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" }, "description": "A list of virtual machine instance IDs from the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_Restart_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_Restart_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_Start", "description": "Starts one or more virtual machines in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "vmInstanceIDs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" }, "description": "A list of virtual machine instance IDs from the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_Start_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_Start_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reapply": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_Reapply", "description": "Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted", "headers": { "Location": { "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "VirtualMachineScaleSets_Reapply_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MaximumSet_Gen.json" }, "VirtualMachineScaleSets_Reapply_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_Redeploy", "description": "Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "vmInstanceIDs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" }, "description": "A list of virtual machine instance IDs from the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_Redeploy_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_Redeploy_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_PerformMaintenance", "description": "Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "vmInstanceIDs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" }, "description": "A list of virtual machine instance IDs from the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_PerformMaintenance_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_PerformMaintenance_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_UpdateInstances", "description": "Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "vmInstanceIDs", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" }, "description": "A list of virtual machine instance IDs from the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_UpdateInstances_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_UpdateInstances_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_Reimage", "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "vmScaleSetReimageInput", "in": "body", "required": false, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetReimageParameters" }, "description": "Parameters for Reimaging VM ScaleSet." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_Reimage_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_Reimage_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_ReimageAll", "description": "Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "vmInstanceIDs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" }, "description": "A list of virtual machine instance IDs from the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_ReimageAll_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_ReimageAll_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/approveRollingUpgrade": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_ApproveRollingUpgrade", "description": "Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "vmInstanceIDs", "in": "body", "required": false, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" }, "description": "A list of virtual machine instance IDs from the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted", "headers": { "Location": { "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_ApproveRollingUpgrade": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ApproveRollingUpgrade.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { "post": { "tags": [ "VirtualMachineScaleSetRollingUpgrades" ], "operationId": "VirtualMachineScaleSetRollingUpgrades_Cancel", "description": "Cancels the current virtual machine scale set rolling upgrade.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetRollingUpgrade_Cancel_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MaximumSet_Gen.json" }, "VirtualMachineScaleSetRollingUpgrade_Cancel_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { "post": { "tags": [ "VirtualMachineScaleSetRollingUpgrades" ], "operationId": "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade", "description": "Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MaximumSet_Gen.json" }, "VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensionRollingUpgrade": { "post": { "tags": [ "VirtualMachineScaleSetRollingUpgrades" ], "operationId": "VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade", "description": "Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Start an extension rolling upgrade.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_RollingUpgrade.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { "get": { "tags": [ "VirtualMachineScaleSetRollingUpgrades" ], "operationId": "VirtualMachineScaleSetRollingUpgrades_GetLatest", "description": "Gets the status of the latest virtual machine scale set rolling upgrade.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RollingUpgradeStatusInfo" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.json" }, "VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk", "description": "Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "name": "platformUpdateDomain", "in": "query", "required": true, "type": "integer", "description": "The platform update domain for which a manual recovery walk is requested" }, { "name": "zone", "in": "query", "required": false, "type": "string", "description": "The zone in which the manual recovery walk is requested for cross zone virtual machine scale set" }, { "name": "placementGroupId", "in": "query", "required": false, "type": "string", "description": "The placement group id for which the manual recovery walk is requested." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RecoveryWalkResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/convertToSinglePlacementGroup": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_ConvertToSinglePlacementGroup", "description": "Converts SinglePlacementGroup property to false for a existing virtual machine scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine scale set to create or update." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VMScaleSetConvertToSinglePlacementGroupInput" }, "description": "The input object for ConvertToSinglePlacementGroup API." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/setOrchestrationServiceState": { "post": { "tags": [ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_SetOrchestrationServiceState", "description": "Changes ServiceState property for a given service", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine scale set to create or update." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OrchestrationServiceStateInput" }, "description": "The input object for SetOrchestrationServiceState API." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSet_SetOrchestrationServiceState_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MaximumSet_Gen.json" }, "VirtualMachineScaleSet_SetOrchestrationServiceState_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}": { "put": { "tags": [ "VirtualMachineScaleSetVMExtensions" ], "operationId": "VirtualMachineScaleSetVMExtensions_CreateOrUpdate", "description": "The operation to create or update the VMSS VM extension.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "vmExtensionName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine extension." }, { "name": "extensionParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" }, "description": "Parameters supplied to the Create Virtual Machine Extension operation." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Create VirtualMachineScaleSet VM extension.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Create.json" } } }, "patch": { "tags": [ "VirtualMachineScaleSetVMExtensions" ], "operationId": "VirtualMachineScaleSetVMExtensions_Update", "description": "The operation to update the VMSS VM extension.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "vmExtensionName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine extension." }, { "name": "extensionParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionUpdate" }, "description": "Parameters supplied to the Update Virtual Machine Extension operation." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Update VirtualMachineScaleSet VM extension.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Update.json" } } }, "delete": { "tags": [ "VirtualMachineScaleSetVMExtensions" ], "operationId": "VirtualMachineScaleSetVMExtensions_Delete", "description": "The operation to delete the VMSS VM extension.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "vmExtensionName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine extension." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Delete VirtualMachineScaleSet VM extension.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Delete.json" } } }, "get": { "tags": [ "VirtualMachineScaleSetVMExtensions" ], "operationId": "VirtualMachineScaleSetVMExtensions_Get", "description": "The operation to get the VMSS VM extension.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "vmExtensionName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine extension." }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "The expand expression to apply on the operation." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get VirtualMachineScaleSet VM extension.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions": { "get": { "tags": [ "VirtualMachineScaleSetVMExtensions" ], "operationId": "VirtualMachineScaleSetVMExtensions_List", "description": "The operation to get all extensions of an instance in Virtual Machine Scaleset.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "The expand expression to apply on the operation." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "List extensions in Vmss instance.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_List.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimage": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_Reimage", "description": "Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "vmScaleSetVMReimageInput", "in": "body", "required": false, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" }, "description": "Parameters for the Reimaging Virtual machine in ScaleSet." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetVM_Reimage_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MaximumSet_Gen.json" }, "VirtualMachineScaleSetVM_Reimage_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimageall": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_ReimageAll", "description": "Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetVM_ReimageAll_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MaximumSet_Gen.json" }, "VirtualMachineScaleSetVM_ReimageAll_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/approveRollingUpgrade": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_ApproveRollingUpgrade", "description": "Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted", "headers": { "Location": { "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetVM_ApproveRollingUpgrade": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ApproveRollingUpgrade.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/deallocate": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_Deallocate", "description": "Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetVM_Deallocate_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MaximumSet_Gen.json" }, "VirtualMachineScaleSetVM_Deallocate_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}": { "put": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_Update", "description": "Updates a virtual machine of a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set where the extension should be create or updated." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVM" }, "description": "Parameters supplied to the Update Virtual Machine Scale Sets VM operation." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "x-ms-client-name": "IfMatch", "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "x-ms-client-name": "IfNoneMatch", "description": "Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported." } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVM" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVM" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetVM_Update_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MaximumSet_Gen.json" }, "VirtualMachineScaleSetVM_Update_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MinimumSet_Gen.json" } } }, "delete": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_Delete", "description": "Deletes a virtual machine from a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "forceDeletion", "in": "query", "required": false, "type": "boolean", "description": "Optional parameter to force delete a virtual machine from a VM scale set. (Feature in Preview)" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Force Delete a virtual machine from a VM scale set.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Delete_Force.json" } } }, "get": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_Get", "description": "Gets a virtual machine from a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.", "enum": [ "instanceView", "userData" ], "x-ms-enum": { "name": "InstanceViewTypes", "modelAsString": false } }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVM" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get VM scale set VM with UserData": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json" }, "Get VM scale set VM with VMSizeProperties": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView": { "get": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_GetInstanceView", "description": "Gets the status of a virtual machine from a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines": { "get": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_List", "description": "Gets a list of all virtual machines in a VM scale sets.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualMachineScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." }, { "name": "$expand", "in": "query", "required": false, "type": "string", "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VirtualMachineScaleSetVMListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM", "x-ms-examples": { "VirtualMachineScaleSetVM_List_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MaximumSet_Gen.json" }, "VirtualMachineScaleSetVM_List_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_PowerOff", "description": "Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges. Additionally, this operation is not allowed on a virtual machine that is being deallocated or already has been deallocated.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "skipShutdown", "in": "query", "required": false, "type": "boolean", "default": false, "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetVM_PowerOff_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MaximumSet_Gen.json" }, "VirtualMachineScaleSetVM_PowerOff_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_Restart", "description": "Restarts a virtual machine in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetVM_Restart_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MaximumSet_Gen.json" }, "VirtualMachineScaleSetVM_Restart_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_Start", "description": "Starts a virtual machine in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetVM_Start_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MaximumSet_Gen.json" }, "VirtualMachineScaleSetVM_Start_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_Redeploy", "description": "Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetVM_Redeploy_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MaximumSet_Gen.json" }, "VirtualMachineScaleSetVM_Redeploy_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/retrieveBootDiagnosticsData": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_RetrieveBootDiagnosticsData", "description": "The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "sasUriExpirationTimeInMinutes", "in": "query", "required": false, "type": "integer", "format": "int32", "description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. **Note:** If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./virtualMachine.json#/definitions/RetrieveBootDiagnosticsDataResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": false, "x-ms-examples": { "RetrieveBootDiagnosticsData of a virtual machine.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_RetrieveBootDiagnosticsData.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_PerformMaintenance", "description": "Performs maintenance on a virtual machine in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK" }, "202": { "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "VirtualMachineScaleSetVM_PerformMaintenance_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MaximumSet_Gen.json" }, "VirtualMachineScaleSetVM_PerformMaintenance_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/simulateEviction": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_SimulateEviction", "description": "The operation to simulate the eviction of spot virtual machine in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": false, "x-ms-examples": { "Simulate Eviction a virtual machine.": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_SimulateEviction.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/attachDetachDataDisks": { "post": { "tags": [ "VirtualMachineScaleSetVMs" ], "operationId": "VirtualMachineScaleSetVMs_AttachDetachDataDisks", "description": "Attach and detach data disks to/from a virtual machine in a VM scale set.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "vmScaleSetName", "in": "path", "required": true, "type": "string", "description": "The name of the VM scale set." }, { "name": "instanceId", "in": "path", "required": true, "type": "string", "description": "The instance ID of the virtual machine." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./computeRPCommon.json#/definitions/AttachDetachDataDisksRequest" }, "description": "Parameters supplied to the attach and detach data disks operation on a Virtual Machine Scale Sets VM." }, { "$ref": "../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../common-types/v1/common.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./computeRPCommon.json#/definitions/StorageProfile" } }, "202": { "description": "Accepted", "headers": { "Location": { "type": "string" } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../common-types/v1/common.json#/definitions/CloudError" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { "VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen.json" }, "VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen": { "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen.json" } } } } }, "definitions": { "VirtualMachineScaleSetVMExtension": { "properties": { "name": { "readOnly": true, "type": "string", "description": "The name of the extension." }, "type": { "readOnly": true, "type": "string", "description": "Resource type" }, "location": { "type": "string", "description": "The location of the extension.", "x-ms-mutability": [ "read", "create" ] }, "properties": { "x-ms-client-flatten": true, "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionProperties" } }, "allOf": [ { "$ref": "../../common-types/v1/common.json#/definitions/SubResourceReadOnly" } ], "description": "Describes a VMSS VM Extension.", "x-ms-azure-resource": true }, "VirtualMachineScaleSetVMExtensionUpdate": { "properties": { "name": { "readOnly": true, "type": "string", "description": "The name of the extension." }, "type": { "readOnly": true, "type": "string", "description": "Resource type" }, "properties": { "x-ms-client-flatten": true, "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionUpdateProperties" } }, "allOf": [ { "$ref": "../../common-types/v1/common.json#/definitions/SubResourceReadOnly" } ], "description": "Describes a VMSS VM Extension.", "x-ms-azure-resource": true }, "VirtualMachineScaleSetVMExtensionsListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" }, "description": "The list of VMSS VM extensions" } }, "description": "The List VMSS VM Extension operation response" }, "VirtualMachineScaleSetHardwareProfile": { "type": "object", "properties": { "vmSizeProperties": { "$ref": "./computeRPCommon.json#/definitions/VMSizeProperties", "description": "Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details." } }, "description": "Specifies the hardware settings for the virtual machine scale set." }, "AutomaticRepairsPolicy": { "properties": { "enabled": { "type": "boolean", "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." }, "gracePeriod": { "type": "string", "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)." }, "repairAction": { "type": "string", "description": "Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.", "enum": [ "Replace", "Restart", "Reimage" ], "x-ms-enum": { "name": "RepairAction", "modelAsString": true } } }, "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." }, "AutomaticOSUpgradePolicy": { "properties": { "enableAutomaticOSUpgrade": { "type": "boolean", "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." }, "disableAutomaticRollback": { "type": "boolean", "description": "Whether OS image rollback feature should be disabled. Default value is false." }, "useRollingUpgradePolicy": { "type": "boolean", "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS." }, "osRollingUpgradeDeferral": { "type": "boolean", "description": "Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call." } }, "description": "The configuration parameters used for performing automatic OS upgrade." }, "UpgradePolicy": { "properties": { "mode": { "type": "string", "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.", "enum": [ "Automatic", "Manual", "Rolling" ], "x-ms-enum": { "name": "UpgradeMode", "modelAsString": false } }, "rollingUpgradePolicy": { "$ref": "#/definitions/RollingUpgradePolicy", "description": "The configuration parameters used while performing a rolling upgrade." }, "automaticOSUpgradePolicy": { "$ref": "#/definitions/AutomaticOSUpgradePolicy", "description": "Configuration parameters used for performing automatic OS Upgrade." } }, "description": "Describes an upgrade policy - automatic, manual, or rolling." }, "ResiliencyPolicy": { "type": "object", "properties": { "resilientVMCreationPolicy": { "$ref": "#/definitions/ResilientVMCreationPolicy", "description": "The configuration parameters used while performing resilient VM creation." }, "resilientVMDeletionPolicy": { "$ref": "#/definitions/ResilientVMDeletionPolicy", "description": "The configuration parameters used while performing resilient VM deletion." } }, "description": "Describes an resiliency policy - resilientVMCreationPolicy and/or resilientVMDeletionPolicy." }, "ResilientVMCreationPolicy": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false." } }, "description": "The configuration parameters used while performing resilient VM creation." }, "ResilientVMDeletionPolicy": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false." } }, "description": "The configuration parameters used while performing resilient VM deletion." }, "RollingUpgradePolicy": { "properties": { "maxBatchInstancePercent": { "type": "integer", "format": "int32", "minimum": 5, "maximum": 100, "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." }, "maxUnhealthyInstancePercent": { "type": "integer", "format": "int32", "minimum": 5, "maximum": 100, "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." }, "maxUnhealthyUpgradedInstancePercent": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 100, "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." }, "pauseTimeBetweenBatches": { "type": "string", "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." }, "enableCrossZoneUpgrade": { "type": "boolean", "description": "Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size." }, "prioritizeUnhealthyInstances": { "type": "boolean", "description": "Upgrade all unhealthy instances in a scale set before any healthy instances." }, "rollbackFailedInstancesOnPolicyBreach": { "type": "boolean", "description": "Rollback failed instances to previous model if the Rolling Upgrade policy is violated." }, "maxSurge": { "type": "boolean", "description": "Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch." } }, "description": "The configuration parameters used while performing a rolling upgrade." }, "ScaleInPolicy": { "properties": { "rules": { "type": "array", "items": { "type": "string", "enum": [ "Default", "OldestVM", "NewestVM" ], "x-ms-enum": { "name": "VirtualMachineScaleSetScaleInRules", "modelAsString": true } }, "description": "The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

" }, "forceDeletion": { "type": "boolean", "description": "This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)" } }, "description": "Describes a scale-in policy for a virtual machine scale set." }, "SpotRestorePolicy": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints" }, "restoreTimeout": { "type": "string", "description": "Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances" } }, "description": "Specifies the Spot-Try-Restore properties for the virtual machine scale set. With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint." }, "PriorityMixPolicy": { "type": "object", "properties": { "baseRegularPriorityCount": { "type": "integer", "format": "int32", "minimum": 0, "description": "The base number of regular priority VMs that will be created in this scale set as it scales out." }, "regularPriorityPercentageAboveBase": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 100, "description": "The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority." } }, "description": "Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached." }, "SkuProfile": { "type": "object", "properties": { "vmSizes": { "type": "array", "items": { "$ref": "#/definitions/SkuProfileVMSize" }, "x-ms-identifiers": [ "name" ], "description": "Specifies the VM sizes for the virtual machine scale set." }, "allocationStrategy": { "type": "string", "description": "Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated.", "enum": [ "LowestPrice", "CapacityOptimized" ], "x-ms-enum": { "name": "AllocationStrategy", "modelAsString": true } } }, "description": "Specifies the sku profile for the virtual machine scale set. With this property the customer is able to specify a list of VM sizes and an allocation strategy." }, "SkuProfileVMSize": { "type": "object", "properties": { "name": { "type": "string", "description": "Specifies the name of the VM Size." } }, "description": "Specifies the VM Size." }, "OrchestrationMode": { "type": "string", "description": "Specifies the orchestration mode for the virtual machine scale set.", "enum": [ "Uniform", "Flexible" ], "x-ms-enum": { "name": "OrchestrationMode", "modelAsString": true } }, "VirtualMachineScaleSetIdentity": { "properties": { "principalId": { "readOnly": true, "type": "string", "description": "The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity." }, "tenantId": { "readOnly": true, "type": "string", "description": "The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity." }, "type": { "type": "string", "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.", "enum": [ "SystemAssigned", "UserAssigned", "SystemAssigned, UserAssigned", "None" ], "x-ms-enum": { "name": "ResourceIdentityType", "modelAsString": false } }, "userAssignedIdentities": { "$ref": "../../common-types/v1/common.json#/definitions/UserAssignedIdentities", "description": "The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "description": "Identity for the virtual machine scale set." }, "VirtualMachineScaleSetOSProfile": { "properties": { "computerNamePrefix": { "type": "string", "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." }, "adminUsername": { "type": "string", "description": "Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in \".\"

**Disallowed values:** \"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\".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters" }, "adminPassword": { "type": "string", "description": "Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])

**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)", "x-ms-secret": true }, "customData": { "type": "string", "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)" }, "windowsConfiguration": { "$ref": "./computeRPCommon.json#/definitions/WindowsConfiguration", "description": "Specifies Windows operating system settings on the virtual machine." }, "linuxConfiguration": { "$ref": "./computeRPCommon.json#/definitions/LinuxConfiguration", "description": "Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)." }, "secrets": { "type": "array", "items": { "$ref": "./computeRPCommon.json#/definitions/VaultSecretGroup" }, "x-ms-identifiers": [ "sourceVault/id" ], "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." }, "allowExtensionOperations": { "type": "boolean", "description": "Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set." }, "requireGuestProvisionSignal": { "type": "boolean", "description": "Optional property which must either be set to True or omitted." } }, "description": "Describes a virtual machine scale set OS profile." }, "VirtualMachineScaleSetUpdateOSProfile": { "properties": { "customData": { "type": "string", "description": "A base-64 encoded string of custom data." }, "windowsConfiguration": { "$ref": "./computeRPCommon.json#/definitions/WindowsConfiguration", "description": "The Windows Configuration of the OS profile." }, "linuxConfiguration": { "$ref": "./computeRPCommon.json#/definitions/LinuxConfiguration", "description": "The Linux Configuration of the OS profile." }, "secrets": { "type": "array", "items": { "$ref": "./computeRPCommon.json#/definitions/VaultSecretGroup" }, "x-ms-identifiers": [ "sourceVault/id" ], "description": "The List of certificates for addition to the VM." } }, "description": "Describes a virtual machine scale set OS profile." }, "VirtualMachineScaleSetManagedDiskParameters": { "properties": { "storageAccountType": { "$ref": "./computeRPCommon.json#/definitions/StorageAccountType", "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." }, "diskEncryptionSet": { "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSetParameters", "description": "Specifies the customer managed disk encryption set resource id for the managed disk." }, "securityProfile": { "$ref": "./computeRPCommon.json#/definitions/VMDiskSecurityProfile", "description": "Specifies the security profile for the managed disk." } }, "description": "Describes the parameters of a ScaleSet managed disk." }, "VirtualMachineScaleSetOSDisk": { "properties": { "name": { "type": "string", "description": "The disk name." }, "caching": { "$ref": "./computeRPCommon.json#/definitions/Caching", "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**" }, "writeAcceleratorEnabled": { "type": "boolean", "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." }, "createOption": { "$ref": "./computeRPCommon.json#/definitions/CreateOption", "description": "Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." }, "diffDiskSettings": { "$ref": "./computeRPCommon.json#/definitions/DiffDiskSettings", "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." }, "diskSizeGB": { "type": "integer", "format": "int32", "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023." }, "osType": { "type": "string", "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.**", "enum": [ "Windows", "Linux" ], "x-ms-enum": { "name": "OperatingSystemTypes", "modelAsString": false } }, "image": { "$ref": "./computeRPCommon.json#/definitions/VirtualHardDisk", "description": "Specifies information about the unmanaged user image to base the scale set on." }, "vhdContainers": { "type": "array", "items": { "type": "string" }, "description": "Specifies the container urls that are used to store operating system disks for the scale set." }, "managedDisk": { "description": "The managed disk parameters.", "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" }, "deleteOption": { "$ref": "./computeRPCommon.json#/definitions/DeleteOption", "description": "Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk." } }, "required": [ "createOption" ], "description": "Describes a virtual machine scale set operating system disk." }, "VirtualMachineScaleSetUpdateOSDisk": { "properties": { "caching": { "$ref": "./computeRPCommon.json#/definitions/Caching", "description": "The caching type." }, "writeAcceleratorEnabled": { "type": "boolean", "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." }, "diffDiskSettings": { "$ref": "./computeRPCommon.json#/definitions/DiffDiskSettings", "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." }, "diskSizeGB": { "type": "integer", "format": "int32", "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023" }, "image": { "$ref": "./computeRPCommon.json#/definitions/VirtualHardDisk", "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." }, "vhdContainers": { "type": "array", "items": { "type": "string" }, "description": "The list of virtual hard disk container uris." }, "managedDisk": { "description": "The managed disk parameters.", "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" }, "deleteOption": { "$ref": "./computeRPCommon.json#/definitions/DeleteOption", "description": "Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk." } }, "description": "Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk." }, "VirtualMachineScaleSetDataDisk": { "properties": { "name": { "type": "string", "description": "The disk name." }, "lun": { "type": "integer", "format": "int32", "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." }, "caching": { "$ref": "./computeRPCommon.json#/definitions/Caching", "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**" }, "writeAcceleratorEnabled": { "type": "boolean", "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." }, "createOption": { "$ref": "./computeRPCommon.json#/definitions/CreateOption", "description": "The create option." }, "diskSizeGB": { "type": "integer", "format": "int32", "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023." }, "managedDisk": { "description": "The managed disk parameters.", "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" }, "diskIOPSReadWrite": { "type": "integer", "format": "int64", "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." }, "diskMBpsReadWrite": { "type": "integer", "format": "int64", "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." }, "deleteOption": { "$ref": "./computeRPCommon.json#/definitions/DeleteOption", "description": "Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**." } }, "required": [ "lun", "createOption" ], "description": "Describes a virtual machine scale set data disk." }, "VirtualMachineScaleSetStorageProfile": { "properties": { "imageReference": { "$ref": "./computeRPCommon.json#/definitions/ImageReference", "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." }, "osDisk": { "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", "description": "Specifies information about the operating system disk used by the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." }, "dataDisks": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" }, "x-ms-identifiers": [ "name", "lun" ], "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." }, "diskControllerType": { "type": "string", "items": { "$ref": "./computeRPCommon.json#/definitions/DiskControllerType", "description": "Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01" } } }, "description": "Describes a virtual machine scale set storage profile." }, "VirtualMachineScaleSetUpdateStorageProfile": { "properties": { "imageReference": { "$ref": "./computeRPCommon.json#/definitions/ImageReference", "description": "The image reference." }, "osDisk": { "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk", "description": "The OS disk." }, "dataDisks": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" }, "x-ms-identifiers": [ "name", "lun" ], "description": "The data disks." }, "diskControllerType": { "type": "string", "items": { "$ref": "./computeRPCommon.json#/definitions/DiskControllerType", "description": "Specifies the disk controller type configured for the virtual machines in the scale set. **Note:** You need to deallocate the virtual machines in the scale set before updating its disk controller type based on the upgrade mode configured for the scale set. Minimum api-version: 2022-08-01." } } }, "description": "Describes a virtual machine scale set storage profile." }, "VirtualMachineScaleSetIPConfigurationProperties": { "properties": { "subnet": { "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", "description": "Specifies the identifier of the subnet." }, "primary": { "type": "boolean", "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." }, "publicIPAddressConfiguration": { "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", "description": "The publicIPAddressConfiguration." }, "privateIPAddressVersion": { "type": "string", "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", "enum": [ "IPv4", "IPv6" ], "x-ms-enum": { "name": "IPVersion", "modelAsString": true } }, "applicationGatewayBackendAddressPools": { "type": "array", "items": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource" }, "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." }, "applicationSecurityGroups": { "type": "array", "items": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource" }, "description": "Specifies an array of references to application security group." }, "loadBalancerBackendAddressPools": { "type": "array", "items": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource" }, "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." }, "loadBalancerInboundNatPools": { "type": "array", "items": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource" }, "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." } }, "description": "Describes a virtual machine scale set network profile's IP configuration properties." }, "VirtualMachineScaleSetUpdateIPConfigurationProperties": { "properties": { "subnet": { "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", "description": "The subnet." }, "primary": { "type": "boolean", "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." }, "publicIPAddressConfiguration": { "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfiguration", "description": "The publicIPAddressConfiguration." }, "privateIPAddressVersion": { "type": "string", "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", "enum": [ "IPv4", "IPv6" ], "x-ms-enum": { "name": "IPVersion", "modelAsString": true } }, "applicationGatewayBackendAddressPools": { "type": "array", "items": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource" }, "description": "The application gateway backend address pools." }, "applicationSecurityGroups": { "type": "array", "items": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource" }, "description": "Specifies an array of references to application security group." }, "loadBalancerBackendAddressPools": { "type": "array", "items": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource" }, "description": "The load balancer backend address pools." }, "loadBalancerInboundNatPools": { "type": "array", "items": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource" }, "description": "The load balancer inbound nat pools." } }, "description": "Describes a virtual machine scale set network profile's IP configuration properties." }, "VirtualMachineScaleSetIPConfiguration": { "properties": { "name": { "type": "string", "description": "The IP configuration name." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" } }, "required": [ "name" ], "description": "Describes a virtual machine scale set network profile's IP configuration." }, "VirtualMachineScaleSetUpdateIPConfiguration": { "properties": { "name": { "type": "string", "description": "The IP configuration name." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfigurationProperties" } }, "description": "Describes a virtual machine scale set network profile's IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network", "x-ms-azure-resource": true }, "VirtualMachineScaleSetNetworkConfigurationProperties": { "properties": { "primary": { "type": "boolean", "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." }, "enableAcceleratedNetworking": { "type": "boolean", "description": "Specifies whether the network interface is accelerated networking-enabled." }, "disableTcpStateTracking": { "type": "boolean", "description": "Specifies whether the network interface is disabled for tcp state tracking." }, "enableFpga": { "type": "boolean", "description": "Specifies whether the network interface is FPGA networking-enabled." }, "networkSecurityGroup": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource", "description": "The network security group." }, "dnsSettings": { "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", "description": "The dns settings to be applied on the network interfaces." }, "ipConfigurations": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" }, "x-ms-identifiers": [ "name" ], "description": "Specifies the IP configurations of the network interface." }, "enableIPForwarding": { "type": "boolean", "description": "Whether IP forwarding enabled on this NIC." }, "deleteOption": { "type": "string", "description": "Specify what happens to the network interface when the VM is deleted", "enum": [ "Delete", "Detach" ], "x-ms-enum": { "name": "DeleteOptions", "modelAsString": true } }, "auxiliaryMode": { "type": "string", "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface resource.", "enum": [ "None", "AcceleratedConnections", "Floating" ], "x-ms-enum": { "name": "NetworkInterfaceAuxiliaryMode", "modelAsString": true } }, "auxiliarySku": { "type": "string", "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface resource.", "enum": [ "None", "A1", "A2", "A4", "A8" ], "x-ms-enum": { "name": "NetworkInterfaceAuxiliarySku", "modelAsString": true } } }, "required": [ "ipConfigurations" ], "description": "Describes a virtual machine scale set network profile's IP configuration." }, "VirtualMachineScaleSetUpdateNetworkConfigurationProperties": { "properties": { "primary": { "type": "boolean", "description": "Whether this is a primary NIC on a virtual machine." }, "enableAcceleratedNetworking": { "type": "boolean", "description": "Specifies whether the network interface is accelerated networking-enabled." }, "disableTcpStateTracking": { "type": "boolean", "description": "Specifies whether the network interface is disabled for tcp state tracking." }, "enableFpga": { "type": "boolean", "description": "Specifies whether the network interface is FPGA networking-enabled." }, "networkSecurityGroup": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource", "description": "The network security group." }, "dnsSettings": { "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", "description": "The dns settings to be applied on the network interfaces." }, "ipConfigurations": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration" }, "x-ms-identifiers": [ "name" ], "description": "The virtual machine scale set IP Configuration." }, "enableIPForwarding": { "type": "boolean", "description": "Whether IP forwarding enabled on this NIC." }, "deleteOption": { "type": "string", "description": "Specify what happens to the network interface when the VM is deleted", "enum": [ "Delete", "Detach" ], "x-ms-enum": { "name": "DeleteOptions", "modelAsString": true } }, "auxiliaryMode": { "type": "string", "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface resource.", "enum": [ "None", "AcceleratedConnections", "Floating" ], "x-ms-enum": { "name": "NetworkInterfaceAuxiliaryMode", "modelAsString": true } }, "auxiliarySku": { "type": "string", "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface resource.", "enum": [ "None", "A1", "A2", "A4", "A8" ], "x-ms-enum": { "name": "NetworkInterfaceAuxiliarySku", "modelAsString": true } } }, "description": "Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration." }, "VirtualMachineScaleSetNetworkConfiguration": { "properties": { "name": { "type": "string", "description": "The network configuration name." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" } }, "required": [ "name" ], "description": "Describes a virtual machine scale set network profile's network configurations." }, "VirtualMachineScaleSetUpdateNetworkConfiguration": { "properties": { "name": { "type": "string", "description": "The network configuration name." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfigurationProperties" } }, "description": "Describes a virtual machine scale set network profile's network configurations.", "x-ms-azure-resource": true }, "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { "properties": { "dnsServers": { "type": "array", "items": { "type": "string" }, "description": "List of DNS servers IP addresses" } }, "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { "properties": { "domainNameLabel": { "type": "string", "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" }, "domainNameLabelScope": { "type": "string", "description": "The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created", "enum": [ "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", "NoReuse" ], "x-ms-enum": { "name": "DomainNameLabelScopeTypes", "modelAsString": true } } }, "required": [ "domainNameLabel" ], "description": "Describes a virtual machines scale sets network configuration's DNS settings." }, "VirtualMachineScaleSetIpTag": { "properties": { "ipTagType": { "type": "string", "description": "IP tag type. Example: FirstPartyUsage." }, "tag": { "type": "string", "description": "IP tag associated with the public IP. Example: SQL, Storage etc." } }, "description": "Contains the IP tag associated with the public IP address." }, "VirtualMachineScaleSetPublicIPAddressConfiguration": { "properties": { "name": { "type": "string", "description": "The publicIP address configuration name." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" }, "sku": { "$ref": "./computeRPCommon.json#/definitions/PublicIPAddressSku" } }, "required": [ "name" ], "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration": { "properties": { "name": { "type": "string", "description": "The publicIP address configuration name." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties" } }, "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { "properties": { "idleTimeoutInMinutes": { "type": "integer", "format": "int32", "description": "The idle timeout of the public IP address." }, "dnsSettings": { "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", "description": "The dns settings to be applied on the publicIP addresses ." }, "ipTags": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetIpTag" }, "x-ms-identifiers": [], "description": "The list of IP tags associated with the public IP address." }, "publicIPPrefix": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource", "description": "The PublicIPPrefix from which to allocate publicIP addresses." }, "publicIPAddressVersion": { "type": "string", "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", "enum": [ "IPv4", "IPv6" ], "x-ms-enum": { "name": "IPVersion", "modelAsString": true } }, "deleteOption": { "type": "string", "description": "Specify what happens to the public IP when the VM is deleted", "enum": [ "Delete", "Detach" ], "x-ms-enum": { "name": "DeleteOptions", "modelAsString": true } } }, "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, "VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties": { "properties": { "idleTimeoutInMinutes": { "type": "integer", "format": "int32", "description": "The idle timeout of the public IP address." }, "dnsSettings": { "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", "description": "The dns settings to be applied on the publicIP addresses ." }, "publicIPPrefix": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource", "description": "The PublicIPPrefix from which to allocate publicIP addresses." }, "deleteOption": { "type": "string", "description": "Specify what happens to the public IP when the VM is deleted", "enum": [ "Delete", "Detach" ], "x-ms-enum": { "name": "DeleteOptions", "modelAsString": true } } }, "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" }, "VirtualMachineScaleSetNetworkProfile": { "properties": { "healthProbe": { "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." }, "networkInterfaceConfigurations": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" }, "x-ms-identifiers": [], "description": "The list of network configurations." }, "networkApiVersion": { "type": "string", "description": "specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'", "enum": [ "2020-11-01" ], "x-ms-enum": { "name": "NetworkApiVersion", "modelAsString": true } } }, "description": "Describes a virtual machine scale set network profile." }, "VirtualMachineScaleSetUpdateNetworkProfile": { "properties": { "healthProbe": { "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." }, "networkInterfaceConfigurations": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfiguration" }, "x-ms-identifiers": [ "name" ], "description": "The list of network configurations." }, "networkApiVersion": { "type": "string", "description": "specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible'", "enum": [ "2020-11-01" ], "x-ms-enum": { "name": "NetworkApiVersion", "modelAsString": true } } }, "description": "Describes a virtual machine scale set network profile." }, "VirtualMachineScaleSetExtensionProperties": { "properties": { "forceUpdateTag": { "type": "string", "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." }, "publisher": { "type": "string", "description": "The name of the extension handler publisher." }, "type": { "type": "string", "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." }, "typeHandlerVersion": { "type": "string", "description": "Specifies the version of the script handler." }, "autoUpgradeMinorVersion": { "type": "boolean", "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." }, "enableAutomaticUpgrade": { "type": "boolean", "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." }, "settings": { "type": "object", "description": "Json formatted public settings for the extension." }, "protectedSettings": { "type": "object", "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." }, "provisioningState": { "readOnly": true, "type": "string", "description": "The provisioning state, which only appears in the response." }, "provisionAfterExtensions": { "type": "array", "items": { "type": "string" }, "description": "Collection of extension names after which this extension needs to be provisioned." }, "suppressFailures": { "type": "boolean", "description": "Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false." }, "protectedSettingsFromKeyVault": { "$ref": "./computeRPCommon.json#/definitions/KeyVaultSecretReference", "description": "The extensions protected settings that are passed by reference, and consumed from key vault" } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." }, "VirtualMachineScaleSetExtension": { "properties": { "name": { "type": "string", "description": "The name of the extension." }, "type": { "readOnly": true, "type": "string", "description": "Resource type" }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" } }, "allOf": [ { "$ref": "../../common-types/v1/common.json#/definitions/SubResourceReadOnly" } ], "description": "Describes a Virtual Machine Scale Set Extension." }, "VirtualMachineScaleSetExtensionUpdate": { "properties": { "name": { "readOnly": true, "type": "string", "description": "The name of the extension." }, "type": { "readOnly": true, "type": "string", "description": "Resource type" }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" } }, "allOf": [ { "$ref": "../../common-types/v1/common.json#/definitions/SubResourceReadOnly" } ], "description": "Describes a Virtual Machine Scale Set Extension.", "x-ms-azure-resource": true }, "VirtualMachineScaleSetExtensionListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetExtension" }, "description": "The list of VM scale set extensions." }, "nextLink": { "type": "string", "description": "The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions." } }, "required": [ "value" ], "description": "The List VM scale set extension operation response." }, "VirtualMachineScaleSetExtensionProfile": { "properties": { "extensions": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetExtension" }, "description": "The virtual machine scale set child extension resources." }, "extensionsTimeBudget": { "type": "string", "description": "Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01." } }, "description": "Describes a virtual machine scale set extension profile." }, "VirtualMachineScaleSetVMProfile": { "properties": { "osProfile": { "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", "description": "Specifies the operating system settings for the virtual machines in the scale set." }, "storageProfile": { "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", "description": "Specifies the storage settings for the virtual machine disks." }, "networkProfile": { "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." }, "securityProfile": { "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", "description": "Specifies the Security related profile settings for the virtual machines in the scale set." }, "diagnosticsProfile": { "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15." }, "extensionProfile": { "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." }, "licenseType": { "type": "string", "description": "Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15" }, "priority": { "$ref": "./computeRPCommon.json#/definitions/priority", "description": "Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview." }, "evictionPolicy": { "$ref": "./computeRPCommon.json#/definitions/evictionPolicy", "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." }, "billingProfile": { "$ref": "./computeRPCommon.json#/definitions/BillingProfile", "description": "Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01." }, "scheduledEventsProfile": { "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsProfile", "description": "Specifies Scheduled Event related configurations." }, "userData": { "type": "string", "description": "UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01." }, "capacityReservation": { "$ref": "./computeRPCommon.json#/definitions/CapacityReservationProfile", "description": "Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01." }, "applicationProfile": { "$ref": "./computeRPCommon.json#/definitions/ApplicationProfile", "description": "Specifies the gallery applications that should be made available to the VM/VMSS" }, "hardwareProfile": { "$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile", "description": "Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01." }, "serviceArtifactReference": { "$ref": "#/definitions/ServiceArtifactReference", "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01" }, "securityPostureReference": { "$ref": "#/definitions/SecurityPostureReference", "description": "Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01" }, "timeCreated": { "readOnly": true, "type": "string", "format": "date-time", "description": "Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01." } }, "description": "Describes a virtual machine scale set virtual machine profile." }, "VirtualMachineScaleSetUpdateVMProfile": { "properties": { "osProfile": { "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSProfile", "description": "The virtual machine scale set OS profile." }, "storageProfile": { "$ref": "#/definitions/VirtualMachineScaleSetUpdateStorageProfile", "description": "The virtual machine scale set storage profile." }, "networkProfile": { "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile", "description": "The virtual machine scale set network profile." }, "securityPostureReference": { "$ref": "#/definitions/SecurityPostureReferenceUpdate", "description": "The virtual machine scale set security posture reference." }, "securityProfile": { "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", "description": "The virtual machine scale set Security profile" }, "diagnosticsProfile": { "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", "description": "The virtual machine scale set diagnostics profile." }, "extensionProfile": { "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", "description": "The virtual machine scale set extension profile." }, "licenseType": { "type": "string", "description": "The license type, which is for bring your own license scenario." }, "billingProfile": { "$ref": "./computeRPCommon.json#/definitions/BillingProfile", "description": "Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01." }, "scheduledEventsProfile": { "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsProfile", "description": "Specifies Scheduled Event related configurations." }, "userData": { "type": "string", "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

Minimum api-version: 2021-03-01" }, "hardwareProfile": { "$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile", "description": "Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01." } }, "description": "Describes a virtual machine scale set virtual machine profile." }, "VirtualMachineScaleSetProperties": { "properties": { "upgradePolicy": { "$ref": "#/definitions/UpgradePolicy", "description": "The upgrade policy." }, "scheduledEventsPolicy": { "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsPolicy", "description": "The ScheduledEventsPolicy." }, "automaticRepairsPolicy": { "$ref": "#/definitions/AutomaticRepairsPolicy", "description": "Policy for automatic repairs." }, "virtualMachineProfile": { "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", "description": "The virtual machine profile." }, "provisioningState": { "readOnly": true, "type": "string", "description": "The provisioning state, which only appears in the response." }, "overprovision": { "type": "boolean", "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." }, "doNotRunExtensionsOnOverprovisionedVMs": { "type": "boolean", "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." }, "uniqueId": { "readOnly": true, "type": "string", "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set." }, "singlePlacementGroup": { "type": "boolean", "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true." }, "zoneBalance": { "type": "boolean", "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set." }, "platformFaultDomainCount": { "type": "integer", "format": "int32", "description": "Fault Domain count for each placement group." }, "proximityPlacementGroup": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource", "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01." }, "hostGroup": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource", "description": "Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01." }, "additionalCapabilities": { "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities", "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." }, "scaleInPolicy": { "$ref": "#/definitions/ScaleInPolicy", "description": "Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set." }, "orchestrationMode": { "$ref": "#/definitions/OrchestrationMode", "description": "Specifies the orchestration mode for the virtual machine scale set." }, "spotRestorePolicy": { "$ref": "#/definitions/SpotRestorePolicy", "description": "Specifies the Spot Restore properties for the virtual machine scale set." }, "priorityMixPolicy": { "$ref": "#/definitions/PriorityMixPolicy", "description": "Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance." }, "timeCreated": { "readOnly": true, "type": "string", "format": "date-time", "description": "Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01." }, "constrainedMaximumCapacity": { "type": "boolean", "description": "Optional property which must either be set to True or omitted." }, "resiliencyPolicy": { "$ref": "#/definitions/ResiliencyPolicy", "description": "Policy for Resiliency" }, "zonalPlatformFaultDomainAlignMode": { "$ref": "#/definitions/ZonalPlatformFaultDomainAlignMode", "description": "Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count." }, "skuProfile": { "$ref": "#/definitions/SkuProfile", "description": "Specifies the sku profile for the virtual machine scale set." } }, "description": "Describes the properties of a Virtual Machine Scale Set." }, "VirtualMachineScaleSetUpdateProperties": { "properties": { "upgradePolicy": { "$ref": "#/definitions/UpgradePolicy", "description": "The upgrade policy." }, "automaticRepairsPolicy": { "$ref": "#/definitions/AutomaticRepairsPolicy", "description": "Policy for automatic repairs." }, "virtualMachineProfile": { "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", "description": "The virtual machine profile." }, "overprovision": { "type": "boolean", "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." }, "doNotRunExtensionsOnOverprovisionedVMs": { "type": "boolean", "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." }, "singlePlacementGroup": { "type": "boolean", "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true." }, "additionalCapabilities": { "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities", "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." }, "scaleInPolicy": { "$ref": "#/definitions/ScaleInPolicy", "description": "Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set." }, "proximityPlacementGroup": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource", "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01." }, "priorityMixPolicy": { "$ref": "#/definitions/PriorityMixPolicy", "description": "Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance." }, "spotRestorePolicy": { "$ref": "#/definitions/SpotRestorePolicy", "description": "Specifies the Spot Restore properties for the virtual machine scale set." }, "resiliencyPolicy": { "$ref": "#/definitions/ResiliencyPolicy", "description": "Policy for Resiliency" }, "zonalPlatformFaultDomainAlignMode": { "$ref": "#/definitions/ZonalPlatformFaultDomainAlignMode", "description": "Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count." }, "skuProfile": { "$ref": "#/definitions/SkuProfile", "description": "Specifies the sku profile for the virtual machine scale set." } }, "description": "Describes the properties of a Virtual Machine Scale Set." }, "VirtualMachineScaleSet": { "properties": { "sku": { "$ref": "./computeRPCommon.json#/definitions/Sku", "description": "The virtual machine scale set sku." }, "plan": { "$ref": "./computeRPCommon.json#/definitions/Plan", "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineScaleSetProperties" }, "identity": { "$ref": "#/definitions/VirtualMachineScaleSetIdentity", "description": "The identity of the virtual machine scale set, if configured." }, "zones": { "type": "array", "items": { "type": "string" }, "description": "The virtual machine scale set zones." }, "extendedLocation": { "$ref": "../../common-types/v1/common.json#/definitions/ExtendedLocation", "description": "The extended location of the Virtual Machine Scale Set." }, "etag": { "readOnly": true, "type": "string", "description": "Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates" } }, "allOf": [ { "$ref": "../../common-types/v1/common.json#/definitions/Resource" } ], "description": "Describes a Virtual Machine Scale Set." }, "VirtualMachineScaleSetVMReimageParameters": { "type": "object", "properties": { "forceUpdateOSDiskForEphemeral": { "type": "boolean", "description": "Parameter to force update ephemeral OS disk for a virtual machine scale set VM" } }, "allOf": [ { "$ref": "./virtualMachine.json#/definitions/VirtualMachineReimageParameters" } ], "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." }, "VirtualMachineScaleSetReimageParameters": { "properties": { "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." } }, "allOf": [ { "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" } ], "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." }, "VirtualMachineScaleSetUpdate": { "properties": { "sku": { "$ref": "./computeRPCommon.json#/definitions/Sku", "description": "The virtual machine scale set sku." }, "plan": { "$ref": "./computeRPCommon.json#/definitions/Plan", "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineScaleSetUpdateProperties" }, "identity": { "$ref": "#/definitions/VirtualMachineScaleSetIdentity", "description": "The identity of the virtual machine scale set, if configured." }, "zones": { "type": "array", "items": { "type": "string" }, "description": "The virtual machine scale set zones." } }, "allOf": [ { "$ref": "./computeRPCommon.json#/definitions/UpdateResource" } ], "description": "Describes a Virtual Machine Scale Set." }, "VirtualMachineScaleSetVMInstanceIDs": { "properties": { "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." } }, "description": "Specifies a list of virtual machine instance IDs from the VM scale set." }, "VirtualMachineScaleSetVMInstanceRequiredIDs": { "properties": { "instanceIds": { "type": "array", "items": { "type": "string" }, "description": "The virtual machine scale set instance ids." } }, "required": [ "instanceIds" ], "description": "Specifies a list of virtual machine instance IDs from the VM scale set." }, "VirtualMachineStatusCodeCount": { "properties": { "code": { "readOnly": true, "type": "string", "description": "The instance view status code." }, "count": { "readOnly": true, "type": "integer", "format": "int32", "description": "The number of instances having a particular status code." } }, "description": "The status code and count of the virtual machine scale set instance view status summary." }, "VirtualMachineScaleSetInstanceViewStatusesSummary": { "properties": { "statusesSummary": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/VirtualMachineStatusCodeCount" }, "x-ms-identifiers": [], "description": "The extensions information." } }, "description": "Instance view statuses summary for virtual machines of a virtual machine scale set." }, "VirtualMachineScaleSetVMExtensionsSummary": { "properties": { "name": { "readOnly": true, "type": "string", "description": "The extension name." }, "statusesSummary": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/VirtualMachineStatusCodeCount" }, "x-ms-identifiers": [], "description": "The extensions information." } }, "description": "Extensions summary for virtual machines of a virtual machine scale set." }, "OrchestrationServiceSummary": { "properties": { "serviceName": { "type": "string", "readOnly": true, "description": "The name of the service.", "enum": [ "AutomaticRepairs" ], "x-ms-enum": { "name": "OrchestrationServiceNames", "modelAsString": true } }, "serviceState": { "type": "string", "readOnly": true, "description": "The current state of the service.", "enum": [ "NotRunning", "Running", "Suspended" ], "x-ms-enum": { "name": "OrchestrationServiceState", "modelAsString": true } } }, "description": "Summary for an orchestration service of a virtual machine scale set." }, "VirtualMachineScaleSetInstanceView": { "properties": { "virtualMachine": { "$ref": "#/definitions/VirtualMachineScaleSetInstanceViewStatusesSummary", "readOnly": true, "description": "The instance view status summary for the virtual machine scale set." }, "extensions": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary" }, "x-ms-identifiers": [ "name" ], "description": "The extensions information." }, "statuses": { "type": "array", "items": { "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" }, "x-ms-identifiers": [], "description": "The resource status information." }, "orchestrationServices": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/OrchestrationServiceSummary" }, "x-ms-identifiers": [ "serviceName" ], "description": "The orchestration services information." } }, "description": "The instance view of a virtual machine scale set." }, "VirtualMachineScaleSetListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSet" }, "description": "The list of virtual machine scale sets." }, "nextLink": { "type": "string", "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS." } }, "required": [ "value" ], "description": "The List Virtual Machine operation response." }, "VirtualMachineScaleSetListWithLinkResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSet" }, "description": "The list of virtual machine scale sets." }, "nextLink": { "type": "string", "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets." } }, "required": [ "value" ], "description": "The List Virtual Machine operation response." }, "VirtualMachineScaleSetSkuCapacity": { "properties": { "minimum": { "readOnly": true, "type": "integer", "format": "int64", "description": "The minimum capacity." }, "maximum": { "readOnly": true, "type": "integer", "format": "int64", "description": "The maximum capacity that can be set." }, "defaultCapacity": { "readOnly": true, "type": "integer", "format": "int64", "description": "The default capacity." }, "scaleType": { "readOnly": true, "type": "string", "description": "The scale type applicable to the sku.", "enum": [ "Automatic", "None" ], "x-ms-enum": { "name": "VirtualMachineScaleSetSkuScaleType", "modelAsString": false } } }, "description": "Describes scaling information of a sku." }, "VirtualMachineScaleSetSku": { "properties": { "resourceType": { "readOnly": true, "type": "string", "description": "The type of resource the sku applies to." }, "sku": { "$ref": "./computeRPCommon.json#/definitions/Sku", "readOnly": true, "description": "The Sku." }, "capacity": { "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity", "readOnly": true, "description": "Specifies the number of virtual machines in the scale set." } }, "description": "Describes an available virtual machine scale set sku." }, "VirtualMachineScaleSetListSkusResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetSku" }, "x-ms-identifiers": [ "resourceType", "sku/name" ], "description": "The list of skus available for the virtual machine scale set." }, "nextLink": { "type": "string", "description": "The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus." } }, "required": [ "value" ], "description": "The Virtual Machine Scale Set List Skus operation response." }, "UpgradeOperationHistoryStatus": { "properties": { "code": { "type": "string", "readOnly": true, "description": "Code indicating the current status of the upgrade.", "enum": [ "RollingForward", "Cancelled", "Completed", "Faulted" ], "x-ms-enum": { "name": "UpgradeState", "modelAsString": false } }, "startTime": { "readOnly": true, "type": "string", "format": "date-time", "description": "Start time of the upgrade." }, "endTime": { "readOnly": true, "type": "string", "format": "date-time", "description": "End time of the upgrade." } }, "description": "Information about the current running state of the overall upgrade." }, "UpgradeOperationHistoricalStatusInfoProperties": { "properties": { "runningStatus": { "$ref": "#/definitions/UpgradeOperationHistoryStatus", "readOnly": true, "description": "Information about the overall status of the upgrade operation." }, "progress": { "$ref": "#/definitions/RollingUpgradeProgressInfo", "readOnly": true, "description": "Counts of the VMs in each state." }, "error": { "$ref": "../../common-types/v1/common.json#/definitions/ApiError", "readOnly": true, "description": "Error Details for this upgrade if there are any." }, "startedBy": { "readOnly": true, "type": "string", "description": "Invoker of the Upgrade Operation", "enum": [ "Unknown", "User", "Platform" ], "x-ms-enum": { "name": "UpgradeOperationInvoker", "modelAsString": false } }, "targetImageReference": { "$ref": "./computeRPCommon.json#/definitions/ImageReference", "readOnly": true, "description": "Image Reference details" }, "rollbackInfo": { "$ref": "./computeRPCommon.json#/definitions/RollbackStatusInfo", "readOnly": true, "description": "Information about OS rollback if performed" } }, "description": "Describes each OS upgrade on the Virtual Machine Scale Set." }, "UpgradeOperationHistoricalStatusInfo": { "properties": { "properties": { "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfoProperties", "readOnly": true, "description": "Information about the properties of the upgrade operation." }, "type": { "readOnly": true, "type": "string", "description": "Resource type" }, "location": { "readOnly": true, "type": "string", "description": "Resource location" } }, "description": "Virtual Machine Scale Set OS Upgrade History operation response." }, "VirtualMachineScaleSetListOSUpgradeHistory": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo" }, "x-ms-identifiers": [ "type", "location" ], "description": "The list of OS upgrades performed on the virtual machine scale set." }, "nextLink": { "type": "string", "description": "The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades." } }, "required": [ "value" ], "description": "List of Virtual Machine Scale Set OS Upgrade History operation response." }, "VirtualMachineScaleSetVMProperties": { "properties": { "latestModelApplied": { "readOnly": true, "type": "boolean", "description": "Specifies whether the latest model has been applied to the virtual machine." }, "vmId": { "readOnly": true, "type": "string", "description": "Azure VM unique ID." }, "instanceView": { "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", "readOnly": true, "description": "The virtual machine instance view." }, "hardwareProfile": { "$ref": "./computeRPCommon.json#/definitions/HardwareProfile", "description": "Specifies the hardware settings for the virtual machine." }, "storageProfile": { "$ref": "./computeRPCommon.json#/definitions/StorageProfile", "description": "Specifies the storage settings for the virtual machine disks." }, "additionalCapabilities": { "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities", "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." }, "osProfile": { "$ref": "./computeRPCommon.json#/definitions/OSProfile", "description": "Specifies the operating system settings for the virtual machine." }, "securityProfile": { "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", "description": "Specifies the Security related profile settings for the virtual machine." }, "networkProfile": { "$ref": "./computeRPCommon.json#/definitions/NetworkProfile", "description": "Specifies the network interfaces of the virtual machine." }, "networkProfileConfiguration": { "$ref": "#/definitions/VirtualMachineScaleSetVMNetworkProfileConfiguration", "description": "Specifies the network profile configuration of the virtual machine." }, "diagnosticsProfile": { "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15." }, "availabilitySet": { "$ref": "../../common-types/v1/common.json#/definitions/SubResource", "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, "type": "string", "description": "The provisioning state, which only appears in the response." }, "licenseType": { "type": "string", "description": "Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15" }, "modelDefinitionApplied": { "readOnly": true, "type": "string", "description": "Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine." }, "protectionPolicy": { "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy", "description": "Specifies the protection policy of the virtual machine." }, "userData": { "type": "string", "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01" }, "timeCreated": { "readOnly": true, "type": "string", "format": "date-time", "description": "Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01." } }, "description": "Describes the properties of a virtual machine scale set virtual machine." }, "VirtualMachineScaleSetVM": { "properties": { "instanceId": { "readOnly": true, "type": "string", "description": "The virtual machine instance ID." }, "sku": { "$ref": "./computeRPCommon.json#/definitions/Sku", "readOnly": true, "description": "The virtual machine SKU." }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" }, "plan": { "$ref": "./computeRPCommon.json#/definitions/Plan", "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." }, "resources": { "readOnly": true, "type": "array", "items": { "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtension" }, "description": "The virtual machine child extension resources." }, "zones": { "readOnly": true, "type": "array", "items": { "type": "string" }, "description": "The virtual machine zones." }, "identity": { "$ref": "./virtualMachine.json#/definitions/VirtualMachineIdentity", "description": "The identity of the virtual machine, if configured." }, "etag": { "readOnly": true, "type": "string", "description": "Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates." } }, "allOf": [ { "$ref": "../../common-types/v1/common.json#/definitions/Resource" } ], "description": "Describes a virtual machine scale set virtual machine." }, "VirtualMachineScaleSetVMInstanceView": { "properties": { "platformUpdateDomain": { "type": "integer", "format": "int32", "description": "The Update Domain count." }, "platformFaultDomain": { "type": "integer", "format": "int32", "description": "The Fault Domain count." }, "rdpThumbPrint": { "type": "string", "description": "The Remote desktop certificate thumbprint." }, "vmAgent": { "$ref": "./virtualMachine.json#/definitions/VirtualMachineAgentInstanceView", "description": "The VM Agent running on the virtual machine." }, "maintenanceRedeployStatus": { "$ref": "./computeRPCommon.json#/definitions/MaintenanceRedeployStatus", "description": "The Maintenance Operation status on the virtual machine." }, "disks": { "type": "array", "items": { "$ref": "./computeRPCommon.json#/definitions/DiskInstanceView" }, "x-ms-identifiers": [ "name" ], "description": "The disks information." }, "extensions": { "type": "array", "items": { "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionInstanceView" }, "x-ms-identifiers": [ "name", "type" ], "description": "The extensions information." }, "vmHealth": { "readOnly": true, "$ref": "./virtualMachine.json#/definitions/VirtualMachineHealthStatus", "description": "The health status for the VM." }, "bootDiagnostics": { "$ref": "./computeRPCommon.json#/definitions/BootDiagnosticsInstanceView", "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor." }, "statuses": { "type": "array", "items": { "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" }, "x-ms-identifiers": [], "description": "The resource status information." }, "assignedHost": { "type": "string", "readOnly": true, "description": "Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01." }, "placementGroupId": { "type": "string", "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId." }, "computerName": { "type": "string", "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

**Max-length (Windows):** 15 characters

**Max-length (Linux):** 64 characters.

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, "osName": { "type": "string", "description": "The Operating System running on the hybrid machine." }, "osVersion": { "type": "string", "description": "The version of Operating System running on the hybrid machine." }, "hyperVGeneration": { "type": "string", "description": "The hypervisor generation of the Virtual Machine [V1, V2]", "enum": [ "V1", "V2" ], "x-ms-enum": { "name": "HyperVGeneration", "modelAsString": true } } }, "description": "The instance view of a virtual machine scale set VM." }, "VirtualMachineScaleSetVMNetworkProfileConfiguration": { "properties": { "networkInterfaceConfigurations": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" }, "x-ms-identifiers": [ "name" ], "description": "The list of network configurations." } }, "description": "Describes a virtual machine scale set VM network profile." }, "VirtualMachineScaleSetVMProtectionPolicy": { "properties": { "protectFromScaleIn": { "type": "boolean", "description": "Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation." }, "protectFromScaleSetActions": { "type": "boolean", "description": "Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM." } }, "description": "The protection policy of a virtual machine scale set VM." }, "VirtualMachineScaleSetVMListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualMachineScaleSetVM" }, "description": "The list of virtual machine scale sets VMs." }, "nextLink": { "type": "string", "description": "The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs" } }, "required": [ "value" ], "description": "The List Virtual Machine Scale Set VMs operation response." }, "RollingUpgradeStatusInfo": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RollingUpgradeStatusInfoProperties" } }, "allOf": [ { "$ref": "../../common-types/v1/common.json#/definitions/Resource" } ], "description": "The status of the latest virtual machine scale set rolling upgrade." }, "RollingUpgradeStatusInfoProperties": { "properties": { "policy": { "readOnly": true, "$ref": "#/definitions/RollingUpgradePolicy", "description": "The rolling upgrade policies applied for this upgrade." }, "runningStatus": { "readOnly": true, "$ref": "#/definitions/RollingUpgradeRunningStatus", "description": "Information about the current running state of the overall upgrade." }, "progress": { "readOnly": true, "$ref": "#/definitions/RollingUpgradeProgressInfo", "description": "Information about the number of virtual machine instances in each upgrade state." }, "error": { "readOnly": true, "$ref": "../../common-types/v1/common.json#/definitions/ApiError", "description": "Error details for this upgrade, if there are any." } }, "description": "The status of the latest virtual machine scale set rolling upgrade." }, "RollingUpgradeRunningStatus": { "properties": { "code": { "type": "string", "readOnly": true, "description": "Code indicating the current status of the upgrade.", "enum": [ "RollingForward", "Cancelled", "Completed", "Faulted" ], "x-ms-enum": { "name": "RollingUpgradeStatusCode", "modelAsString": false } }, "startTime": { "readOnly": true, "type": "string", "format": "date-time", "description": "Start time of the upgrade." }, "lastAction": { "type": "string", "readOnly": true, "description": "The last action performed on the rolling upgrade.", "enum": [ "Start", "Cancel" ], "x-ms-enum": { "name": "RollingUpgradeActionType", "modelAsString": false } }, "lastActionTime": { "readOnly": true, "type": "string", "format": "date-time", "description": "Last action time of the upgrade." } }, "description": "Information about the current running state of the overall upgrade." }, "RollingUpgradeProgressInfo": { "properties": { "successfulInstanceCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "The number of instances that have been successfully upgraded." }, "failedInstanceCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "The number of instances that have failed to be upgraded successfully." }, "inProgressInstanceCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "The number of instances that are currently being upgraded." }, "pendingInstanceCount": { "readOnly": true, "type": "integer", "format": "int32", "description": "The number of instances that have not yet begun to be upgraded." } }, "description": "Information about the number of virtual machine instances in each upgrade state." }, "RecoveryWalkResponse": { "properties": { "walkPerformed": { "type": "boolean", "readOnly": true, "description": "Whether the recovery walk was performed" }, "nextPlatformUpdateDomain": { "type": "integer", "readOnly": true, "description": "The next update domain that needs to be walked. Null means walk spanning all update domains has been completed" } }, "description": "Response after calling a manual recovery walk" }, "VMScaleSetConvertToSinglePlacementGroupInput": { "properties": { "activePlacementGroupId": { "type": "string", "description": "Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances." } } }, "OrchestrationServiceStateInput": { "properties": { "serviceName": { "type": "string", "description": "The name of the service.", "enum": [ "AutomaticRepairs" ], "x-ms-enum": { "name": "OrchestrationServiceNames", "modelAsString": true } }, "action": { "type": "string", "description": "The action to be performed.", "enum": [ "Resume", "Suspend" ], "x-ms-enum": { "name": "OrchestrationServiceStateAction", "modelAsString": true } } }, "description": "The input for OrchestrationServiceState", "required": [ "serviceName", "action" ] }, "ServiceArtifactReference": { "type": "object", "properties": { "id": { "type": "string", "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" } }, "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01" }, "SecurityPostureReference": { "type": "object", "properties": { "id": { "type": "string", "description": "The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest" }, "excludeExtensions": { "type": "array", "items": { "type": "string" }, "description": "The list of virtual machine extension names to exclude when applying the security posture." }, "isOverridable": { "type": "boolean", "description": "Whether the security posture can be overridden by the user." } }, "description": "Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01", "required": [ "id" ] }, "SecurityPostureReferenceUpdate": { "type": "object", "properties": { "id": { "type": "string", "description": "The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest" }, "excludeExtensions": { "type": "array", "items": { "type": "string" }, "description": "The list of virtual machine extension names to exclude when applying the security posture." }, "isOverridable": { "type": "boolean", "description": "Whether the security posture can be overridden by the user." } }, "description": "Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01" }, "ZonalPlatformFaultDomainAlignMode": { "type": "string", "description": "Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.", "enum": [ "Aligned", "Unaligned" ], "x-ms-enum": { "name": "ZonalPlatformFaultDomainAlignMode", "modelAsString": true } } } }