### YamlMime:JavaType
uid: "com.azure.resourcemanager.appcontainers.models.Volume"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume"
name: "Volume"
nameWithType: "Volume"
summary: "Volume definitions for the Container App."
inheritances:
- ""
inheritedClassMethods:
- classRef: "java.lang.Object"
methodsRef:
- "clone"
- "equals"
- "finalize"
- "getClass"
- "hashCode"
- "notify"
- "notifyAll"
- "toString"
- "wait"
- "wait"
- "wait"
syntax: "public final class **Volume** implements <>"
constructors:
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.Volume()"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.Volume()"
name: "Volume()"
nameWithType: "Volume.Volume()"
summary: "Creates an instance of Volume class."
syntax: "public Volume()"
desc: "Creates an instance of Volume class."
methods:
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "Volume.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Volume from the JsonReader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: ""
syntax: "public static Volume fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the Volume."
type: "IOException"
desc: "Reads an instance of Volume from the JsonReader."
returns:
description: "An instance of Volume if the JsonReader was pointing to an instance of it, or null if it was pointing to\n JSON null."
type: ""
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.mountOptions()"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.mountOptions()"
name: "mountOptions()"
nameWithType: "Volume.mountOptions()"
summary: "Get the mountOptions property: Mount options used while mounting the AzureFile."
syntax: "public String mountOptions()"
desc: "Get the mountOptions property: Mount options used while mounting the AzureFile. Must be a comma-separated string."
returns:
description: "the mountOptions value."
type: "String"
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.name()"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.name()"
name: "name()"
nameWithType: "Volume.name()"
summary: "Get the name property: Volume name."
syntax: "public String name()"
desc: "Get the name property: Volume name."
returns:
description: "the name value."
type: "String"
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.secrets()"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.secrets()"
name: "secrets()"
nameWithType: "Volume.secrets()"
summary: "Get the secrets property: List of secrets to be added in volume."
syntax: "public List secrets()"
desc: "Get the secrets property: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume."
returns:
description: "the secrets value."
type: "List<>"
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.storageName()"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.storageName()"
name: "storageName()"
nameWithType: "Volume.storageName()"
summary: "Get the storageName property: Name of storage resource."
syntax: "public String storageName()"
desc: "Get the storageName property: Name of storage resource. No need to provide for EmptyDir and Secret."
returns:
description: "the storageName value."
type: "String"
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.storageType()"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.storageType()"
name: "storageType()"
nameWithType: "Volume.storageType()"
summary: "Get the storageType property: Storage type for the volume."
syntax: "public StorageType storageType()"
desc: "Get the storageType property: Storage type for the volume. If not provided, use EmptyDir."
returns:
description: "the storageType value."
type: ""
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "Volume.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: ""
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "IOException"
returns:
type: ""
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.validate()"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.validate()"
name: "validate()"
nameWithType: "Volume.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.withMountOptions(java.lang.String)"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.withMountOptions(String mountOptions)"
name: "withMountOptions(String mountOptions)"
nameWithType: "Volume.withMountOptions(String mountOptions)"
summary: "Set the mountOptions property: Mount options used while mounting the AzureFile."
parameters:
- description: "the mountOptions value to set."
name: "mountOptions"
type: "String"
syntax: "public Volume withMountOptions(String mountOptions)"
desc: "Set the mountOptions property: Mount options used while mounting the AzureFile. Must be a comma-separated string."
returns:
description: "the Volume object itself."
type: ""
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.withName(java.lang.String)"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.withName(String name)"
name: "withName(String name)"
nameWithType: "Volume.withName(String name)"
summary: "Set the name property: Volume name."
parameters:
- description: "the name value to set."
name: "name"
type: "String"
syntax: "public Volume withName(String name)"
desc: "Set the name property: Volume name."
returns:
description: "the Volume object itself."
type: ""
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.withSecrets(java.util.List)"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.withSecrets(List secrets)"
name: "withSecrets(List secrets)"
nameWithType: "Volume.withSecrets(List secrets)"
summary: "Set the secrets property: List of secrets to be added in volume."
parameters:
- description: "the secrets value to set."
name: "secrets"
type: "List<>"
syntax: "public Volume withSecrets(List secrets)"
desc: "Set the secrets property: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume."
returns:
description: "the Volume object itself."
type: ""
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.withStorageName(java.lang.String)"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.withStorageName(String storageName)"
name: "withStorageName(String storageName)"
nameWithType: "Volume.withStorageName(String storageName)"
summary: "Set the storageName property: Name of storage resource."
parameters:
- description: "the storageName value to set."
name: "storageName"
type: "String"
syntax: "public Volume withStorageName(String storageName)"
desc: "Set the storageName property: Name of storage resource. No need to provide for EmptyDir and Secret."
returns:
description: "the Volume object itself."
type: ""
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.withStorageType(com.azure.resourcemanager.appcontainers.models.StorageType)"
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.withStorageType(StorageType storageType)"
name: "withStorageType(StorageType storageType)"
nameWithType: "Volume.withStorageType(StorageType storageType)"
summary: "Set the storageType property: Storage type for the volume."
parameters:
- description: "the storageType value to set."
name: "storageType"
type: ""
syntax: "public Volume withStorageType(StorageType storageType)"
desc: "Set the storageType property: Storage type for the volume. If not provided, use EmptyDir."
returns:
description: "the Volume object itself."
type: ""
type: "class"
desc: "Volume definitions for the Container App."
implements:
- "<>"
metadata: {}
package: "com.azure.resourcemanager.appcontainers.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-appcontainers:1.0.0