Получение свойств файловой службы

Операция Get File Service Properties получает свойства ресурса FileService с помощью API FileREST. Хотя этот API полностью поддерживается, он является устаревшим API управления. Вместо этого рекомендуется использовать файловые службы — получение свойств службы, предоставляемых поставщиком ресурсов хранилища (Microsoft.Storage). Дополнительные сведения о программном взаимодействии с ресурсом FileService с помощью поставщика ресурсов хранилища см. в разделе Операции с ресурсом FileService.

Доступность протокола

Включенный протокол общей папки Доступно
SMB Да
NFS Да

Запрос

Запрос Get File Service Properties можно указать следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS. Замените <account-name> именем нужной учетной записи хранения.

Метод Универсальный код ресурса (URI) запроса параметр "Версия HTTP"
GET https://<account-name>.file.core.windows.net/?restype=service&comp=properties HTTP/1.1

Примечание

Универсальный код ресурса (URI) всегда должен содержать символ косой черты (/), чтобы отделить имя узла от частей пути и запроса URI. В этой операции путь URI пуст.

Параметры универсального кода ресурса (URI)

Параметр универсального кода ресурса (URI) Описание
restype=service&comp=properties Обязательный. Сочетание обеих строк запроса обязательно для задания свойств службы хранилища.
timeout Необязательный элемент. Параметр timeout указывается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы файлов.

Заголовки запросов

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

Заголовок запроса Описание
Authorization Обязательный. Указывает схему авторизации, имя учетной записи хранения и подпись. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure.
Date или x-ms-date Обязательный. Задает время запроса в формате UTC. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure.
x-ms-version Требуется для всех авторизованных запросов. Задает версию операции, используемой для этого запроса. Эта операция доступна только в версии 2015-02-21 и более поздних. Чтобы получить свойства метрик для службы файлов, необходимо указать версию 2015-04-05 или более позднюю.

Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure.
x-ms-client-request-id Необязательный элемент. Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 кибибайт (КиБ), которое записывается в журналы azure Аналитика Службы хранилища при настройке ведения журнала. Мы настоятельно рекомендуем использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в разделе Мониторинг Файлы Azure.

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

Нет.

Ответ

Ответ включает код состояния HTTP, набор заголовков ответа и текст ответа.

Код состояния

Успешная операция возвращает код состояния 200 (ОК).

Заголовки ответов

Ответ для этой операции включает следующие заголовки. Ответ может также включать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.

Заголовок ответа Описание
x-ms-request-id Уникально идентифицирует запрос, выполненный к службе.
x-ms-version Указывает версию операции, используемой для ответа. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure.
x-ms-client-request-id Можно использовать для устранения неполадок с запросами и соответствующими ответами. Значение этого заголовка равно значению заголовка x-ms-client-request-id , если он присутствует в запросе и содержит не более 1024 видимых символов ASCII. Если заголовок x-ms-client-request-id отсутствует в запросе, он отсутствует в ответе.

Текст ответа

Текст ответа для версии 2020-02-10 выглядит следующим образом:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <HourMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>comma-separated-list-of-allowed-origins</AllowedOrigins>  
            <AllowedMethods>comma-separated-list-of-HTTP-verb</AllowedMethods>  
            <MaxAgeInSeconds>max-caching-age-in-seconds</MaxAgeInSeconds>  
            <ExposedHeaders>comma-seperated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders>comma-seperated-list-of-request-headers</AllowedHeaders>  
        </CorsRule>  
    </Cors>
    <ShareDeleteRetentionPolicy>
        <Enabled>true|false</Enabled>
        <Days>integer-value</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true|false</Enabled>
            </Multichannel>
            <Versions>comma-separated-list-of-smb-versions</Versions>
            <AuthenticationMethods>comma-separated-list-of-auth-methods</AuthenticationMethod>
            <KerberosTicketEncryption>csv-of-kerb-encryption-algorithms</KerberosTicketEncryption>
            <ChannelEncryption>csv-of-smb-encryption-algorithms</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>  

Элементы основного текста ответа описываются в следующей таблице.

