252 строки
17 KiB
YAML
252 строки
17 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.VMExtension"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension"
|
|
name: "VMExtension"
|
|
nameWithType: "VMExtension"
|
|
summary: "The configuration for virtual machine extensions."
|
|
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 class **VMExtension**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.VMExtension()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.VMExtension()"
|
|
name: "VMExtension()"
|
|
nameWithType: "VMExtension.VMExtension()"
|
|
syntax: "public VMExtension()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.autoUpgradeMinorVersion()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.autoUpgradeMinorVersion()"
|
|
name: "autoUpgradeMinorVersion()"
|
|
nameWithType: "VMExtension.autoUpgradeMinorVersion()"
|
|
summary: "Get indicates whether the extension should use a newer minor version if one is available at deployment time."
|
|
syntax: "public Boolean autoUpgradeMinorVersion()"
|
|
desc: "Get 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."
|
|
returns:
|
|
description: "the autoUpgradeMinorVersion value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.enableAutomaticUpgrade()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.enableAutomaticUpgrade()"
|
|
name: "enableAutomaticUpgrade()"
|
|
nameWithType: "VMExtension.enableAutomaticUpgrade()"
|
|
summary: "Get indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available."
|
|
syntax: "public Boolean enableAutomaticUpgrade()"
|
|
desc: "Get indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available."
|
|
returns:
|
|
description: "the enableAutomaticUpgrade value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.name()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.name()"
|
|
name: "name()"
|
|
nameWithType: "VMExtension.name()"
|
|
summary: "Get the name value."
|
|
syntax: "public String name()"
|
|
desc: "Get the name value."
|
|
returns:
|
|
description: "the name value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.protectedSettings()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.protectedSettings()"
|
|
name: "protectedSettings()"
|
|
nameWithType: "VMExtension.protectedSettings()"
|
|
summary: "Get the extension can contain either protected<wbr>Settings or protected<wbr>Settings<wbr>From<wbr>Key<wbr>Vault or no protected settings at all."
|
|
syntax: "public Object protectedSettings()"
|
|
desc: "Get the extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all."
|
|
returns:
|
|
description: "the protectedSettings value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.provisionAfterExtensions()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.provisionAfterExtensions()"
|
|
name: "provisionAfterExtensions()"
|
|
nameWithType: "VMExtension.provisionAfterExtensions()"
|
|
summary: "Get collection of extension names after which this extension needs to be provisioned."
|
|
syntax: "public List<String> provisionAfterExtensions()"
|
|
desc: "Get collection of extension names after which this extension needs to be provisioned."
|
|
returns:
|
|
description: "the provisionAfterExtensions value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.publisher()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.publisher()"
|
|
name: "publisher()"
|
|
nameWithType: "VMExtension.publisher()"
|
|
summary: "Get the publisher value."
|
|
syntax: "public String publisher()"
|
|
desc: "Get the publisher value."
|
|
returns:
|
|
description: "the publisher value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.settings()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.settings()"
|
|
name: "settings()"
|
|
nameWithType: "VMExtension.settings()"
|
|
summary: "Get the settings value."
|
|
syntax: "public Object settings()"
|
|
desc: "Get the settings value."
|
|
returns:
|
|
description: "the settings value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.type()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.type()"
|
|
name: "type()"
|
|
nameWithType: "VMExtension.type()"
|
|
summary: "Get the type value."
|
|
syntax: "public String type()"
|
|
desc: "Get the type value."
|
|
returns:
|
|
description: "the type value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.typeHandlerVersion()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.typeHandlerVersion()"
|
|
name: "typeHandlerVersion()"
|
|
nameWithType: "VMExtension.typeHandlerVersion()"
|
|
summary: "Get the type<wbr>Handler<wbr>Version value."
|
|
syntax: "public String typeHandlerVersion()"
|
|
desc: "Get the typeHandlerVersion value."
|
|
returns:
|
|
description: "the typeHandlerVersion value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.withAutoUpgradeMinorVersion(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion)"
|
|
name: "withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion)"
|
|
nameWithType: "VMExtension.withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion)"
|
|
summary: "Set indicates whether the extension should use a newer minor version if one is available at deployment time."
|
|
parameters:
|
|
- description: "the autoUpgradeMinorVersion value to set"
|
|
name: "autoUpgradeMinorVersion"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public VMExtension withAutoUpgradeMinorVersion(Boolean autoUpgradeMinorVersion)"
|
|
desc: "Set 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."
|
|
returns:
|
|
description: "the VMExtension object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VMExtension?alt=com.microsoft.azure.batch.protocol.models.VMExtension&text=VMExtension\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.withEnableAutomaticUpgrade(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.withEnableAutomaticUpgrade(Boolean enableAutomaticUpgrade)"
|
|
name: "withEnableAutomaticUpgrade(Boolean enableAutomaticUpgrade)"
|
|
nameWithType: "VMExtension.withEnableAutomaticUpgrade(Boolean enableAutomaticUpgrade)"
|
|
summary: "Set indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available."
|
|
parameters:
|
|
- description: "the enableAutomaticUpgrade value to set"
|
|
name: "enableAutomaticUpgrade"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public VMExtension withEnableAutomaticUpgrade(Boolean enableAutomaticUpgrade)"
|
|
desc: "Set indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available."
|
|
returns:
|
|
description: "the VMExtension object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VMExtension?alt=com.microsoft.azure.batch.protocol.models.VMExtension&text=VMExtension\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.withName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.withName(String name)"
|
|
name: "withName(String name)"
|
|
nameWithType: "VMExtension.withName(String name)"
|
|
summary: "Set the name value."
|
|
parameters:
|
|
- description: "the name value to set"
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public VMExtension withName(String name)"
|
|
desc: "Set the name value."
|
|
returns:
|
|
description: "the VMExtension object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VMExtension?alt=com.microsoft.azure.batch.protocol.models.VMExtension&text=VMExtension\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.withProtectedSettings(java.lang.Object)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.withProtectedSettings(Object protectedSettings)"
|
|
name: "withProtectedSettings(Object protectedSettings)"
|
|
nameWithType: "VMExtension.withProtectedSettings(Object protectedSettings)"
|
|
summary: "Set the extension can contain either protected<wbr>Settings or protected<wbr>Settings<wbr>From<wbr>Key<wbr>Vault or no protected settings at all."
|
|
parameters:
|
|
- description: "the protectedSettings value to set"
|
|
name: "protectedSettings"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
syntax: "public VMExtension withProtectedSettings(Object protectedSettings)"
|
|
desc: "Set the extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all."
|
|
returns:
|
|
description: "the VMExtension object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VMExtension?alt=com.microsoft.azure.batch.protocol.models.VMExtension&text=VMExtension\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.withProvisionAfterExtensions(java.util.List<java.lang.String>)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.withProvisionAfterExtensions(List<String> provisionAfterExtensions)"
|
|
name: "withProvisionAfterExtensions(List<String> provisionAfterExtensions)"
|
|
nameWithType: "VMExtension.withProvisionAfterExtensions(List<String> provisionAfterExtensions)"
|
|
summary: "Set collection of extension names after which this extension needs to be provisioned."
|
|
parameters:
|
|
- description: "the provisionAfterExtensions value to set"
|
|
name: "provisionAfterExtensions"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public VMExtension withProvisionAfterExtensions(List<String> provisionAfterExtensions)"
|
|
desc: "Set collection of extension names after which this extension needs to be provisioned."
|
|
returns:
|
|
description: "the VMExtension object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VMExtension?alt=com.microsoft.azure.batch.protocol.models.VMExtension&text=VMExtension\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.withPublisher(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.withPublisher(String publisher)"
|
|
name: "withPublisher(String publisher)"
|
|
nameWithType: "VMExtension.withPublisher(String publisher)"
|
|
summary: "Set the publisher value."
|
|
parameters:
|
|
- description: "the publisher value to set"
|
|
name: "publisher"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public VMExtension withPublisher(String publisher)"
|
|
desc: "Set the publisher value."
|
|
returns:
|
|
description: "the VMExtension object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VMExtension?alt=com.microsoft.azure.batch.protocol.models.VMExtension&text=VMExtension\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.withSettings(java.lang.Object)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.withSettings(Object settings)"
|
|
name: "withSettings(Object settings)"
|
|
nameWithType: "VMExtension.withSettings(Object settings)"
|
|
summary: "Set the settings value."
|
|
parameters:
|
|
- description: "the settings value to set"
|
|
name: "settings"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
syntax: "public VMExtension withSettings(Object settings)"
|
|
desc: "Set the settings value."
|
|
returns:
|
|
description: "the VMExtension object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VMExtension?alt=com.microsoft.azure.batch.protocol.models.VMExtension&text=VMExtension\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.withType(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.withType(String type)"
|
|
name: "withType(String type)"
|
|
nameWithType: "VMExtension.withType(String type)"
|
|
summary: "Set the type value."
|
|
parameters:
|
|
- description: "the type value to set"
|
|
name: "type"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public VMExtension withType(String type)"
|
|
desc: "Set the type value."
|
|
returns:
|
|
description: "the VMExtension object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VMExtension?alt=com.microsoft.azure.batch.protocol.models.VMExtension&text=VMExtension\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.VMExtension.withTypeHandlerVersion(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.VMExtension.withTypeHandlerVersion(String typeHandlerVersion)"
|
|
name: "withTypeHandlerVersion(String typeHandlerVersion)"
|
|
nameWithType: "VMExtension.withTypeHandlerVersion(String typeHandlerVersion)"
|
|
summary: "Set the type<wbr>Handler<wbr>Version value."
|
|
parameters:
|
|
- description: "the typeHandlerVersion value to set"
|
|
name: "typeHandlerVersion"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public VMExtension withTypeHandlerVersion(String typeHandlerVersion)"
|
|
desc: "Set the typeHandlerVersion value."
|
|
returns:
|
|
description: "the VMExtension object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.VMExtension?alt=com.microsoft.azure.batch.protocol.models.VMExtension&text=VMExtension\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The configuration for virtual machine extensions."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol.models"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|