Interface AmlFilesystem
public interface AmlFilesystem
An immutable client-side representation of AmlFilesystem.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the AmlFilesystem definition.static interface
The AmlFilesystem definition stages.static interface
The template for AmlFilesystem update.static interface
The AmlFilesystem update stages. -
Method Summary
Modifier and TypeMethodDescriptionvoid
archive()
Archive data from the AML file system.com.azure.core.http.rest.Response<Void>
archiveWithResponse
(AmlFilesystemArchiveInfo archiveInfo, com.azure.core.util.Context context) Archive data from the AML file system.void
Cancel archiving data from the AML file system.com.azure.core.http.rest.Response<Void>
cancelArchiveWithResponse
(com.azure.core.util.Context context) Cancel archiving data from the AML file system.Gets the encryptionSettings property: Specifies encryption settings of the AML file system.Gets the filesystemSubnet property: Subnet used for managing the AML file system and for client-facing operations.health()
Gets the health property: Health of the AML file system.hsm()
Gets the hsm property: Hydration and archive settings and status.id()
Gets the id property: Fully qualified resource Id for the resource.identity()
Gets the identity property: The managed identity used by the AML file system, if configured.Gets the inner com.azure.resourcemanager.storagecache.fluent.models.AmlFilesystemInner object.location()
Gets the location property: The geo-location where the resource lives.Gets the lustreVersion property: The version of Lustre running in the AML file system.Gets the maintenanceWindow property: Start time of a 30-minute weekly maintenance window.Gets the mgsAddress property: The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS).Gets the mountCommand property: Recommended command to mount the AML file system.name()
Gets the name property: The name of the resource.Gets the provisioningState property: ARM provisioning state.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.Gets the name of the resource region.Gets the name of the resource group.sku()
Gets the sku property: SKU for the resource.float
Gets the storageCapacityTiB property: The size of the AML file system, in TiB.com.azure.core.management.SystemData
Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.tags()
Gets the tags property: Resource tags.Gets the throughputProvisionedMBps property: Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput.type()
Gets the type property: The type of the resource.update()
Begins update for the AmlFilesystem resource.zones()
Gets the zones property: Availability zones for resources.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
tags
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
identity
AmlFilesystemIdentity identity()Gets the identity property: The managed identity used by the AML file system, if configured.- Returns:
- the identity value.
-
sku
SkuName sku()Gets the sku property: SKU for the resource.- Returns:
- the sku value.
-
zones
Gets the zones property: Availability zones for resources. This field should only contain a single element in the array.- Returns:
- the zones value.
-
systemData
com.azure.core.management.SystemData systemData()Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.- Returns:
- the systemData value.
-
storageCapacityTiB
float storageCapacityTiB()Gets the storageCapacityTiB property: The size of the AML file system, in TiB. This might be rounded up.- Returns:
- the storageCapacityTiB value.
-
health
AmlFilesystemHealth health()Gets the health property: Health of the AML file system.- Returns:
- the health value.
-
provisioningState
AmlFilesystemProvisioningStateType provisioningState()Gets the provisioningState property: ARM provisioning state.- Returns:
- the provisioningState value.
-
filesystemSubnet
String filesystemSubnet()Gets the filesystemSubnet property: Subnet used for managing the AML file system and for client-facing operations. This subnet should have at least a /24 subnet mask within the VNET's address space.- Returns:
- the filesystemSubnet value.
-
mgsAddress
String mgsAddress()Gets the mgsAddress property: The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS).- Returns:
- the mgsAddress value.
-
mountCommand
String mountCommand()Gets the mountCommand property: Recommended command to mount the AML file system.- Returns:
- the mountCommand value.
-
lustreVersion
String lustreVersion()Gets the lustreVersion property: The version of Lustre running in the AML file system.- Returns:
- the lustreVersion value.
-
throughputProvisionedMBps
Integer throughputProvisionedMBps()Gets the throughputProvisionedMBps property: Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput.- Returns:
- the throughputProvisionedMBps value.
-
encryptionSettings
AmlFilesystemEncryptionSettings encryptionSettings()Gets the encryptionSettings property: Specifies encryption settings of the AML file system.- Returns:
- the encryptionSettings value.
-
maintenanceWindow
AmlFilesystemPropertiesMaintenanceWindow maintenanceWindow()Gets the maintenanceWindow property: Start time of a 30-minute weekly maintenance window.- Returns:
- the maintenanceWindow value.
-
hsm
Gets the hsm property: Hydration and archive settings and status.- Returns:
- the hsm value.
-
region
com.azure.core.management.Region region()Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()Gets the name of the resource region.- Returns:
- the name of the resource region.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
AmlFilesystemInner innerModel()Gets the inner com.azure.resourcemanager.storagecache.fluent.models.AmlFilesystemInner object.- Returns:
- the inner object.
-
update
AmlFilesystem.Update update()Begins update for the AmlFilesystem resource.- Returns:
- the stage of resource update.
-
refresh
AmlFilesystem refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
archiveWithResponse
com.azure.core.http.rest.Response<Void> archiveWithResponse(AmlFilesystemArchiveInfo archiveInfo, com.azure.core.util.Context context) Archive data from the AML file system.- Parameters:
archiveInfo
- Information about the archive operation.context
- The context to associate with this operation.- Returns:
- the
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
archive
void archive()Archive data from the AML file system.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
cancelArchiveWithResponse
com.azure.core.http.rest.Response<Void> cancelArchiveWithResponse(com.azure.core.util.Context context) Cancel archiving data from the AML file system.- Parameters:
context
- The context to associate with this operation.- Returns:
- the
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
cancelArchive
void cancelArchive()Cancel archiving data from the AML file system.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-