Имя Описание
HourMetrics Группирует параметры Аналитика Службы хранилищаHourMetrics. Параметры HourMetrics предоставляют сводку статистики запросов, сгруппированную по API в почасовых статистических выражениях.
MinuteMetrics Группирует параметры Аналитика Службы хранилищаMinuteMetrics. Параметры MinuteMetrics предоставляют статистику запросов за каждую минуту.
Version Версия Аналитика Службы хранилища, которая используется в настоящее время.
Enabled Указывает, включены ли метрики для службы файлов.
IncludeAPIs Указывает, должны ли метрики сформировать сводную статистику для вызываемых операций API-интерфейса.
RetentionPolicy/Enabled Указывает, включена ли политика хранения для службы файлов.
RetentionPolicy/Days Указывает количество дней, в течение которых хранятся данные метрик. Все данные, которые старше этого значения, удаляются на основе наилучших усилий.
Cors Группирует все правила общего доступа к ресурсам независимо от источника (CORS).
CorsRule Группирует параметры для правил CORS.
AllowedOrigins Список доменов источников с разделителями-запятыми, разрешенных для CORS, либо символ «*», если разрешены все домены.
ExposedHeaders Список заголовков ответов с разделителями-запятыми для предоставления клиентам CORS.
MaxAgeInSeconds Количество секунд, в течение которых клиент или браузер должны кэшировать предварительный ответ.
AllowedHeaders Разделенный запятыми список заголовков, которые могут быть частью запроса между источниками.
AllowedMethods Список методов HTTP с разделителями-запятыми, которые разрешено выполнять источником. Для Файлы Azure разрешены методы DELETE, GET, HEAD, MERGE, POST, OPTIONS и PUT.
ShareDeleteRetentionPolicy Свойства обратимого удаления общих папок Azure в этой учетной записи хранения.
Days Указывает количество дней, в течение которых общая папка Azure должна храниться (обратимо удалена). Минимальное указанное значение может быть равно 1, а максимальное — 365.
Enabled Указывает, включена ли в учетной записи хранения обратимое удаление для Файлы Azure.
ProtocolSettings Группирует параметры для протоколов файловой системы.
SMB Группирует параметры для блока сообщений сервера (SMB).
Multichannel Содержит параметры для SMB Multichannel. Этот параметр имеет одно свойство: enabled/disabled.
Version Доступно с версии 2020-04-08. Разделенный запятыми список разрешенных версий SMB. Возможные значения: SMB2.1, SMB3.0 и SMB3.1.1. Если Version параметр не указан, по умолчанию включены все версии. Однако SMB 2.1 доступен только в том случае, если свойство учетной require secure transit записи хранения отключено, так как SMB 2.1 не поддерживает шифрование.
AuthenticationMethods Доступно с версии 2020-04-08. Разделенный запятыми список разрешенных методов проверки подлинности. Возможные значения: NTLMv2, Kerberos. Если AuthenticationMethods параметр не указан, по умолчанию разрешены все методы проверки подлинности.
KerberosTicketEncryption Доступно с версии 2020-04-08. Разделенный запятыми список разрешенных алгоритмов шифрования билетов Kerberos. Возможные значения: RC4-HMAC и AES-256. Если KerberosTicketEncryption параметр не указан, по умолчанию поддерживаются все алгоритмы шифрования билетов Kerberos.
ChannelEncryption Доступно с версии 2020-04-08. Разделенный запятыми список разрешенных протоколов шифрования каналов SMB. Возможные значения: AES-128-CCM, AES-128-GCM и AES-256-GCM. Если ChannelEncryption параметр не указан, по умолчанию поддерживаются все значения шифрования каналов. Если свойство учетной require secure transit записи хранения отключено, также разрешен незашифрованный доступ по протоколу SMB.

Авторизация

Эту операцию может вызвать только владелец учетной записи хранилища.

Пример запроса и ответа

В следующем примере URI выполняется запрос на получение свойств файловой службы для учетной записи хранения с именем myaccount:

Метод URL-адрес Протокол
GET https://myaccount.file.core.windows.net/?restype=service&comp=properties HTTP/1.1

Запрос отправляется со следующими заголовками:

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.file.core.windows.net  

После отправки запроса возвращается следующий ответ:

HTTP/1.1 200 OK  
Content-Length: 1020  
Content-Type: application/xml  
Date: <date>  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2015-04-05  

Ответ включает следующий текст XML:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <HourMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>true</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>http://www.fabrikam.com,http://www.contoso.com</AllowedOrigins>  
            <AllowedMethods>GET,PUT</AllowedMethods>  
            <MaxAgeInSeconds>500</MaxAgeInSeconds>  
            <ExposedHeaders>x-ms-meta-data*,x-ms-meta-customheader</ExposedHeaders>  
            <AllowedHeaders>x-ms-meta-target*,x-ms-meta-customheader</AllowedHeaders>  
        </CorsRule>  
    </Cors>
    <ShareDeleteRetentionPolicy>
        <Enabled>true</Enabled>
        <Days>7</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true</Enabled>
            </Multichannel>
            <Versions>SMB3.1.1</Versions>
            <AuthenticationMethods>Kerberos</AuthenticationMethods>
            <KerberosTicketEncryption>AES-256</KerberosTicketEncryption>
            <ChannelEncryption>AES-256-GCM</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>  

Комментарии

Подробные сведения о правилах CORS и логике оценки см. в статье Поддержка CORS для служб хранилища Azure.

Дополнительные сведения см. в этой статье.