File Shares - Update

Обновления свойства общего доступа, как указано в тексте запроса. Свойства, не упомянутые в запросе, не будут изменены. Обновление завершается ошибкой, если указанная общая папка еще не существует.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}?api-version=2023-01-01

Параметры URI

Имя В Обязательно Тип Описание
accountName
path True

string

Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.

Regex pattern: ^[a-z0-9]+$

resourceGroupName
path True

string

Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.

Regex pattern: ^[-\w\._\(\)]+$

shareName
path True

string

Имя общей папки в указанной учетной записи хранения. Имена общих папок должны быть длиной от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Текст запроса

Имя Тип Описание
properties.accessTier

ShareAccessTier

Уровень доступа для определенной общей папки. Учетная запись GpV2 может выбирать между ТранзакциейOptimized (по умолчанию), Горячей и Холодной. Учетная запись FileStorage может выбрать Premium.

properties.enabledProtocols

EnabledProtocols

Протокол проверки подлинности, используемый для общей папки. Может указываться только при создании общей папки.

properties.metadata

object

Пары имя-значение, которые будут связаны с общей папкой как метаданные.

properties.rootSquash

RootSquashType

Свойство предназначено только для общего ресурса NFS. Значение по умолчанию — NoRootSquash.

properties.shareQuota

integer

Максимальный размер общей папки в гигабайтах. Значение должно быть больше 0 и меньше или равно 5 ТБ (5120). Для больших общих папок максимальный размер — 102400.

properties.signedIdentifiers

SignedIdentifier[]

Список хранимых политик доступа, указанных в общей папке.

Ответы

Имя Тип Описание
200 OK

FileShare

ОК . Операция обновления общего ресурса успешно завершена.

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

UpdateShareAcls
UpdateShares

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-01-01

{
  "properties": {
    "signedIdentifiers": [
      {
        "id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI",
        "accessPolicy": {
          "startTime": "2021-04-01T08:49:37.0000000Z",
          "expiryTime": "2021-05-01T08:49:37.0000000Z",
          "permission": "rwd"
        }
      }
    ]
  }
}

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-01-01

{
  "properties": {
    "metadata": {
      "type": "image"
    }
  }
}

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"
    }
  }
}

Определения

Имя Описание
AccessPolicy
CloudError

Ответ об ошибке от службы хранилища.

CloudErrorBody

Ответ об ошибке от службы хранилища.

EnabledProtocols

Протокол проверки подлинности, используемый для общей папки. Может указываться только при создании общей папки.

FileShare

Свойства общей папки, включая идентификатор, имя ресурса, тип ресурса, Etag.

LeaseDuration

Указывает, является ли аренда общей папки неограниченной или фиксированной длительностью, только если общая папка арендуется.

LeaseState

Состояние аренды общей папки.

LeaseStatus

Состояние аренды общей папки.

RootSquashType

Свойство предназначено только для общего ресурса NFS. Значение по умолчанию — NoRootSquash.

ShareAccessTier

Уровень доступа для определенной общей папки. Учетная запись GpV2 может выбирать между ТранзакциейOptimized (по умолчанию), Горячей и Холодной. Учетная запись FileStorage может выбрать Premium.

SignedIdentifier

AccessPolicy

Имя Тип Описание
expiryTime

string

Срок действия политики доступа

permission

string

Список сокращенных разрешений.

startTime

string

Время начала политики доступа

CloudError

Ответ об ошибке от службы хранилища.

Имя Тип Описание
error

CloudErrorBody

Ответ об ошибке от службы хранилища.

CloudErrorBody

Ответ об ошибке от службы хранилища.

Имя Тип Описание
code

string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.

details

CloudErrorBody[]

Список дополнительных сведений об ошибке.

message

string

Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.

target

string

Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

EnabledProtocols

Протокол проверки подлинности, используемый для общей папки. Может указываться только при создании общей папки.

Имя Тип Описание
NFS

string

SMB

string

FileShare

Свойства общей папки, включая идентификатор, имя ресурса, тип ресурса, Etag.

Имя Тип Описание
etag

string

Тег ресурса.

id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Имя ресурса.

properties.accessTier

ShareAccessTier

Уровень доступа для определенной общей папки. Учетная запись GpV2 может выбирать между ТранзакциейOptimized (по умолчанию), Горячей и Холодной. Учетная запись FileStorage может выбрать Premium.

properties.accessTierChangeTime

string

Указывает время последнего изменения уровня доступа к общей папке.

properties.accessTierStatus

string

Указывает, существует ли ожидающий переход для уровня доступа.

properties.deleted

boolean

Указывает, была ли удалена общая папка.

properties.deletedTime

string

Время удаления, если общая папка была удалена.

properties.enabledProtocols

EnabledProtocols

Протокол проверки подлинности, используемый для общей папки. Может указываться только при создании общей папки.

properties.lastModifiedTime

string

Возвращает дату и время последнего изменения общей папки.

properties.leaseDuration

LeaseDuration

Указывает, является ли аренда общей папки неограниченной или фиксированной длительностью, только если общая папка арендуется.

properties.leaseState

LeaseState

Состояние аренды общей папки.

properties.leaseStatus

LeaseStatus

Состояние аренды общей папки.

properties.metadata

object

Пары имя-значение, которые будут связаны с общей папкой как метаданные.

properties.remainingRetentionDays

integer

Оставшиеся дни хранения для общей папки, которая была удалена обратимо.

properties.rootSquash

RootSquashType

Свойство предназначено только для общего ресурса NFS. Значение по умолчанию — NoRootSquash.

properties.shareQuota

integer

Максимальный размер общей папки в гигабайтах. Значение должно быть больше 0 и меньше или равно 5 ТБ (5120). Для больших общих папок максимальный размер — 102400.

properties.shareUsageBytes

integer

Приблизительный размер данных, хранящихся в общей папке. Обратите внимание, что это значение может включать не все недавно созданные или недавно измененные файлы.

properties.signedIdentifiers

SignedIdentifier[]

Список хранимых политик доступа, указанных в общей папке.

properties.snapshotTime

string

Время создания snapshot общей папки возвращается в ответе на общие папки списка с расширением параметра "snapshots".

properties.version

string

Версия общей папки.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

LeaseDuration

Указывает, является ли аренда общей папки неограниченной или фиксированной длительностью, только если общая папка арендуется.

Имя Тип Описание
Fixed

string

Infinite

string

LeaseState

Состояние аренды общей папки.

Имя Тип Описание
Available

string

Breaking

string

Broken

string

Expired

string

Leased

string

LeaseStatus

Состояние аренды общей папки.

Имя Тип Описание
Locked

string

Unlocked

string

RootSquashType

Свойство предназначено только для общего ресурса NFS. Значение по умолчанию — NoRootSquash.

Имя Тип Описание
AllSquash

string

NoRootSquash

string

RootSquash

string

ShareAccessTier

Уровень доступа для определенной общей папки. Учетная запись GpV2 может выбирать между ТранзакциейOptimized (по умолчанию), Горячей и Холодной. Учетная запись FileStorage может выбрать Premium.

Имя Тип Описание
Cool

string

Hot

string

Premium

string

TransactionOptimized

string

SignedIdentifier

Имя Тип Описание
accessPolicy

AccessPolicy

Политика доступа

id

string

Уникальный идентификатор хранимой политики доступа.