File Services - Set Service Properties

Задает свойства файловых служб в учетных записях хранения, включая правила CORS (общий доступ к ресурсам независимо от источника).

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

Параметры URI

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

string

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

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

FileServicesName
path True

FileServicesName

Имя файловой службы в указанной учетной записи хранения. Имя службы файлов должно быть "по умолчанию"

resourceGroupName
path True

string

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

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

subscriptionId
path True

string

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

api-version
query True

string

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

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

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

CorsRules

Задает правила CORS для службы файлов. В запрос можно включить до пяти элементов CorsRule. Если элементы CorsRule не включены в текст запроса, все правила CORS будут удалены, а CORS будет отключен для службы файлов.

properties.protocolSettings

ProtocolSettings

Параметры протокола для файловой службы

properties.shareDeleteRetentionPolicy

DeleteRetentionPolicy

Свойства файловой службы для обратимого удаления общего ресурса.

Ответы

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

FileServiceProperties

ОК — успешно задает свойства файловой службы учетной записи хранения.

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 олицетворения учетной записи пользователя

Примеры

PutFileServices
PutFileServices_EnableSecureSmbFeatures
PutFileServices_EnableSMBMultichannel

PutFileServices

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default?api-version=2023-01-01

{
  "properties": {
    "cors": {
      "corsRules": [
        {
          "allowedOrigins": [
            "http://www.contoso.com",
            "http://www.fabrikam.com"
          ],
          "allowedMethods": [
            "GET",
            "HEAD",
            "POST",
            "OPTIONS",
            "MERGE",
            "PUT"
          ],
          "maxAgeInSeconds": 100,
          "exposedHeaders": [
            "x-ms-meta-*"
          ],
          "allowedHeaders": [
            "x-ms-meta-abc",
            "x-ms-meta-data*",
            "x-ms-meta-target*"
          ]
        },
        {
          "allowedOrigins": [
            "*"
          ],
          "allowedMethods": [
            "GET"
          ],
          "maxAgeInSeconds": 2,
          "exposedHeaders": [
            "*"
          ],
          "allowedHeaders": [
            "*"
          ]
        },
        {
          "allowedOrigins": [
            "http://www.abc23.com",
            "https://www.fabrikam.com/*"
          ],
          "allowedMethods": [
            "GET",
            "PUT"
          ],
          "maxAgeInSeconds": 2000,
          "exposedHeaders": [
            "x-ms-meta-abc",
            "x-ms-meta-data*",
            "x-ms-meta-target*"
          ],
          "allowedHeaders": [
            "x-ms-meta-12345675754564*"
          ]
        }
      ]
    }
  }
}

Sample Response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default",
  "name": "default",
  "type": "Microsoft.Storage/storageAccounts/fileServices",
  "properties": {
    "cors": {
      "corsRules": [
        {
          "allowedOrigins": [
            "http://www.contoso.com",
            "http://www.fabrikam.com"
          ],
          "allowedMethods": [
            "GET",
            "HEAD",
            "POST",
            "OPTIONS",
            "MERGE",
            "PUT"
          ],
          "maxAgeInSeconds": 100,
          "exposedHeaders": [
            "x-ms-meta-*"
          ],
          "allowedHeaders": [
            "x-ms-meta-abc",
            "x-ms-meta-data*",
            "x-ms-meta-target*"
          ]
        },
        {
          "allowedOrigins": [
            "*"
          ],
          "allowedMethods": [
            "GET"
          ],
          "maxAgeInSeconds": 2,
          "exposedHeaders": [
            "*"
          ],
          "allowedHeaders": [
            "*"
          ]
        },
        {
          "allowedOrigins": [
            "http://www.abc23.com",
            "https://www.fabrikam.com/*"
          ],
          "allowedMethods": [
            "GET",
            "PUT"
          ],
          "maxAgeInSeconds": 2000,
          "exposedHeaders": [
            "x-ms-meta-abc",
            "x-ms-meta-data*",
            "x-ms-meta-target*"
          ],
          "allowedHeaders": [
            "x-ms-meta-12345675754564*"
          ]
        }
      ]
    }
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  }
}

