ShareClient Class
- java.
lang. Object - com.
azure. storage. file. share. ShareClient
- com.
public class ShareClient
This class provides a client that contains all the operations for interacting with a share in Azure Storage Share. Operations allowed by the client are creating and deleting the share, creating snapshots for the share, creating and deleting directories in the share and retrieving and updating properties metadata and access policies of the share.
Instantiating a Synchronous Share Client
ShareClient client = new ShareClientBuilder()
.connectionString("${connectionString}")
.endpoint("${endpoint}")
.buildClient();
View ShareClientBuilder for additional ways to construct the client.
Method Summary
Methods inherited from java.lang.Object
Method Details
create
public ShareInfo create()
Creates the share in the storage account.
Code Samples
Create the share
ShareInfo response = shareClient.create();
System.out.println("Complete creating the shares with status code: " + response);
For more information, see the Azure Docs.
Returns:
createDirectory
public ShareDirectoryClient createDirectory(String directoryName)
Creates the directory in the share with the given name.
Code Samples
Create the directory "documents"
ShareDirectoryClient response = shareClient.createDirectory("mydirectory");
System.out.println("Complete creating the directory.");
For more information, see the Azure Docs.
Parameters:
Returns:
createDirectoryIfNotExists
public ShareDirectoryClient createDirectoryIfNotExists(String directoryName)
Creates the directory in the share with the given name if it does not exist.
Code Samples
Create the directory "documents"
ShareDirectoryClient directoryClient = shareClient.createDirectoryIfNotExists("mydirectory");
System.out.println("Complete creating the directory.");
For more information, see the Azure Docs.
Parameters:
Returns:
createDirectoryIfNotExistsWithResponse
public Response
Creates the directory if it does not exist in the share with the given name and associates the passed metadata to it.
Code Samples
Create the directory "documents" with metadata "directory:metadata"
FileSmbProperties smbProperties = new FileSmbProperties();
String filePermission = "filePermission";
Map<String, String> metadata = Collections.singletonMap("directory", "metadata");
ShareDirectoryCreateOptions options = new ShareDirectoryCreateOptions().setSmbProperties(smbProperties).
setFilePermission(filePermission).setMetadata(metadata);
Response<ShareDirectoryClient> response = shareClient.createDirectoryIfNotExistsWithResponse("documents",
options, Duration.ofSeconds(1), new Context(key1, value1));
if (response.getStatusCode() == 409) {
System.out.println("Already existed.");
} else {
System.out.printf("Create completed with status %d%n", response.getStatusCode());
}
For more information, see the Azure Docs.
Parameters:
Returns:
createDirectoryWithResponse
public Response
Creates the directory in the share with the given name and associates the passed metadata to it.
Code Samples
Create the directory "documents" with metadata "directory:metadata"
FileSmbProperties smbProperties = new FileSmbProperties();
String filePermission = "filePermission";
Response<ShareDirectoryClient> response = shareClient.createDirectoryWithResponse("documents",
smbProperties, filePermission, Collections.singletonMap("directory", "metadata"),
Duration.ofSeconds(1), new Context(key1, value1));
System.out.printf("Creating the directory completed with status code %d", response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
createFile
public ShareFileClient createFile(String fileName, long maxSize)
Creates the file in the share with the given name and file max size.
Code Samples
Create the file "myfile" with size of 1024 bytes.
ShareFileClient response = shareClient.createFile("myfile", 1024);
System.out.println("Complete creating the file with snapshot Id:" + response.getShareSnapshotId());
For more information, see the Azure Docs.
Parameters:
Returns:
createFileWithResponse
public Response
Creates the file in the share with the given name, file max size and associates the passed properties to it.
Code Samples
Create the file "myfile" with length of 1024 bytes, some headers, file smb properties and metadata
ShareFileHttpHeaders httpHeaders = new ShareFileHttpHeaders()
.setContentType("text/html")
.setContentEncoding("gzip")
.setContentLanguage("en")
.setCacheControl("no-transform")
.setContentDisposition("attachment");
FileSmbProperties smbProperties = new FileSmbProperties()
.setNtfsFileAttributes(EnumSet.of(NtfsFileAttributes.READ_ONLY))
.setFileCreationTime(OffsetDateTime.now())
.setFileLastWriteTime(OffsetDateTime.now())
.setFilePermissionKey("filePermissionKey");
String filePermission = "filePermission";
// NOTE: filePermission and filePermissionKey should never be both set
ShareRequestConditions requestConditions = new ShareRequestConditions().setLeaseId(leaseId);
Response<ShareFileClient> response = shareClient.createFileWithResponse("myfile", 1024,
httpHeaders, smbProperties, filePermission, Collections.singletonMap("directory", "metadata"),
requestConditions, Duration.ofSeconds(1), new Context(key1, value1));
System.out.printf("Creating the file completed with status code %d", response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
createFileWithResponse
public Response
Creates the file in the share with the given name, file max size and associates the passed properties to it.
Code Samples
Create the file "myfile" with length of 1024 bytes, some headers, file smb properties and metadata
ShareFileHttpHeaders httpHeaders = new ShareFileHttpHeaders()
.setContentType("text/html")
.setContentEncoding("gzip")
.setContentLanguage("en")
.setCacheControl("no-transform")
.setContentDisposition("attachment");
FileSmbProperties smbProperties = new FileSmbProperties()
.setNtfsFileAttributes(EnumSet.of(NtfsFileAttributes.READ_ONLY))
.setFileCreationTime(OffsetDateTime.now())
.setFileLastWriteTime(OffsetDateTime.now())
.setFilePermissionKey("filePermissionKey");
String filePermission = "filePermission";
// NOTE: filePermission and filePermissionKey should never be both set
Response<ShareFileClient> response = shareClient.createFileWithResponse("myfile", 1024,
httpHeaders, smbProperties, filePermission, Collections.singletonMap("directory", "metadata"),
Duration.ofSeconds(1), new Context(key1, value1));
System.out.printf("Creating the file completed with status code %d", response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
createIfNotExists
public ShareInfo createIfNotExists()
Creates the share in the storage account if it does not exist.
Code Samples
Create the share
shareClient.createIfNotExists();
System.out.println("Completed creating the share.");
For more information, see the Azure Docs.
Returns:
createIfNotExistsWithResponse
public Response
Creates the share in the storage account with the specified options if it does not exist.
Code Samples
Response<ShareInfo> response = shareClient.createIfNotExistsWithResponse(new ShareCreateOptions()
.setMetadata(Collections.singletonMap("share", "metadata")).setQuotaInGb(1)
.setAccessTier(ShareAccessTier.HOT), Duration.ofSeconds(1), new Context(key1, value1));
if (response.getStatusCode() == 409) {
System.out.println("Already existed.");
} else {
System.out.printf("Create completed with status %d%n", response.getStatusCode());
}
For more information, see the Azure Docs.
Parameters:
Returns:
createPermission
public String createPermission(ShareFilePermission filePermission)
Creates a permission at the share level. If a permission already exists, it returns the key of it, else creates a new permission and returns the key.
Code Samples
ShareFilePermission permission = new ShareFilePermission().setPermission("filePermission")
.setPermissionFormat(FilePermissionFormat.BINARY);
String response1 = shareClient.createPermission(permission);
System.out.printf("The file permission key is %s", response1);
Parameters:
Returns:
createPermission
public String createPermission(String filePermission)
Creates a permission at the share level. If a permission already exists, it returns the key of it, else creates a new permission and returns the key.
Code Samples
String response = shareClient.createPermission("filePermission");
System.out.printf("The file permission key is %s", response);
Parameters:
Returns:
createPermissionWithResponse
public Response
Creates a permission at the share level. If a permission already exists, it returns the key of it, else creates a new permission and returns the key.
Code Samples
ShareFilePermission permission = new ShareFilePermission().setPermission("filePermission")
.setPermissionFormat(FilePermissionFormat.BINARY);
Response<String> response1 = shareClient.createPermissionWithResponse(permission, null, Context.NONE);
System.out.printf("The file permission key is %s", response1.getValue());
Parameters:
Returns:
createPermissionWithResponse
public Response
Creates a permission t the share level. If a permission already exists, it returns the key of it, else creates a new permission and returns the key.
Code Samples
Response<String> response = shareClient.createPermissionWithResponse("filePermission", Context.NONE);
System.out.printf("The file permission key is %s", response.getValue());
Parameters:
Returns:
createSnapshot
public ShareSnapshotInfo createSnapshot()
Creates a snapshot of the share with the same metadata associated to the share at the time of creation.
Code Samples
Create a snapshot
ShareSnapshotInfo response = shareClient.createSnapshot();
System.out.println("Complete creating the share snpashot with snapshot id: " + response.getSnapshot());
For more information, see the Azure Docs.
Returns:
createSnapshotWithResponse
public Response
Creates a snapshot of the share with the metadata that was passed associated to the snapshot.
Code Samples
Create a snapshot with metadata "snapshot:metadata"
Response<ShareSnapshotInfo> response =
shareClient.createSnapshotWithResponse(Collections.singletonMap("snpashot", "metadata"),
Duration.ofSeconds(1), new Context(key1, value1));
System.out.println("Complete creating the share snpashot with snapshot id: " + response.getValue().getSnapshot());
For more information, see the Azure Docs.
Parameters:
null the metadata of the share will
be copied to the snapshot.
Returns:
createWithResponse
public Response
Creates the share in the storage account with the specified options.
Code Samples
Response<ShareInfo> response = shareClient.createWithResponse(new ShareCreateOptions()
.setMetadata(Collections.singletonMap("share", "metadata")).setQuotaInGb(1)
.setAccessTier(ShareAccessTier.HOT), Duration.ofSeconds(1), new Context(key1, value1));
System.out.println("Complete creating the shares with status code: " + response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
createWithResponse
public Response
Creates the share in the storage account with the specified metadata and quota.
Code Samples
Create the share with metadata "share:metadata"
Response<ShareInfo> response = shareClient.createWithResponse(Collections.singletonMap("share", "metadata"),
null, Duration.ofSeconds(1), new Context(key1, value1));
System.out.println("Complete creating the shares with status code: " + response.getStatusCode());
Create the share with a quota of 10 GB
Response<ShareInfo> response = shareClient.createWithResponse(null, 10,
Duration.ofSeconds(1), new Context(key1, value1));
System.out.println("Complete creating the shares with status code: " + response.getStatusCode());
For more information, see the Azure Docs.
For more information on updated max file share size values, see the Azure Docs.
Parameters:
Returns:
delete
public void delete()
Deletes the share in the storage account
Code Samples
Delete the share
shareClient.delete();
System.out.println("Completed deleting the share.");
For more information, see the Azure Docs.
deleteDirectory
public void deleteDirectory(String directoryName)
Deletes the specified directory in the share.
Code Samples
Delete the directory "mydirectory"
shareClient.deleteDirectory("mydirectory");
System.out.println("Completed deleting the directory.");
For more information, see the Azure Docs.
Parameters:
deleteDirectoryIfExists
public boolean deleteDirectoryIfExists(String directoryName)
Deletes the specified directory in the share if it exists.
Code Samples
Delete the directory "mydirectory"
boolean result = shareClient.deleteDirectoryIfExists("mydirectory");
System.out.println("Directory deleted: " + result);
For more information, see the Azure Docs.
Parameters:
Returns:
true if the directory is successfully deleted, false if the directory does not exist.deleteDirectoryIfExistsWithResponse
public Response
Deletes the specified directory in the share if it exists.
Code Samples
Delete the directory "mydirectory"
Response<Boolean> response = shareClient.deleteDirectoryIfExistsWithResponse("mydirectory",
Duration.ofSeconds(1), new Context(key1, value1));
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.printf("Delete completed with status %d%n", response.getStatusCode());
}
For more information, see the Azure Docs.
Parameters:
Returns:
deleteDirectoryWithResponse
public Response
Deletes the specified directory in the share.
Code Samples
Delete the directory "mydirectory"
Response<Void> response = shareClient.deleteDirectoryWithResponse("mydirectory",
Duration.ofSeconds(1), new Context(key1, value1));
System.out.println("Complete deleting the directory with status code: " + response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
deleteFile
public void deleteFile(String fileName)
Deletes the specified file in the share.
Code Samples
Delete the file "myfile"
shareClient.deleteFile("myfile");
System.out.println("Complete deleting the file.");
For more information, see the Azure Docs.
Parameters:
deleteFileIfExists
public boolean deleteFileIfExists(String fileName)
Deletes the specified file in the share if it exists.
Code Samples
Delete the file "myfile"
boolean result = shareClient.deleteFileIfExists("myfile");
System.out.println("File deleted: " + result);
For more information, see the Azure Docs.
Parameters:
Returns:
true if the file is successfully deleted, false if the file does not exist.deleteFileIfExistsWithResponse
public Response
Deletes the specified file in the share if it exists.
Code Samples
Delete the file "myfile"
ShareRequestConditions requestConditions = new ShareRequestConditions().setLeaseId(leaseId);
Response<Boolean> response = shareClient.deleteFileIfExistsWithResponse("myfile", requestConditions,
Duration.ofSeconds(1), new Context(key1, value1));
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.printf("Delete completed with status %d%n", response.getStatusCode());
}
For more information, see the Azure Docs.
Parameters:
Returns:
deleteFileWithResponse
public Response
Deletes the specified file in the share.
Code Samples
Delete the file "myfile"
ShareRequestConditions requestConditions = new ShareRequestConditions().setLeaseId(leaseId);
Response<Void> response = shareClient.deleteFileWithResponse("myfile", requestConditions,
Duration.ofSeconds(1), new Context(key1, value1));
System.out.println("Complete deleting the file with status code: " + response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
deleteFileWithResponse
public Response
Deletes the specified file in the share.
Code Samples
Delete the file "myfile"
Response<Void> response = shareClient.deleteFileWithResponse("myfile",
Duration.ofSeconds(1), new Context(key1, value1));
System.out.println("Complete deleting the file with status code: " + response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
deleteIfExists
public boolean deleteIfExists()
Deletes the share in the storage account if it exists.
Code Samples
Delete the share
boolean result = shareClient.deleteIfExists();
System.out.println("Share deleted: " + result);
For more information, see the Azure Docs.
Returns:
true if the share is successfully deleted, false if the share does not exist.deleteIfExistsWithResponse
public Response
Deletes the share in the storage account if it exists.
Code Samples
Delete the share
Response<Boolean> response = shareClient.deleteIfExistsWithResponse(new ShareDeleteOptions()
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)),
Duration.ofSeconds(1), new Context(key1, value1));
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.printf("Delete completed with status %d%n", response.getStatusCode());
}
For more information, see the Azure Docs.
Parameters:
Returns:
deleteWithResponse
public Response
Deletes the share in the storage account
Code Samples
Delete the share
Response<Void> response = shareClient.deleteWithResponse(new ShareDeleteOptions()
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)),
Duration.ofSeconds(1), new Context(key1, value1));
System.out.println("Complete deleting the share with status code: " + response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
deleteWithResponse
public Response
Deletes the share in the storage account
Code Samples
Delete the share
Response<Void> response = shareClient.deleteWithResponse(Duration.ofSeconds(1), new Context(key1, value1));
System.out.println("Complete deleting the share with status code: " + response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
exists
public Boolean exists()
Determines if the share this client represents exists in the cloud.
Code Samples
System.out.printf("Exists? %b%n", client.exists());
Returns:
existsWithResponse
public Response
Determines if the share this client represents exists in the cloud.
Code Samples
Context context = new Context("Key", "Value");
System.out.printf("Exists? %b%n", client.existsWithResponse(timeout, context).getValue());
Parameters:
Returns:
generateSas
public String generateSas(ShareServiceSasSignatureValues shareServiceSasSignatureValues)
Generates a service sas for the queue using the specified ShareServiceSasSignatureValues
Note : The client must be authenticated via StorageSharedKeyCredential
See ShareServiceSasSignatureValues for more information on how to construct a service SAS.
Code Samples
OffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1);
ShareSasPermission permission = new ShareSasPermission().setReadPermission(true);
ShareServiceSasSignatureValues values = new ShareServiceSasSignatureValues(expiryTime, permission)
.setStartTime(OffsetDateTime.now());
shareAsyncClient.generateSas(values); // Client must be authenticated via StorageSharedKeyCredential
Parameters:
Returns:
String representing the SAS query parameters.generateSas
public String generateSas(ShareServiceSasSignatureValues shareServiceSasSignatureValues, Context context)
Generates a service sas for the queue using the specified ShareServiceSasSignatureValues
Note : The client must be authenticated via StorageSharedKeyCredential
See ShareServiceSasSignatureValues for more information on how to construct a service SAS.
Code Samples
OffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1);
ShareSasPermission permission = new ShareSasPermission().setReadPermission(true);
ShareServiceSasSignatureValues values = new ShareServiceSasSignatureValues(expiryTime, permission)
.setStartTime(OffsetDateTime.now());
// Client must be authenticated via StorageSharedKeyCredential
shareAsyncClient.generateSas(values, new Context("key", "value"));
Parameters:
Returns:
String representing the SAS query parameters.generateSas
public String generateSas(ShareServiceSasSignatureValues shareServiceSasSignatureValues, Consumer
Generates a service sas for the queue using the specified ShareServiceSasSignatureValues
Note : The client must be authenticated via StorageSharedKeyCredential
See ShareServiceSasSignatureValues for more information on how to construct a service SAS.
Parameters:
Returns:
String representing the SAS query parameters.getAccessPolicy
public PagedIterable
Retrieves stored access policies specified for the share.
Code Samples
List the stored access policies
for (ShareSignedIdentifier result : shareClient.getAccessPolicy()) {
System.out.printf("Access policy %s allows these permissions: %s",
result.getId(), result.getAccessPolicy().getPermissions());
}
For more information, see the Azure Docs.
Returns:
getAccessPolicy
public PagedIterable
Retrieves stored access policies specified for the share.
Code Samples
List the stored access policies
for (ShareSignedIdentifier result : shareClient
.getAccessPolicy(new ShareGetAccessPolicyOptions()
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)))) {
System.out.printf("Access policy %s allows these permissions: %s",
result.getId(), result.getAccessPolicy().getPermissions());
}
For more information, see the Azure Docs.
Parameters:
Returns:
getAccountName
public String getAccountName()
Get associated account name.
Returns:
getAccountUrl
public String getAccountUrl()
Get the url of the storage account.
Returns:
getDirectoryClient
public ShareDirectoryClient getDirectoryClient(String directoryName)
Constructs a ShareDirectoryClient that interacts with the specified directory.
If the directory doesn't exist in the share create() in the client will need to be called before interaction with the directory can happen.
Parameters:
Returns:
getFileClient
public ShareFileClient getFileClient(String filePath)
Constructs a ShareFileClient that interacts with the specified file.
If the file doesn't exist in the share create(long maxSize) ) create} in the client will need to be called before interaction with the file can happen.
Parameters:
Returns:
getHttpPipeline
public HttpPipeline getHttpPipeline()
Gets the HttpPipeline powering this client.
Returns:
getPermission
public String getPermission(String filePermissionKey)
Gets a permission for a given key
Code Samples
String response = shareClient.getPermission("filePermissionKey");
System.out.printf("The file permission is %s", response);
Parameters:
Returns:
getPermission
public String getPermission(String filePermissionKey, FilePermissionFormat filePermissionFormat)
Gets a permission for a given key
Code Samples
FilePermissionFormat filePermissionFormat = FilePermissionFormat.BINARY;
String response2 = shareClient.getPermission("filePermissionKey", filePermissionFormat);
System.out.printf("The file permission is %s", response2);
Parameters:
Returns:
getPermissionWithResponse
public Response
Gets a permission for a given key.
Code Samples
Response<String> response = shareClient.getPermissionWithResponse("filePermissionKey", Context.NONE);
System.out.printf("The file permission is %s", response.getValue());
Parameters:
Returns:
getPermissionWithResponse
public Response
Gets a permission for a given key.
Code Samples
FilePermissionFormat filePermissionFormat = FilePermissionFormat.BINARY;
Response<String> response1 = shareClient.getPermissionWithResponse("filePermissionKey",
filePermissionFormat, null, Context.NONE);
System.out.printf("The file permission is %s", response1.getValue());
Parameters:
Returns:
getProperties
public ShareProperties getProperties()
Retrieves the properties of the share, these include the metadata associated to it and the quota that the share is restricted to.
Code Samples
Retrieve the share properties
ShareProperties properties = shareClient.getProperties();
System.out.printf("Share quota: %d, Metadata: %s", properties.getQuota(), properties.getMetadata());
For more information, see the Azure Docs.
Returns:
getPropertiesWithResponse
public Response
Retrieves the properties of the share, these include the metadata associated to it and the quota that the share is restricted to.
Code Samples
Retrieve the share properties
ShareProperties properties = shareClient.getPropertiesWithResponse(new ShareGetPropertiesOptions()
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)),
Duration.ofSeconds(1), new Context(key1, value1)).getValue();
System.out.printf("Share quota: %d, Metadata: %s", properties.getQuota(), properties.getMetadata());
For more information, see the Azure Docs.
Parameters:
Returns:
getPropertiesWithResponse
public Response
Retrieves the properties of the share, these include the metadata associated to it and the quota that the share is restricted to.
Code Samples
Retrieve the share properties
ShareProperties properties = shareClient.getPropertiesWithResponse(
Duration.ofSeconds(1), new Context(key1, value1)).getValue();
System.out.printf("Share quota: %d, Metadata: %s", properties.getQuota(), properties.getMetadata());
For more information, see the Azure Docs.
Parameters:
Returns:
getRootDirectoryClient
public ShareDirectoryClient getRootDirectoryClient()
Constructs a ShareDirectoryClient that interacts with the root directory in the share.
If the directory doesn't exist in the share create() in the client will need to be called before interaction with the directory can happen.
Returns:
getServiceVersion
public ShareServiceVersion getServiceVersion()
Gets the service version the client is using.
Returns:
getShareName
public String getShareName()
Get share name from share client.
Code Samples
String shareName = shareClient.getShareName();
System.out.println("The name of the share is " + shareName);
Returns:
getShareUrl
public String getShareUrl()
Get the url of the storage share client.
Returns:
getSnapshotClient
public ShareClient getSnapshotClient(String snapshot)
Creates a new ShareAsyncClient linked to the snapshot of this share resource.
Parameters:
Returns:
getSnapshotId
public String getSnapshotId()
Get snapshot id which attached to ShareClient. Return null if no snapshot id attached.
Code Samples
Get the share snapshot id.
OffsetDateTime currentTime = OffsetDateTime.of(LocalDateTime.now(), ZoneOffset.UTC);
ShareClient shareClient = new ShareClientBuilder().endpoint("https://${accountName}.file.core.windows.net")
.sasToken("${SASToken}")
.shareName("myshare")
.snapshot(currentTime.toString())
.buildClient();
System.out.printf("Snapshot ID: %s%n", shareClient.getSnapshotId());
Returns:
DateTime value that identifies the share snapshot to its base
share.getStatistics
public ShareStatistics getStatistics()
Retrieves storage statistics about the share.
Code Samples
Retrieve the storage statistics
ShareStatistics response = shareClient.getStatistics();
System.out.printf("The share is using %d GB", response.getShareUsageInGB());
For more information, see the Azure Docs.
Returns:
getStatisticsWithResponse
public Response
Retrieves storage statistics about the share.
Code Samples
Retrieve the storage statistics
Response<ShareStatistics> response = shareClient.getStatisticsWithResponse(
new ShareGetStatisticsOptions().setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)),
Duration.ofSeconds(1), new Context(key1, value1));
System.out.printf("The share is using %d GB", response.getValue().getShareUsageInGB());
For more information, see the Azure Docs.
Parameters:
Returns:
getStatisticsWithResponse
public Response
Retrieves storage statistics about the share.
Code Samples
Retrieve the storage statistics
Response<ShareStatistics> response = shareClient.getStatisticsWithResponse(
Duration.ofSeconds(1), new Context(key1, value1));
System.out.printf("The share is using %d GB", response.getValue().getShareUsageInGB());
For more information, see the Azure Docs.
Parameters:
Returns:
setAccessPolicy
public ShareInfo setAccessPolicy(List
Sets stored access policies for the share.
Code Samples
Set a read only stored access policy
ShareAccessPolicy accessPolicy = new ShareAccessPolicy().setPermissions("r")
.setStartsOn(OffsetDateTime.now(ZoneOffset.UTC))
.setExpiresOn(OffsetDateTime.now(ZoneOffset.UTC).plusDays(10));
ShareSignedIdentifier permission = new ShareSignedIdentifier().setId("mypolicy").setAccessPolicy(accessPolicy);
shareClient.setAccessPolicy(Collections.singletonList(permission));
System.out.println("Setting access policies completed.");
For more information, see the Azure Docs.
Parameters:
Returns:
setAccessPolicyWithResponse
public Response
Sets stored access policies for the share.
Code Samples
Set a read only stored access policy
ShareAccessPolicy accessPolicy = new ShareAccessPolicy().setPermissions("r")
.setStartsOn(OffsetDateTime.now(ZoneOffset.UTC))
.setExpiresOn(OffsetDateTime.now(ZoneOffset.UTC).plusDays(10));
ShareSignedIdentifier permission = new ShareSignedIdentifier().setId("mypolicy").setAccessPolicy(accessPolicy);
Response<ShareInfo> response = shareClient.setAccessPolicyWithResponse(
new ShareSetAccessPolicyOptions().setPermissions(Collections.singletonList(permission))
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)),
Duration.ofSeconds(1), new Context(key1, value1));
System.out.printf("Setting access policies completed with status code %d", response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
setAccessPolicyWithResponse
public Response
Sets stored access policies for the share.
Code Samples
Set a read only stored access policy
ShareAccessPolicy accessPolicy = new ShareAccessPolicy().setPermissions("r")
.setStartsOn(OffsetDateTime.now(ZoneOffset.UTC))
.setExpiresOn(OffsetDateTime.now(ZoneOffset.UTC).plusDays(10));
ShareSignedIdentifier permission = new ShareSignedIdentifier().setId("mypolicy").setAccessPolicy(accessPolicy);
Response<ShareInfo> response = shareClient.setAccessPolicyWithResponse(Collections.singletonList(permission),
Duration.ofSeconds(1), new Context(key1, value1));
System.out.printf("Setting access policies completed with status code %d", response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
setMetadata
public ShareInfo setMetadata(Map
Sets the user-defined metadata to associate to the share.
If null is passed for the metadata it will clear the metadata associated to the share.
Code Samples
Set the metadata to "share:updatedMetadata"
shareClient.setMetadata(Collections.singletonMap("share", "updatedMetadata"));
System.out.println("Setting the share metadata.");
Clear the metadata of the share
shareClient.setMetadata(null);
System.out.println("Clear metadata completed.");
For more information, see the Azure Docs.
Parameters:
Returns:
setMetadataWithResponse
public Response
Sets the user-defined metadata to associate to the share.
If null is passed for the metadata it will clear the metadata associated to the share.
Code Samples
Set the metadata to "share:updatedMetadata"
Response<ShareInfo> response = shareClient.setMetadataWithResponse(new ShareSetMetadataOptions()
.setMetadata(Collections.singletonMap("share", "updatedMetadata"))
.setRequestConditions(new ShareRequestConditions().setLeaseId(leaseId)),
Duration.ofSeconds(1),
new Context(key1, value1));
System.out.printf("Setting the share metadata completed with status code %d", response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
setMetadataWithResponse
public Response
Sets the user-defined metadata to associate to the share.
If null is passed for the metadata it will clear the metadata associated to the share.
Code Samples
Set the metadata to "share:updatedMetadata"
Response<ShareInfo> response = shareClient.setMetadataWithResponse(
Collections.singletonMap("share", "updatedMetadata"), Duration.ofSeconds(1),
new Context(key1, value1));
System.out.printf("Setting the share metadata completed with status code %d", response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
setProperties
public ShareInfo setProperties(ShareSetPropertiesOptions options)
Sets the share's properties.
Code Samples
System.out.println("Setting the share access tier completed." + shareClient.setProperties(
new ShareSetPropertiesOptions().setAccessTier(ShareAccessTier.HOT).setQuotaInGb(1024)));
For more information, see the Azure Docs.
Parameters:
Returns:
setPropertiesWithResponse
public Response
Sets the share's properties.
Code Samples
Response<ShareInfo> response = shareClient.setPropertiesWithResponse(
new ShareSetPropertiesOptions().setAccessTier(ShareAccessTier.HOT).setQuotaInGb(1024),
Duration.ofSeconds(1), new Context(key1, value1));
System.out.printf("Setting the share access tier completed with status code %d", response.getStatusCode());
For more information, see the Azure Docs.
Parameters:
Returns:
setQuota
@Deprecated
public ShareInfo setQuota(int quotaInGB)
Deprecated
Sets the maximum size in GB that the share is allowed to grow.
Code Samples
Set the quota to 1024 GB
System.out.println("Setting the share quota completed." + shareClient.setQuota(1024));
For more information, see the Azure Docs.
For more information on updated max file share size values, see the Azure Docs.
Parameters:
Returns:
setQuotaWithResponse
@Deprecated
public Response
Deprecated
Sets the maximum size in GB that the share is allowed to grow.
Code Samples
Set the quota to 1024 GB
Response<ShareInfo> response = shareClient.setQuotaWithResponse(1024,
Duration.ofSeconds(1), new Context(key1, value1));
System.out.printf("Setting the share quota completed with status code %d", response.getStatusCode());
For more information, see the Azure Docs.
For more information on updated max file share size values, see the Azure Docs.
Parameters:
Returns:
