azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.c...

174 строки
17 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.compute.models.PatchSettings"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings"
name: "PatchSettings"
nameWithType: "PatchSettings"
summary: "Specifies settings related to VM Guest Patching on Windows."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **PatchSettings**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.compute.models.PatchSettings?alt=com.azure.resourcemanager.compute.models.PatchSettings&text=PatchSettings\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.PatchSettings()"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.PatchSettings()"
name: "PatchSettings()"
nameWithType: "PatchSettings.PatchSettings()"
summary: "Creates an instance of Patch<wbr>Settings class."
syntax: "public PatchSettings()"
desc: "Creates an instance of PatchSettings class."
methods:
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.assessmentMode()"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.assessmentMode()"
name: "assessmentMode()"
nameWithType: "PatchSettings.assessmentMode()"
summary: "Get the assessment<wbr>Mode property: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> \\*\\*Image<wbr>Default\\*\\* - You control the timing of patch assessments on a virtual machine.<br /><br /> \\*\\*Automatic<wbr>ByPlatform\\*\\* - The platform will trigger periodic patch assessments."
syntax: "public WindowsPatchAssessmentMode assessmentMode()"
desc: "Get the assessmentMode property: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> \\*\\*ImageDefault\\*\\* - You control the timing of patch assessments on a virtual machine.<br /><br /> \\*\\*AutomaticByPlatform\\*\\* - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true."
returns:
description: "the assessmentMode value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.WindowsPatchAssessmentMode?alt=com.azure.resourcemanager.compute.models.WindowsPatchAssessmentMode&text=WindowsPatchAssessmentMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.automaticByPlatformSettings()"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.automaticByPlatformSettings()"
name: "automaticByPlatformSettings()"
nameWithType: "PatchSettings.automaticByPlatformSettings()"
summary: "Get the automatic<wbr>ByPlatform<wbr>Settings property: Specifies additional settings for patch mode Automatic<wbr>ByPlatform in VM Guest Patching on Windows."
syntax: "public WindowsVMGuestPatchAutomaticByPlatformSettings automaticByPlatformSettings()"
desc: "Get the automaticByPlatformSettings property: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows."
returns:
description: "the automaticByPlatformSettings value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.WindowsVMGuestPatchAutomaticByPlatformSettings?alt=com.azure.resourcemanager.compute.models.WindowsVMGuestPatchAutomaticByPlatformSettings&text=WindowsVMGuestPatchAutomaticByPlatformSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.enableHotpatching()"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.enableHotpatching()"
name: "enableHotpatching()"
nameWithType: "PatchSettings.enableHotpatching()"
summary: "Get the enable<wbr>Hotpatching property: Enables customers to patch their Azure VMs without requiring a reboot."
syntax: "public Boolean enableHotpatching()"
desc: "Get the enableHotpatching property: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'."
returns:
description: "the enableHotpatching value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "PatchSettings.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Patch<wbr>Settings from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static PatchSettings fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the PatchSettings."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of PatchSettings from the JsonReader."
returns:
description: "An instance of PatchSettings if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.compute.models.PatchSettings?alt=com.azure.resourcemanager.compute.models.PatchSettings&text=PatchSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.patchMode()"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.patchMode()"
name: "patchMode()"
nameWithType: "PatchSettings.patchMode()"
summary: "Get the patch<wbr>Mode property: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with Orchestration<wbr>Mode as Flexible.<br /><br /> Possible values are:<br /><br /> \\*\\*Manual\\*\\* - You control the application of patches to a virtual machine."
syntax: "public WindowsVMGuestPatchMode patchMode()"
desc: "Get the patchMode property: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.<br /><br /> Possible values are:<br /><br /> \\*\\*Manual\\*\\* - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false<br /><br /> \\*\\*AutomaticByOS\\*\\* - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. <br /><br /> \\*\\*AutomaticByPlatform\\*\\* - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true."
returns:
description: "the patchMode value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.WindowsVMGuestPatchMode?alt=com.azure.resourcemanager.compute.models.WindowsVMGuestPatchMode&text=WindowsVMGuestPatchMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "PatchSettings.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.validate()"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.validate()"
name: "validate()"
nameWithType: "PatchSettings.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.withAssessmentMode(com.azure.resourcemanager.compute.models.WindowsPatchAssessmentMode)"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.withAssessmentMode(WindowsPatchAssessmentMode assessmentMode)"
name: "withAssessmentMode(WindowsPatchAssessmentMode assessmentMode)"
nameWithType: "PatchSettings.withAssessmentMode(WindowsPatchAssessmentMode assessmentMode)"
summary: "Set the assessment<wbr>Mode property: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> \\*\\*Image<wbr>Default\\*\\* - You control the timing of patch assessments on a virtual machine.<br /><br /> \\*\\*Automatic<wbr>ByPlatform\\*\\* - The platform will trigger periodic patch assessments."
parameters:
- description: "the assessmentMode value to set."
name: "assessmentMode"
type: "<xref href=\"com.azure.resourcemanager.compute.models.WindowsPatchAssessmentMode?alt=com.azure.resourcemanager.compute.models.WindowsPatchAssessmentMode&text=WindowsPatchAssessmentMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PatchSettings withAssessmentMode(WindowsPatchAssessmentMode assessmentMode)"
desc: "Set the assessmentMode property: Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.<br /><br /> Possible values are:<br /><br /> \\*\\*ImageDefault\\*\\* - You control the timing of patch assessments on a virtual machine.<br /><br /> \\*\\*AutomaticByPlatform\\*\\* - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true."
returns:
description: "the PatchSettings object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.models.PatchSettings?alt=com.azure.resourcemanager.compute.models.PatchSettings&text=PatchSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.withAutomaticByPlatformSettings(com.azure.resourcemanager.compute.models.WindowsVMGuestPatchAutomaticByPlatformSettings)"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.withAutomaticByPlatformSettings(WindowsVMGuestPatchAutomaticByPlatformSettings automaticByPlatformSettings)"
name: "withAutomaticByPlatformSettings(WindowsVMGuestPatchAutomaticByPlatformSettings automaticByPlatformSettings)"
nameWithType: "PatchSettings.withAutomaticByPlatformSettings(WindowsVMGuestPatchAutomaticByPlatformSettings automaticByPlatformSettings)"
summary: "Set the automatic<wbr>ByPlatform<wbr>Settings property: Specifies additional settings for patch mode Automatic<wbr>ByPlatform in VM Guest Patching on Windows."
parameters:
- description: "the automaticByPlatformSettings value to set."
name: "automaticByPlatformSettings"
type: "<xref href=\"com.azure.resourcemanager.compute.models.WindowsVMGuestPatchAutomaticByPlatformSettings?alt=com.azure.resourcemanager.compute.models.WindowsVMGuestPatchAutomaticByPlatformSettings&text=WindowsVMGuestPatchAutomaticByPlatformSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PatchSettings withAutomaticByPlatformSettings(WindowsVMGuestPatchAutomaticByPlatformSettings automaticByPlatformSettings)"
desc: "Set the automaticByPlatformSettings property: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows."
returns:
description: "the PatchSettings object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.models.PatchSettings?alt=com.azure.resourcemanager.compute.models.PatchSettings&text=PatchSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.withEnableHotpatching(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.withEnableHotpatching(Boolean enableHotpatching)"
name: "withEnableHotpatching(Boolean enableHotpatching)"
nameWithType: "PatchSettings.withEnableHotpatching(Boolean enableHotpatching)"
summary: "Set the enable<wbr>Hotpatching property: Enables customers to patch their Azure VMs without requiring a reboot."
parameters:
- description: "the enableHotpatching value to set."
name: "enableHotpatching"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public PatchSettings withEnableHotpatching(Boolean enableHotpatching)"
desc: "Set the enableHotpatching property: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'."
returns:
description: "the PatchSettings object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.models.PatchSettings?alt=com.azure.resourcemanager.compute.models.PatchSettings&text=PatchSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.PatchSettings.withPatchMode(com.azure.resourcemanager.compute.models.WindowsVMGuestPatchMode)"
fullName: "com.azure.resourcemanager.compute.models.PatchSettings.withPatchMode(WindowsVMGuestPatchMode patchMode)"
name: "withPatchMode(WindowsVMGuestPatchMode patchMode)"
nameWithType: "PatchSettings.withPatchMode(WindowsVMGuestPatchMode patchMode)"
summary: "Set the patch<wbr>Mode property: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with Orchestration<wbr>Mode as Flexible.<br /><br /> Possible values are:<br /><br /> \\*\\*Manual\\*\\* - You control the application of patches to a virtual machine."
parameters:
- description: "the patchMode value to set."
name: "patchMode"
type: "<xref href=\"com.azure.resourcemanager.compute.models.WindowsVMGuestPatchMode?alt=com.azure.resourcemanager.compute.models.WindowsVMGuestPatchMode&text=WindowsVMGuestPatchMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PatchSettings withPatchMode(WindowsVMGuestPatchMode patchMode)"
desc: "Set the patchMode property: Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.<br /><br /> Possible values are:<br /><br /> \\*\\*Manual\\*\\* - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false<br /><br /> \\*\\*AutomaticByOS\\*\\* - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true. <br /><br /> \\*\\*AutomaticByPlatform\\*\\* - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true."
returns:
description: "the PatchSettings object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.models.PatchSettings?alt=com.azure.resourcemanager.compute.models.PatchSettings&text=PatchSettings\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Specifies settings related to VM Guest Patching on Windows."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.compute.models.PatchSettings?alt=com.azure.resourcemanager.compute.models.PatchSettings&text=PatchSettings\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.compute.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-compute:2.42.0