PutFileServices_EnableSecureSmbFeatures

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default?api-version=2023-01-01

{
  "properties": {
    "protocolSettings": {
      "smb": {
        "versions": "SMB2.1;SMB3.0;SMB3.1.1",
        "authenticationMethods": "NTLMv2;Kerberos",
        "kerberosTicketEncryption": "RC4-HMAC;AES-256",
        "channelEncryption": "AES-128-CCM;AES-128-GCM;AES-256-GCM"
      }
    }
  }
}

Sample Response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default",
  "name": "default",
  "type": "Microsoft.Storage/storageAccounts/fileServices",
  "properties": {
    "protocolSettings": {
      "smb": {
        "versions": "SMB2.1;SMB3.0;SMB3.1.1",
        "authenticationMethods": "NTLMv2;Kerberos",
        "kerberosTicketEncryption": "RC4-HMAC;AES-256",
        "channelEncryption": "AES-128-CCM;AES-128-GCM;AES-256-GCM"
      }
    }
  },
  "sku": {
    "name": "Premium_LRS",
    "tier": "Premium"
  }
}

PutFileServices_EnableSMBMultichannel

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default?api-version=2023-01-01

{
  "properties": {
    "protocolSettings": {
      "smb": {
        "multichannel": {
          "enabled": true
        }
      }
    }
  }
}

Sample Response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default",
  "name": "default",
  "type": "Microsoft.Storage/storageAccounts/fileServices",
  "properties": {
    "protocolSettings": {
      "smb": {
        "multichannel": {
          "enabled": true
        }
      }
    }
  },
  "sku": {
    "name": "Premium_LRS",
    "tier": "Premium"
  }
}

Определения

Имя Описание
AllowedMethods

Требуется, если элемент CorsRule присутствует. Список методов HTTP, которые могут выполняться источником.

CloudError

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

CloudErrorBody

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

CorsRule

Задает правило CORS для службы BLOB-объектов.

CorsRules

Задает правила CORS. В запрос можно включить до пяти элементов CorsRule.

DeleteRetentionPolicy

Свойства службы для обратимого удаления.

FileServiceProperties

Свойства файловых служб в учетной записи хранения.

FileServicesName

Имя файловой службы в указанной учетной записи хранения. Имя службы файлов должно быть "по умолчанию"

Multichannel

Параметр многоканального канала. Применяется только к premium FileStorage.

ProtocolSettings

Параметры протокола для файловой службы

Sku

Номер SKU учетной записи хранения.

SkuName

Имя номера SKU. Требуется для создания учетной записи; необязательный параметр для обновления. Обратите внимание, что в более ранних версиях имя SKU называлось accountType.

SkuTier

Уровень SKU. Это зависит от имени номера SKU.

SmbSetting

Параметр для протокола SMB

AllowedMethods

Требуется, если элемент CorsRule присутствует. Список методов HTTP, которые могут выполняться источником.

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

string

DELETE

string

GET

string

HEAD

string

MERGE

string

OPTIONS

string

PATCH

string

POST

string

PUT

string

TRACE

string

CloudError

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

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

CloudErrorBody

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

CloudErrorBody

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

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

string

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

details

CloudErrorBody[]

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

message

string

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

target

string

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

CorsRule

Задает правило CORS для службы BLOB-объектов.

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

string[]

Требуется, если элемент CorsRule присутствует. Список заголовков, которые могут быть частью запроса независимо от источника.

allowedMethods

AllowedMethods[]

Требуется, если элемент CorsRule присутствует. Список методов HTTP, которые могут выполняться источником.

allowedOrigins

string[]

Требуется, если элемент CorsRule присутствует. Список доменов источника, которые будут разрешены через CORS, или "*", чтобы разрешить все домены

exposedHeaders

string[]

Требуется, если элемент CorsRule присутствует. Список заголовков ответов для предоставления клиентам CORS.

maxAgeInSeconds

integer

Требуется, если элемент CorsRule присутствует. Число секунд, в течение которых клиент или браузер должен кэшировать предполетный ответ.

CorsRules

Задает правила CORS. В запрос можно включить до пяти элементов CorsRule.

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

CorsRule[]

Список правил CORS. В запрос можно включить до пяти элементов CorsRule.

DeleteRetentionPolicy

Свойства службы для обратимого удаления.

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

boolean

Это свойство, если задано значение true, позволяет удалить версии и моментальные снимки обратимо удаленных BLOB-объектов. Это свойство не может использоваться политикой восстановления BLOB-объектов. Это свойство применяется только к службе BLOB-объектов и не применяется к контейнерам или общей папке.

days

integer

Указывает количество дней, в течение которых должен храниться удаленный элемент. Минимальное указанное значение может быть равно 1, а максимальное — 365.

enabled

boolean

Указывает, включена ли функция DeleteRetentionPolicy.

FileServiceProperties

Свойства файловых служб в учетной записи хранения.

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

string

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

name

string

Имя ресурса.

properties.cors

CorsRules

Задает правила CORS для службы файлов. В запрос можно включить до пяти элементов CorsRule. Если элементы CorsRule не включены в текст запроса, все правила CORS будут удалены, а CORS будет отключен для службы файлов.

properties.protocolSettings

ProtocolSettings

Параметры протокола для файловой службы

properties.shareDeleteRetentionPolicy

DeleteRetentionPolicy

Свойства файловой службы для обратимого удаления общего ресурса.

sku

Sku

Имя И уровень SKU.

type

string

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

FileServicesName

Имя файловой службы в указанной учетной записи хранения. Имя службы файлов должно быть "по умолчанию"

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

string

Multichannel

Параметр многоканального канала. Применяется только к premium FileStorage.

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

boolean

Указывает, включен ли multichannel

ProtocolSettings

Параметры протокола для файловой службы

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

SmbSetting

Параметр для протокола SMB

Sku

Номер SKU учетной записи хранения.

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

SkuName

Имя номера SKU. Требуется для создания учетной записи; необязательный параметр для обновления. Обратите внимание, что в более ранних версиях имя SKU называлось accountType.

tier

SkuTier

Уровень SKU. Это зависит от имени номера SKU.

SkuName

Имя номера SKU. Требуется для создания учетной записи; необязательный параметр для обновления. Обратите внимание, что в более ранних версиях имя SKU называлось accountType.

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

string

Premium_ZRS

string

Standard_GRS

string

Standard_GZRS

string

Standard_LRS

string

Standard_RAGRS

string

Standard_RAGZRS

string

Standard_ZRS

string

SkuTier

Уровень SKU. Это зависит от имени номера SKU.

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

string

Standard

string

SmbSetting

Параметр для протокола SMB

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

string

Методы проверки подлинности SMB, поддерживаемые сервером. Допустимые значения: NTLMv2, Kerberos. Должен передаваться в виде строки с разделителем ";".

channelEncryption

string

Шифрование канала SMB, поддерживаемого сервером. Допустимые значения: AES-128-CCM, AES-128-GCM, AES-256-GCM. Должен передаваться в виде строки с разделителем ";".

kerberosTicketEncryption

string

Шифрование билетов Kerberos, поддерживаемого сервером. Допустимые значения: RC4-HMAC, AES-256. Должен передаваться в виде строки с разделителем ";"

multichannel

Multichannel

Параметр многоканального канала. Применяется только к premium FileStorage.

versions

string

Версии протокола SMB, поддерживаемые сервером. Допустимые значения: SMB2.1, SMB3.0, SMB3.1.1. Должен передаваться в виде строки с разделителем ";".