File Shares - Update
Обновляет свойства общих ресурсов, как указано в теле запроса. Свойства, не указанные в запросе, не будут изменены. Обновление завершается ошибкой, если указанная общая папка еще не существует.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}?api-version=2025-06-01
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
account
|
path | True |
string minLength: 3maxLength: 24 pattern: ^[a-z0-9]+$ |
Имя учетной записи хранения в указанной группе ресурсов. Имена учетных записей хранения должны быть от 3 до 24 символов длиной и использовать только цифры и строчные буквы. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+$ |
Имя группы ресурсов в подписке пользователя. Имя не зависит от регистра. |
|
share
|
path | True |
string minLength: 3maxLength: 63 |
Имя общей папки в указанной учетной записи хранения. Имена общих папок должны содержать от 3 до 63 символов и содержать только цифры, строчные буквы и тире (-). Каждому символу тире (-) должна предшествовать буква или цифра, а за ним должна стоять буква или цифра. |
|
subscription
|
path | True |
string minLength: 1 |
Идентификатор целевой подписки. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Текст запроса
| Имя | Тип | Описание |
|---|---|---|
| properties.accessTier |
Уровень доступа для определенной общей папки. Учетная запись GpV2 может выбирать между TransactionOptimized (по умолчанию), горячей и холодной. Учетная запись FileStorage может выбрать Premium. |
|
| properties.enabledProtocols |
Протокол проверки подлинности, используемый для общей папки. Можно указать только при создании общей папки. |
|
| properties.fileSharePaidBursting |
Свойства платного ускорения общей папки. |
|
| properties.metadata |
object |
Пара "имя-значение", связанная с общей папкой в качестве метаданных. |
| properties.provisionedBandwidthMibps |
integer (int32) |
Подготовленная пропускная способность общей папки в мбибайтах в секунду. Это свойство предназначено только для общих папок, созданных в разделе "Подготовленные файлы" версии 2. Обратитесь к ответу API GetFileServiceUsage для минимального и максимального допустимого значения подготовленной пропускной способности. |
| properties.provisionedIops |
integer (int32) |
Подготовленные операции ввода-вывода в секунду общего ресурса. Это свойство предназначено только для общих папок, созданных в разделе "Подготовленные файлы" версии 2. Обратитесь к ответу API GetFileServiceUsage минимальное и максимально допустимое значение для подготовленных операций ввода-вывода в секунду. |
| properties.rootSquash |
Свойство предназначено только для общего ресурса NFS. Значение по умолчанию — NoRootSquash. |
|
| properties.shareQuota |
integer (int32) |
Подготовленный размер общей папки в гибибайтах. Должно быть больше 0 и меньше или равно 5TB (5120). Для больших общих папок максимальный размер — 102400. Для общих папок, созданных в разделе "Подготовленные файлы" типа учетной записи версии 2, обратитесь к ответу API GetFileServiceUsage для минимального и максимального допустимого размера подготовленного хранилища. |
| properties.signedIdentifiers |
Список хранимых политик доступа, указанных в общей папке. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
OK -- Операция Update Share успешно завершена. |
|
| Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
|
Update |
|
Update |
|
Update |
|
Update |
UpdateShareAcls
Образец запроса
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-06-01
{
"properties": {
"signedIdentifiers": [
{
"id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI",
"accessPolicy": {
"startTime": "2021-04-01T08:49:37.0000000Z",
"expiryTime": "2021-05-01T08:49:37.0000000Z",
"permission": "rwd"
}
}
]
}
}
Пример ответа
{
"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"
}
}
]
}
}
UpdateSharePaidBursting
Образец запроса
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-06-01
{
"properties": {
"fileSharePaidBursting": {
"paidBurstingEnabled": true,
"paidBurstingMaxIops": 102400,
"paidBurstingMaxBandwidthMibps": 10340
}
}
}
Пример ответа
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"properties": {
"fileSharePaidBursting": {
"paidBurstingEnabled": true,
"paidBurstingMaxIops": 102400,
"paidBurstingMaxBandwidthMibps": 10340
}
}
}
UpdateShareProvisionedV2
Образец запроса
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-06-01
{
"properties": {
"shareQuota": 100,
"provisionedIops": 5000,
"provisionedBandwidthMibps": 200
}
}
Пример ответа
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"properties": {
"shareQuota": 100,
"provisionedIops": 5000,
"provisionedBandwidthMibps": 200,
"includedBurstIops": 15000,
"maxBurstCreditsForIops": 36000000,
"nextAllowedQuotaDowngradeTime": "Sat, 26 Oct 2024 01:50:50 GMT",
"nextAllowedProvisionedIopsDowngradeTime": "Fri, 25 Oct 2024 01:48:09 GMT",
"nextAllowedProvisionedBandwidthDowngradeTime": "Fri, 25 Oct 2024 01:48:09 GMT"
}
}
UpdateShares
Образец запроса
Пример ответа
{
"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"
}
}
}
Определения
| Имя | Описание |
|---|---|
|
Access |
|
|
Cloud |
Ответ об ошибке из службы хранилища. |
|
Cloud |
Ответ об ошибке из службы хранилища. |
|
Enabled |
Протокол проверки подлинности, используемый для общей папки. Можно указать только при создании общей папки. |
|
File |
Свойства общей папки, включая идентификатор, имя ресурса, тип ресурса, Etag. |
|
File |
Свойства платного ускорения общей папки. |
|
Lease |
Указывает, является ли аренда общей папки бессрочной или фиксированной, только когда общая папка арендована. |
|
Lease |
Состояние аренды акции. |
|
Lease |
Статус аренды акции. |
|
Root |
Свойство предназначено только для общего ресурса NFS. Значение по умолчанию — NoRootSquash. |
|
Share |
Уровень доступа для определенной общей папки. Учетная запись GpV2 может выбирать между TransactionOptimized (по умолчанию), горячей и холодной. Учетная запись FileStorage может выбрать Premium. |
|
Signed |
AccessPolicy
| Имя | Тип | Описание |
|---|---|---|
| expiryTime |
string (date-time) |
Срок действия политики доступа |
| permission |
string |
Список сокращенных разрешений. |
| startTime |
string (date-time) |
Время начала политики доступа |
CloudError
Ответ об ошибке из службы хранилища.
| Имя | Тип | Описание |
|---|---|---|
| error |
Ответ об ошибке из службы хранилища. |
CloudErrorBody
Ответ об ошибке из службы хранилища.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования. |
| details |
Список дополнительных сведений об ошибке. |
|
| message |
string |
Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе. |
| target |
string |
Целевой объект конкретной ошибки. Например, имя свойства в ошибке. |
EnabledProtocols
Протокол проверки подлинности, используемый для общей папки. Можно указать только при создании общей папки.
| Значение | Описание |
|---|---|
| SMB | |
| NFS |
FileShare
Свойства общей папки, включая идентификатор, имя ресурса, тип ресурса, Etag.
| Имя | Тип | Описание |
|---|---|---|
| etag |
string |
Etag ресурса. |
| id |
string |
Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
Имя ресурса |
| properties.accessTier |
Уровень доступа для определенной общей папки. Учетная запись GpV2 может выбирать между TransactionOptimized (по умолчанию), горячей и холодной. Учетная запись FileStorage может выбрать Premium. |
|
| properties.accessTierChangeTime |
string (date-time) |
Указывает время последнего изменения для уровня доступа к общему доступу. |
| properties.accessTierStatus |
string |
Указывает, есть ли ожидающий переход для уровня доступа. |
| properties.deleted |
boolean |
Указывает, была ли удалена общая папка. |
| properties.deletedTime |
string (date-time) |
Время удаления, если общая папка была удалена. |
| properties.enabledProtocols |
Протокол проверки подлинности, используемый для общей папки. Можно указать только при создании общей папки. |
|
| properties.fileSharePaidBursting |
Свойства платного ускорения общей папки. |
|
| properties.includedBurstIops |
integer (int32) |
Рассчитанное количество операций ввода-вывода в секунду для общего ресурса. Это свойство предназначено только для общих папок, созданных в разделе "Подготовленные файлы" версии 2. |
| properties.lastModifiedTime |
string (date-time) |
Возвращает дату и время последнего изменения общей папки. |
| properties.leaseDuration |
Указывает, является ли аренда общей папки бессрочной или фиксированной, только когда общая папка арендована. |
|
| properties.leaseState |
Состояние аренды акции. |
|
| properties.leaseStatus |
Статус аренды акции. |
|
| properties.maxBurstCreditsForIops |
integer (int64) |
Рассчитанное максимальное количество кредитов на всплеск для шары. Это свойство предназначено только для общих папок, созданных в разделе "Подготовленные файлы" версии 2. |
| properties.metadata |
object |
Пара "имя-значение", связанная с общей папкой в качестве метаданных. |
| properties.nextAllowedProvisionedBandwidthDowngradeTime |
string (date-time-rfc1123) |
Возвращает следующее разрешенное время понижения выделенной пропускной способности для общей папки. Это свойство предназначено только для общих папок, созданных в разделе "Подготовленные файлы" версии 2. |
| properties.nextAllowedProvisionedIopsDowngradeTime |
string (date-time-rfc1123) |
Возвращает следующее разрешенное время понижения уровня подготовленных операций ввода-вывода в секунду для общей папки. Это свойство предназначено только для общих папок, созданных в разделе "Подготовленные файлы" версии 2. |
| properties.nextAllowedQuotaDowngradeTime |
string (date-time-rfc1123) |
Возвращает следующее допустимое время уменьшения размера подготовленного хранилища для общей папки. Это свойство доступно только для общих папок, созданных с типом учетной записи SSD Files Provisioned v1 и Files Provisioned v2 |
| properties.provisionedBandwidthMibps |
integer (int32) |
Подготовленная пропускная способность общей папки в мбибайтах в секунду. Это свойство предназначено только для общих папок, созданных в разделе "Подготовленные файлы" версии 2. Обратитесь к ответу API GetFileServiceUsage для минимального и максимального допустимого значения подготовленной пропускной способности. |
| properties.provisionedIops |
integer (int32) |
Подготовленные операции ввода-вывода в секунду общего ресурса. Это свойство предназначено только для общих папок, созданных в разделе "Подготовленные файлы" версии 2. Обратитесь к ответу API GetFileServiceUsage минимальное и максимально допустимое значение для подготовленных операций ввода-вывода в секунду. |
| properties.remainingRetentionDays |
integer |
Оставшиеся дни хранения для обратимо удаленной общей папки. |
| properties.rootSquash |
Свойство предназначено только для общего ресурса NFS. Значение по умолчанию — NoRootSquash. |
|
| properties.shareQuota |
integer (int32) |
Подготовленный размер общей папки в гибибайтах. Должно быть больше 0 и меньше или равно 5TB (5120). Для больших общих папок максимальный размер — 102400. Для общих папок, созданных в разделе "Подготовленные файлы" типа учетной записи версии 2, обратитесь к ответу API GetFileServiceUsage для минимального и максимального допустимого размера подготовленного хранилища. |
| properties.shareUsageBytes |
integer (int64) |
Приблизительный размер данных, хранящихся в общей папке. Обратите внимание, что это значение может не включать все недавно созданные файлы или файлы с недавно измененным размером. |
| properties.signedIdentifiers |
Список хранимых политик доступа, указанных в общей папке. |
|
| properties.snapshotTime |
string (date-time) |
Время создания снимка общего ресурса, возвращаемого в ответе на список общих ресурсов с параметром expand "snapshots". |
| properties.version |
string |
Версия общего ресурса. |
| type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
FileSharePaidBursting
Свойства платного ускорения общей папки.
| Имя | Тип | Описание |
|---|---|---|
| paidBurstingEnabled |
boolean |
Указывает, включена ли платная вспышка для общей папки. Это свойство предназначено только для общих папок, созданных в разделе "Подготовленные файлы", тип учетной записи SSD версии 1. |
| paidBurstingMaxBandwidthMibps |
integer (int32) |
Максимальная платная пропускная способность для общей папки в мебибайтах в секунду. Это свойство предназначено только для общих папок, созданных в разделе "Подготовленные файлы", тип учетной записи SSD версии 1. Максимально допустимое значение — 10340, которое является максимально допустимой пропускной способностью для общей папки. |
| paidBurstingMaxIops |
integer (int32) |
Максимальное количество платных операций ввода-вывода в секунду для общей папки. Это свойство предназначено только для общих папок, созданных в разделе "Подготовленные файлы", тип учетной записи SSD версии 1. Максимально допустимое значение — 102400, которое является максимальным допустимым числом операций ввода-вывода в секунду для общей папки. |
LeaseDuration
Указывает, является ли аренда общей папки бессрочной или фиксированной, только когда общая папка арендована.
| Значение | Описание |
|---|---|
| Infinite | |
| Fixed |
LeaseState
Состояние аренды акции.
| Значение | Описание |
|---|---|
| Available | |
| Leased | |
| Expired | |
| Breaking | |
| Broken |
LeaseStatus
Статус аренды акции.
| Значение | Описание |
|---|---|
| Locked | |
| Unlocked |
RootSquashType
Свойство предназначено только для общего ресурса NFS. Значение по умолчанию — NoRootSquash.
| Значение | Описание |
|---|---|
| NoRootSquash | |
| RootSquash | |
| AllSquash |
ShareAccessTier
Уровень доступа для определенной общей папки. Учетная запись GpV2 может выбирать между TransactionOptimized (по умолчанию), горячей и холодной. Учетная запись FileStorage может выбрать Premium.
| Значение | Описание |
|---|---|
| TransactionOptimized | |
| Hot | |
| Cool | |
| Premium |
SignedIdentifier
| Имя | Тип | Описание |
|---|---|---|
| accessPolicy |
Политика доступа |
|
| id |
string |
Уникальный идентификатор хранимой политики доступа. |