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

255 строки
21 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate"
name: "DedicatedHostUpdate"
nameWithType: "DedicatedHostUpdate"
summary: "Specifies information about the dedicated host."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.compute.models.UpdateResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.resourcemanager.compute.models.UpdateResource?alt=com.azure.resourcemanager.compute.models.UpdateResource&text=UpdateResource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.resourcemanager.compute.models.UpdateResource.fromJson(com.azure.json.JsonReader)?alt=com.azure.resourcemanager.compute.models.UpdateResource.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.compute.models.UpdateResource.tags()?alt=com.azure.resourcemanager.compute.models.UpdateResource.tags&text=tags\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.compute.models.UpdateResource.toJson(com.azure.json.JsonWriter)?alt=com.azure.resourcemanager.compute.models.UpdateResource.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.compute.models.UpdateResource.validate()?alt=com.azure.resourcemanager.compute.models.UpdateResource.validate&text=validate\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.resourcemanager.compute.models.UpdateResource.withTags(java.util.Map<java.lang.String,java.lang.String>)?alt=com.azure.resourcemanager.compute.models.UpdateResource.withTags&text=withTags\" data-throw-if-not-resolved=\"False\" />"
- 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 **DedicatedHostUpdate**</br> extends <xref href=\"com.azure.resourcemanager.compute.models.UpdateResource?alt=com.azure.resourcemanager.compute.models.UpdateResource&text=UpdateResource\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.DedicatedHostUpdate()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.DedicatedHostUpdate()"
name: "DedicatedHostUpdate()"
nameWithType: "DedicatedHostUpdate.DedicatedHostUpdate()"
summary: "Creates an instance of Dedicated<wbr>Host<wbr>Update class."
syntax: "public DedicatedHostUpdate()"
desc: "Creates an instance of DedicatedHostUpdate class."
methods:
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.autoReplaceOnFailure()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.autoReplaceOnFailure()"
name: "autoReplaceOnFailure()"
nameWithType: "DedicatedHostUpdate.autoReplaceOnFailure()"
summary: "Get the auto<wbr>Replace<wbr>OnFailure property: Specifies whether the dedicated host should be replaced automatically in case of a failure."
syntax: "public Boolean autoReplaceOnFailure()"
desc: "Get the autoReplaceOnFailure property: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided."
returns:
description: "the autoReplaceOnFailure value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "DedicatedHostUpdate.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Dedicated<wbr>Host<wbr>Update 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 DedicatedHostUpdate fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the DedicatedHostUpdate."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of DedicatedHostUpdate from the JsonReader."
returns:
description: "An instance of DedicatedHostUpdate 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.DedicatedHostUpdate?alt=com.azure.resourcemanager.compute.models.DedicatedHostUpdate&text=DedicatedHostUpdate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.hostId()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.hostId()"
name: "hostId()"
nameWithType: "DedicatedHostUpdate.hostId()"
summary: "Get the host<wbr>Id property: A unique id generated and assigned to the dedicated host by the platform."
syntax: "public String hostId()"
desc: "Get the hostId property: A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host."
returns:
description: "the hostId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.instanceView()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.instanceView()"
name: "instanceView()"
nameWithType: "DedicatedHostUpdate.instanceView()"
summary: "Get the instance<wbr>View property: The dedicated host instance view."
syntax: "public DedicatedHostInstanceView instanceView()"
desc: "Get the instanceView property: The dedicated host instance view."
returns:
description: "the instanceView value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DedicatedHostInstanceView?alt=com.azure.resourcemanager.compute.models.DedicatedHostInstanceView&text=DedicatedHostInstanceView\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.licenseType()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.licenseType()"
name: "licenseType()"
nameWithType: "DedicatedHostUpdate.licenseType()"
summary: "Get the license<wbr>Type property: Specifies the software license type that will be applied to the VMs deployed on the dedicated host."
syntax: "public DedicatedHostLicenseTypes licenseType()"
desc: "Get the licenseType property: Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: \\*\\*None,\\*\\* \\*\\*Windows\\_Server\\_Hybrid,\\*\\* \\*\\*Windows\\_Server\\_Perpetual.\\*\\* The default value is: \\*\\*None.\\*\\*."
returns:
description: "the licenseType value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DedicatedHostLicenseTypes?alt=com.azure.resourcemanager.compute.models.DedicatedHostLicenseTypes&text=DedicatedHostLicenseTypes\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.platformFaultDomain()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.platformFaultDomain()"
name: "platformFaultDomain()"
nameWithType: "DedicatedHostUpdate.platformFaultDomain()"
summary: "Get the platform<wbr>Fault<wbr>Domain property: Fault domain of the dedicated host within a dedicated host group."
syntax: "public Integer platformFaultDomain()"
desc: "Get the platformFaultDomain property: Fault domain of the dedicated host within a dedicated host group."
returns:
description: "the platformFaultDomain value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.provisioningState()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.provisioningState()"
name: "provisioningState()"
nameWithType: "DedicatedHostUpdate.provisioningState()"
summary: "Get the provisioning<wbr>State property: The provisioning state, which only appears in the response."
syntax: "public String provisioningState()"
desc: "Get the provisioningState property: The provisioning state, which only appears in the response."
returns:
description: "the provisioningState value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.provisioningTime()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.provisioningTime()"
name: "provisioningTime()"
nameWithType: "DedicatedHostUpdate.provisioningTime()"
summary: "Get the provisioning<wbr>Time property: The date when the host was first provisioned."
syntax: "public OffsetDateTime provisioningTime()"
desc: "Get the provisioningTime property: The date when the host was first provisioned."
returns:
description: "the provisioningTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.sku()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.sku()"
name: "sku()"
nameWithType: "DedicatedHostUpdate.sku()"
summary: "Get the sku property: \\[List all available dedicated host sizes for resizing\\] (https://docs.<wbr>microsoft.<wbr>com/rest/api/compute/dedicated-hosts/listavailablesizes)."
syntax: "public Sku sku()"
desc: "Get the sku property: \\[List all available dedicated host sizes for resizing\\] (https://docs.microsoft.com/rest/api/compute/dedicated-hosts/listavailablesizes). Resizing can be only used to scale up DedicatedHost. Only name is required to be set."
returns:
description: "the sku value."
type: "<xref href=\"com.azure.resourcemanager.compute.models.Sku?alt=com.azure.resourcemanager.compute.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.timeCreated()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.timeCreated()"
name: "timeCreated()"
nameWithType: "DedicatedHostUpdate.timeCreated()"
summary: "Get the time<wbr>Created property: Specifies the time at which the Dedicated Host resource was created."
syntax: "public OffsetDateTime timeCreated()"
desc: "Get the timeCreated property: Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01."
returns:
description: "the timeCreated value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "DedicatedHostUpdate.toJson(JsonWriter jsonWriter)"
overridden: "com.azure.resourcemanager.compute.models.UpdateResource.toJson(com.azure.json.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.DedicatedHostUpdate.validate()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.validate()"
name: "validate()"
nameWithType: "DedicatedHostUpdate.validate()"
summary: "Validates the instance."
overridden: "com.azure.resourcemanager.compute.models.UpdateResource.validate()"
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.virtualMachines()"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.virtualMachines()"
name: "virtualMachines()"
nameWithType: "DedicatedHostUpdate.virtualMachines()"
summary: "Get the virtual<wbr>Machines property: A list of references to all virtual machines in the Dedicated Host."
syntax: "public List<SubResourceReadOnly> virtualMachines()"
desc: "Get the virtualMachines property: A list of references to all virtual machines in the Dedicated Host."
returns:
description: "the virtualMachines value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.compute.models.SubResourceReadOnly?alt=com.azure.resourcemanager.compute.models.SubResourceReadOnly&text=SubResourceReadOnly\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.withAutoReplaceOnFailure(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.withAutoReplaceOnFailure(Boolean autoReplaceOnFailure)"
name: "withAutoReplaceOnFailure(Boolean autoReplaceOnFailure)"
nameWithType: "DedicatedHostUpdate.withAutoReplaceOnFailure(Boolean autoReplaceOnFailure)"
summary: "Set the auto<wbr>Replace<wbr>OnFailure property: Specifies whether the dedicated host should be replaced automatically in case of a failure."
parameters:
- description: "the autoReplaceOnFailure value to set."
name: "autoReplaceOnFailure"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public DedicatedHostUpdate withAutoReplaceOnFailure(Boolean autoReplaceOnFailure)"
desc: "Set the autoReplaceOnFailure property: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided."
returns:
description: "the DedicatedHostUpdate object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DedicatedHostUpdate?alt=com.azure.resourcemanager.compute.models.DedicatedHostUpdate&text=DedicatedHostUpdate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.withLicenseType(com.azure.resourcemanager.compute.models.DedicatedHostLicenseTypes)"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.withLicenseType(DedicatedHostLicenseTypes licenseType)"
name: "withLicenseType(DedicatedHostLicenseTypes licenseType)"
nameWithType: "DedicatedHostUpdate.withLicenseType(DedicatedHostLicenseTypes licenseType)"
summary: "Set the license<wbr>Type property: Specifies the software license type that will be applied to the VMs deployed on the dedicated host."
parameters:
- description: "the licenseType value to set."
name: "licenseType"
type: "<xref href=\"com.azure.resourcemanager.compute.models.DedicatedHostLicenseTypes?alt=com.azure.resourcemanager.compute.models.DedicatedHostLicenseTypes&text=DedicatedHostLicenseTypes\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DedicatedHostUpdate withLicenseType(DedicatedHostLicenseTypes licenseType)"
desc: "Set the licenseType property: Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: \\*\\*None,\\*\\* \\*\\*Windows\\_Server\\_Hybrid,\\*\\* \\*\\*Windows\\_Server\\_Perpetual.\\*\\* The default value is: \\*\\*None.\\*\\*."
returns:
description: "the DedicatedHostUpdate object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DedicatedHostUpdate?alt=com.azure.resourcemanager.compute.models.DedicatedHostUpdate&text=DedicatedHostUpdate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.withPlatformFaultDomain(java.lang.Integer)"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.withPlatformFaultDomain(Integer platformFaultDomain)"
name: "withPlatformFaultDomain(Integer platformFaultDomain)"
nameWithType: "DedicatedHostUpdate.withPlatformFaultDomain(Integer platformFaultDomain)"
summary: "Set the platform<wbr>Fault<wbr>Domain property: Fault domain of the dedicated host within a dedicated host group."
parameters:
- description: "the platformFaultDomain value to set."
name: "platformFaultDomain"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public DedicatedHostUpdate withPlatformFaultDomain(Integer platformFaultDomain)"
desc: "Set the platformFaultDomain property: Fault domain of the dedicated host within a dedicated host group."
returns:
description: "the DedicatedHostUpdate object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DedicatedHostUpdate?alt=com.azure.resourcemanager.compute.models.DedicatedHostUpdate&text=DedicatedHostUpdate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.withSku(com.azure.resourcemanager.compute.models.Sku)"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.withSku(Sku sku)"
name: "withSku(Sku sku)"
nameWithType: "DedicatedHostUpdate.withSku(Sku sku)"
summary: "Set the sku property: \\[List all available dedicated host sizes for resizing\\] (https://docs.<wbr>microsoft.<wbr>com/rest/api/compute/dedicated-hosts/listavailablesizes)."
parameters:
- description: "the sku value to set."
name: "sku"
type: "<xref href=\"com.azure.resourcemanager.compute.models.Sku?alt=com.azure.resourcemanager.compute.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DedicatedHostUpdate withSku(Sku sku)"
desc: "Set the sku property: \\[List all available dedicated host sizes for resizing\\] (https://docs.microsoft.com/rest/api/compute/dedicated-hosts/listavailablesizes). Resizing can be only used to scale up DedicatedHost. Only name is required to be set."
returns:
description: "the DedicatedHostUpdate object itself."
type: "<xref href=\"com.azure.resourcemanager.compute.models.DedicatedHostUpdate?alt=com.azure.resourcemanager.compute.models.DedicatedHostUpdate&text=DedicatedHostUpdate\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.withTags(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.resourcemanager.compute.models.DedicatedHostUpdate.withTags(Map<String,String> tags)"
name: "withTags(Map<String,String> tags)"
nameWithType: "DedicatedHostUpdate.withTags(Map<String,String> tags)"
summary: "Set the tags property: Resource tags."
overridden: "com.azure.resourcemanager.compute.models.UpdateResource.withTags(java.util.Map<java.lang.String,java.lang.String>)"
parameters:
- name: "tags"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public DedicatedHostUpdate withTags(Map<String,String> tags)"
desc: "Set the tags property: Resource tags."
returns:
type: "<xref href=\"com.azure.resourcemanager.compute.models.DedicatedHostUpdate?alt=com.azure.resourcemanager.compute.models.DedicatedHostUpdate&text=DedicatedHostUpdate\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated."
metadata: {}
package: "com.azure.resourcemanager.compute.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-compute:2.42.0