Поделиться через


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

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

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

Протокол общей папки с включенным доступом В наличии
Малый и средний бизнес (SMB) Да
Сетевая файловая система (NFS) Да

Просьба

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

Метод Запрос URI Версия HTTP
ПОЛУЧАЙ 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-kibibyte (KiB), которое записывается в журналах Аналитики службы хранилища 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-separated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders>comma-separated-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>semicolon-separated-list-of-smb-versions</Versions>
            <AuthenticationMethods>semicolon-separated-list-of-auth-methods</AuthenticationMethod>
            <KerberosTicketEncryption>semicolon-separated-list-of-kerberos-encryption-algorithms</KerberosTicketEncryption>
            <ChannelEncryption>semicolon-separated-list-of-smb-channel-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. Этот параметр имеет одно свойство: включено или отключено.
Versions Доступно по состоянию на версию 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-адрес Протокол
ПОЛУЧАЙ 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.

Для получения дополнительной информации см. Аналитика Хранилища.