ArmComputeModelFactory.VirtualMachinePatch Method

Definition

Initializes a new instance of VirtualMachinePatch.

public static Azure.ResourceManager.Compute.Models.VirtualMachinePatch VirtualMachinePatch (System.Collections.Generic.IDictionary<string,string> tags = default, Azure.ResourceManager.Compute.Models.ComputePlan plan = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, System.Collections.Generic.IEnumerable<string> zones = default, Azure.ResourceManager.Compute.Models.VirtualMachineHardwareProfile hardwareProfile = default, Azure.ResourceManager.Compute.Models.ScheduledEventsPolicy scheduledEventsPolicy = default, Azure.ResourceManager.Compute.Models.VirtualMachineStorageProfile storageProfile = default, Azure.ResourceManager.Compute.Models.AdditionalCapabilities additionalCapabilities = default, Azure.ResourceManager.Compute.Models.VirtualMachineOSProfile osProfile = default, Azure.ResourceManager.Compute.Models.VirtualMachineNetworkProfile networkProfile = default, Azure.ResourceManager.Compute.Models.SecurityProfile securityProfile = default, Azure.ResourceManager.Compute.Models.BootDiagnostics bootDiagnostics = default, Azure.Core.ResourceIdentifier availabilitySetId = default, Azure.Core.ResourceIdentifier virtualMachineScaleSetId = default, Azure.Core.ResourceIdentifier proximityPlacementGroupId = default, Azure.ResourceManager.Compute.Models.VirtualMachinePriorityType? priority = default, Azure.ResourceManager.Compute.Models.VirtualMachineEvictionPolicyType? evictionPolicy = default, double? billingMaxPrice = default, Azure.Core.ResourceIdentifier hostId = default, Azure.Core.ResourceIdentifier hostGroupId = default, string provisioningState = default, Azure.ResourceManager.Compute.Models.VirtualMachineInstanceView instanceView = default, string licenseType = default, string vmId = default, string extensionsTimeBudget = default, int? platformFaultDomain = default, Azure.ResourceManager.Compute.Models.ComputeScheduledEventsProfile scheduledEventsProfile = default, string userData = default, Azure.Core.ResourceIdentifier capacityReservationGroupId = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Compute.Models.VirtualMachineGalleryApplication> galleryApplications = default, DateTimeOffset? timeCreated = default);
static member VirtualMachinePatch : System.Collections.Generic.IDictionary<string, string> * Azure.ResourceManager.Compute.Models.ComputePlan * Azure.ResourceManager.Models.ManagedServiceIdentity * seq<string> * Azure.ResourceManager.Compute.Models.VirtualMachineHardwareProfile * Azure.ResourceManager.Compute.Models.ScheduledEventsPolicy * Azure.ResourceManager.Compute.Models.VirtualMachineStorageProfile * Azure.ResourceManager.Compute.Models.AdditionalCapabilities * Azure.ResourceManager.Compute.Models.VirtualMachineOSProfile * Azure.ResourceManager.Compute.Models.VirtualMachineNetworkProfile * Azure.ResourceManager.Compute.Models.SecurityProfile * Azure.ResourceManager.Compute.Models.BootDiagnostics * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * Nullable<Azure.ResourceManager.Compute.Models.VirtualMachinePriorityType> * Nullable<Azure.ResourceManager.Compute.Models.VirtualMachineEvictionPolicyType> * Nullable<double> * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * string * Azure.ResourceManager.Compute.Models.VirtualMachineInstanceView * string * string * string * Nullable<int> * Azure.ResourceManager.Compute.Models.ComputeScheduledEventsProfile * string * Azure.Core.ResourceIdentifier * seq<Azure.ResourceManager.Compute.Models.VirtualMachineGalleryApplication> * Nullable<DateTimeOffset> -> Azure.ResourceManager.Compute.Models.VirtualMachinePatch
Public Shared Function VirtualMachinePatch (Optional tags As IDictionary(Of String, String) = Nothing, Optional plan As ComputePlan = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional zones As IEnumerable(Of String) = Nothing, Optional hardwareProfile As VirtualMachineHardwareProfile = Nothing, Optional scheduledEventsPolicy As ScheduledEventsPolicy = Nothing, Optional storageProfile As VirtualMachineStorageProfile = Nothing, Optional additionalCapabilities As AdditionalCapabilities = Nothing, Optional osProfile As VirtualMachineOSProfile = Nothing, Optional networkProfile As VirtualMachineNetworkProfile = Nothing, Optional securityProfile As SecurityProfile = Nothing, Optional bootDiagnostics As BootDiagnostics = Nothing, Optional availabilitySetId As ResourceIdentifier = Nothing, Optional virtualMachineScaleSetId As ResourceIdentifier = Nothing, Optional proximityPlacementGroupId As ResourceIdentifier = Nothing, Optional priority As Nullable(Of VirtualMachinePriorityType) = Nothing, Optional evictionPolicy As Nullable(Of VirtualMachineEvictionPolicyType) = Nothing, Optional billingMaxPrice As Nullable(Of Double) = Nothing, Optional hostId As ResourceIdentifier = Nothing, Optional hostGroupId As ResourceIdentifier = Nothing, Optional provisioningState As String = Nothing, Optional instanceView As VirtualMachineInstanceView = Nothing, Optional licenseType As String = Nothing, Optional vmId As String = Nothing, Optional extensionsTimeBudget As String = Nothing, Optional platformFaultDomain As Nullable(Of Integer) = Nothing, Optional scheduledEventsProfile As ComputeScheduledEventsProfile = Nothing, Optional userData As String = Nothing, Optional capacityReservationGroupId As ResourceIdentifier = Nothing, Optional galleryApplications As IEnumerable(Of VirtualMachineGalleryApplication) = Nothing, Optional timeCreated As Nullable(Of DateTimeOffset) = Nothing) As VirtualMachinePatch

