Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}?api-version=2023-05-01
URI Parameters
Name |
In |
Required |
Type |
Description |
accountName
|
path |
True
|
string
|
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
Regex pattern: ^[a-z0-9]+$
|
resourceGroupName
|
path |
True
|
string
|
The name of the resource group within the user's subscription. The name is case insensitive.
Regex pattern: ^[-\w\._\(\)]+$
|
shareName
|
path |
True
|
string
|
The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
|
subscriptionId
|
path |
True
|
string
|
The ID of the target subscription.
|
api-version
|
query |
True
|
string
|
The API version to use for this operation.
|
Request Body
Name |
Type |
Description |
properties.accessTier
|
ShareAccessTier
|
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
|
properties.enabledProtocols
|
EnabledProtocols
|
The authentication protocol that is used for the file share. Can only be specified when creating a share.
|
properties.metadata
|
object
|
A name-value pair to associate with the share as metadata.
|
properties.rootSquash
|
RootSquashType
|
The property is for NFS share only. The default is NoRootSquash.
|
properties.shareQuota
|
integer
|
The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.
|
properties.signedIdentifiers
|
SignedIdentifier[]
|
List of stored access policies specified on the share.
|
Responses
Name |
Type |
Description |
200 OK
|
FileShare
|
OK -- Update Share operation completed successfully.
|
Other Status Codes
|
CloudError
|
Error response describing why the operation failed.
|
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name |
Description |
user_impersonation
|
impersonate your user account
|
Examples
UpdateShareAcls
Sample request
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2023-05-01
{
"properties": {
"signedIdentifiers": [
{
"id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI",
"accessPolicy": {
"startTime": "2021-04-01T08:49:37.0000000Z",
"expiryTime": "2021-05-01T08:49:37.0000000Z",
"permission": "rwd"
}
}
]
}
}
import com.azure.resourcemanager.storage.fluent.models.FileShareInner;
import com.azure.resourcemanager.storage.models.AccessPolicy;
import com.azure.resourcemanager.storage.models.SignedIdentifier;
import java.time.OffsetDateTime;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
/**
* Samples for FileShares Update.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileShareAclsPatch.json
*/
/**
* Sample code: UpdateShareAcls.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void updateShareAcls(com.azure.resourcemanager.AzureResourceManager azure) {
azure.storageAccounts().manager().serviceClient().getFileShares().updateWithResponse("res3376", "sto328",
"share6185",
new FileShareInner().withSignedIdentifiers(Arrays.asList(new SignedIdentifier()
.withId("MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI")
.withAccessPolicy(new AccessPolicy().withStartTime(OffsetDateTime.parse("2021-04-01T08:49:37.0000000Z"))
.withExpiryTime(OffsetDateTime.parse("2021-05-01T08:49:37.0000000Z")).withPermission("rwd")))),
com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from typing import Any, IO, Union
from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-storage
# USAGE
python file_share_acls_patch.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = StorageManagementClient(
credential=DefaultAzureCredential(),
subscription_id="{subscription-id}",
)
response = client.file_shares.update(
resource_group_name="res3376",
account_name="sto328",
share_name="share6185",
file_share={
"properties": {
"signedIdentifiers": [
{
"accessPolicy": {
"expiryTime": "2021-05-01T08:49:37.0000000Z",
"permission": "rwd",
"startTime": "2021-04-01T08:49:37.0000000Z",
},
"id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI",
}
]
}
},
)
print(response)
# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileShareAclsPatch.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armstorage_test
import (
"context"
"log"
"time"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileShareAclsPatch.json
func ExampleFileSharesClient_Update_updateShareAcls() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewFileSharesClient().Update(ctx, "res3376", "sto328", "share6185", armstorage.FileShare{
FileShareProperties: &armstorage.FileShareProperties{
SignedIdentifiers: []*armstorage.SignedIdentifier{
{
AccessPolicy: &armstorage.AccessPolicy{
ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-01T08:49:37.000Z"); return t }()),
Permission: to.Ptr("rwd"),
StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T08:49:37.000Z"); return t }()),
},
ID: to.Ptr("MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI"),
}},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.FileShare = armstorage.FileShare{
// Name: to.Ptr("share6185"),
// Type: to.Ptr("Microsoft.Storage/storageAccounts/fileServices/shares"),
// ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185"),
// FileShareProperties: &armstorage.FileShareProperties{
// SignedIdentifiers: []*armstorage.SignedIdentifier{
// {
// AccessPolicy: &armstorage.AccessPolicy{
// ExpiryTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-01T08:49:37.000Z"); return t}()),
// Permission: to.Ptr("rwd"),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-01T08:49:37.000Z"); return t}()),
// },
// ID: to.Ptr("MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI"),
// }},
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
*
* @summary Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
* x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileShareAclsPatch.json
*/
async function updateShareAcls() {
const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res3376";
const accountName = "sto328";
const shareName = "share6185";
const fileShare = {
signedIdentifiers: [
{
accessPolicy: {
expiryTime: new Date("2021-05-01T08:49:37.0000000Z"),
permission: "rwd",
startTime: new Date("2021-04-01T08:49:37.0000000Z"),
},
id: "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI",
},
],
};
const credential = new DefaultAzureCredential();
const client = new StorageManagementClient(credential, subscriptionId);
const result = await client.fileShares.update(
resourceGroupName,
accountName,
shareName,
fileShare,
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"properties": {
"signedIdentifiers": [
{
"id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI",
"accessPolicy": {
"startTime": "2021-04-01T08:49:37.0000000Z",
"expiryTime": "2021-05-01T08:49:37.0000000Z",
"permission": "rwd"
}
}
]
}
}
UpdateShares
Sample request
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2023-05-01
{
"properties": {
"metadata": {
"type": "image"
}
}
}
import com.azure.resourcemanager.storage.fluent.models.FileShareInner;
import java.util.HashMap;
import java.util.Map;
/**
* Samples for FileShares Update.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileSharesPatch.json
*/
/**
* Sample code: UpdateShares.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void updateShares(com.azure.resourcemanager.AzureResourceManager azure) {
azure.storageAccounts().manager().serviceClient().getFileShares().updateWithResponse("res3376", "sto328",
"share6185", new FileShareInner().withMetadata(mapOf("type", "image")), com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from typing import Any, IO, Union
from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-storage
# USAGE
python file_shares_patch.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = StorageManagementClient(
credential=DefaultAzureCredential(),
subscription_id="{subscription-id}",
)
response = client.file_shares.update(
resource_group_name="res3376",
account_name="sto328",
share_name="share6185",
file_share={"properties": {"metadata": {"type": "image"}}},
)
print(response)
# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileSharesPatch.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armstorage_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileSharesPatch.json
func ExampleFileSharesClient_Update_updateShares() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewFileSharesClient().Update(ctx, "res3376", "sto328", "share6185", armstorage.FileShare{
FileShareProperties: &armstorage.FileShareProperties{
Metadata: map[string]*string{
"type": to.Ptr("image"),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.FileShare = armstorage.FileShare{
// Name: to.Ptr("share6185"),
// Type: to.Ptr("Microsoft.Storage/storageAccounts/fileServices/shares"),
// ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185"),
// FileShareProperties: &armstorage.FileShareProperties{
// Metadata: map[string]*string{
// "type": to.Ptr("image"),
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
*
* @summary Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
* x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileSharesPatch.json
*/
async function updateShares() {
const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res3376";
const accountName = "sto328";
const shareName = "share6185";
const fileShare = { metadata: { type: "image" } };
const credential = new DefaultAzureCredential();
const client = new StorageManagementClient(credential, subscriptionId);
const result = await client.fileShares.update(
resourceGroupName,
accountName,
shareName,
fileShare,
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"properties": {
"metadata": {
"type": "image"
}
}
}
Definitions
Name |
Description |
AccessPolicy
|
|
CloudError
|
An error response from the Storage service.
|
CloudErrorBody
|
An error response from the Storage service.
|
EnabledProtocols
|
The authentication protocol that is used for the file share. Can only be specified when creating a share.
|
FileShare
|
Properties of the file share, including Id, resource name, resource type, Etag.
|
LeaseDuration
|
Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
|
LeaseState
|
Lease state of the share.
|
LeaseStatus
|
The lease status of the share.
|
RootSquashType
|
The property is for NFS share only. The default is NoRootSquash.
|
ShareAccessTier
|
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
|
SignedIdentifier
|
|
AccessPolicy
Name |
Type |
Description |
expiryTime
|
string
|
Expiry time of the access policy
|
permission
|
string
|
List of abbreviated permissions.
|
startTime
|
string
|
Start time of the access policy
|
CloudError
An error response from the Storage service.
Name |
Type |
Description |
error
|
CloudErrorBody
|
An error response from the Storage service.
|
CloudErrorBody
An error response from the Storage service.
Name |
Type |
Description |
code
|
string
|
An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
|
details
|
CloudErrorBody[]
|
A list of additional details about the error.
|
message
|
string
|
A message describing the error, intended to be suitable for display in a user interface.
|
target
|
string
|
The target of the particular error. For example, the name of the property in error.
|
EnabledProtocols
The authentication protocol that is used for the file share. Can only be specified when creating a share.
Name |
Type |
Description |
NFS
|
string
|
|
SMB
|
string
|
|
FileShare
Properties of the file share, including Id, resource name, resource type, Etag.
Name |
Type |
Description |
etag
|
string
|
Resource Etag.
|
id
|
string
|
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
name
|
string
|
The name of the resource
|
properties.accessTier
|
ShareAccessTier
|
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
|
properties.accessTierChangeTime
|
string
|
Indicates the last modification time for share access tier.
|
properties.accessTierStatus
|
string
|
Indicates if there is a pending transition for access tier.
|
properties.deleted
|
boolean
|
Indicates whether the share was deleted.
|
properties.deletedTime
|
string
|
The deleted time if the share was deleted.
|
properties.enabledProtocols
|
EnabledProtocols
|
The authentication protocol that is used for the file share. Can only be specified when creating a share.
|
properties.lastModifiedTime
|
string
|
Returns the date and time the share was last modified.
|
properties.leaseDuration
|
LeaseDuration
|
Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
|
properties.leaseState
|
LeaseState
|
Lease state of the share.
|
properties.leaseStatus
|
LeaseStatus
|
The lease status of the share.
|
properties.metadata
|
object
|
A name-value pair to associate with the share as metadata.
|
properties.remainingRetentionDays
|
integer
|
Remaining retention days for share that was soft deleted.
|
properties.rootSquash
|
RootSquashType
|
The property is for NFS share only. The default is NoRootSquash.
|
properties.shareQuota
|
integer
|
The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.
|
properties.shareUsageBytes
|
integer
|
The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
|
properties.signedIdentifiers
|
SignedIdentifier[]
|
List of stored access policies specified on the share.
|
properties.snapshotTime
|
string
|
Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
|
properties.version
|
string
|
The version of the share.
|
type
|
string
|
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
|
LeaseDuration
Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
Name |
Type |
Description |
Fixed
|
string
|
|
Infinite
|
string
|
|
LeaseState
Lease state of the share.
Name |
Type |
Description |
Available
|
string
|
|
Breaking
|
string
|
|
Broken
|
string
|
|
Expired
|
string
|
|
Leased
|
string
|
|
LeaseStatus
The lease status of the share.
Name |
Type |
Description |
Locked
|
string
|
|
Unlocked
|
string
|
|
RootSquashType
The property is for NFS share only. The default is NoRootSquash.
Name |
Type |
Description |
AllSquash
|
string
|
|
NoRootSquash
|
string
|
|
RootSquash
|
string
|
|
ShareAccessTier
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
Name |
Type |
Description |
Cool
|
string
|
|
Hot
|
string
|
|
Premium
|
string
|
|
TransactionOptimized
|
string
|
|
SignedIdentifier
Name |
Type |
Description |
accessPolicy
|
AccessPolicy
|
Access policy
|
id
|
string
|
An unique identifier of the stored access policy.
|