Parameters

tags
IDictionary<String,String>

Resource tags.

plan
ComputePlan

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.

identity
ManagedServiceIdentity

The identity of the virtual machine, if configured.

zones
IEnumerable<String>

The virtual machine zones.

hardwareProfile
VirtualMachineHardwareProfile

Specifies the hardware settings for the virtual machine.

scheduledEventsPolicy
ScheduledEventsPolicy

Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.

storageProfile
VirtualMachineStorageProfile

Specifies the storage settings for the virtual machine disks.

additionalCapabilities
AdditionalCapabilities

Specifies additional capabilities enabled or disabled on the virtual machine.

osProfile
VirtualMachineOSProfile

Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.

networkProfile
VirtualMachineNetworkProfile

Specifies the network interfaces of the virtual machine.

securityProfile
SecurityProfile

Specifies the Security related profile settings for the virtual machine.

bootDiagnostics
BootDiagnostics

Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.

availabilitySetId
ResourceIdentifier

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. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference.

virtualMachineScaleSetId
ResourceIdentifier

Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01.

proximityPlacementGroupId
ResourceIdentifier

Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.

priority
Nullable<VirtualMachinePriorityType>

Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01.

evictionPolicy
Nullable<VirtualMachineEvictionPolicyType>

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.

billingMaxPrice
Nullable<Double>

Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.

hostId
ResourceIdentifier

Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01.

hostGroupId
ResourceIdentifier

Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01.

provisioningState
String

The provisioning state, which only appears in the response.

instanceView
VirtualMachineInstanceView

The virtual machine instance view.

licenseType
String

Specifies that the image or disk that is being used was licensed on-premises. <br><br> Possible values for Windows Server operating system are: <br><br> Windows_Client <br><br> Windows_Server <br><br> Possible values for Linux Server operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS (for SUSE) <br><br> For more information, see Azure Hybrid Use Benefit for Windows Server <br><br> Azure Hybrid Use Benefit for Linux Server <br><br> Minimum api-version: 2015-06-15.

vmId
String

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

extensionsTimeBudget
String

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.

platformFaultDomain
Nullable<Int32>

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01.

scheduledEventsProfile
ComputeScheduledEventsProfile

Specifies Scheduled Event related configurations.

userData
String

UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.

capacityReservationGroupId
ResourceIdentifier

Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.

galleryApplications
IEnumerable<VirtualMachineGalleryApplication>

Specifies the gallery applications that should be made available to the VM/VMSS.

timeCreated
Nullable<DateTimeOffset>

Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.

Returns

A new VirtualMachinePatch instance for mocking.

Applies to