获取文件服务属性

项目
2025-05-07

该 Get File Service Properties 作使用 FileREST API 获取资源的属性 FileService 。尽管完全支持此 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 参数	DESCRIPTION
`restype=service&comp=properties`	必填。这两个查询字符串的组合是设置存储服务属性所必需的。
`timeout`	可选。 `timeout` 参数以秒为单位表示。有关详细信息，请参阅设置文件服务作的超时。

请求标头

下表描述了必需和可选的请求标头。

请求标头	DESCRIPTION
`Authorization`	必填。指定授权方案、存储帐户名称和签名。有关详细信息，请参阅授权对 Azure 存储的请求。
`Date` 或 `x-ms-date`	必填。指定请求的协调世界时（UTC）。有关详细信息，请参阅授权对 Azure 存储的请求。
`x-ms-version`	所有授权请求都是必需的。指定要用于此请求的操作的版本。此作仅在版本 2015-02-21 及更高版本中可用。若要检索文件服务的指标属性，必须指定版本 2015-04-05 或更高版本。有关详细信息，请参阅 Azure 存储服务的版本控制。
`x-ms-client-request-id`	可选。提供客户端生成的不透明值，其中包含配置日志记录时在 Azure 存储分析日志中记录的 1-kibibyte （KiB）字符限制。强烈建议使用此标头将客户端活动与服务器接收的请求相关联。有关详细信息，请参阅监视 Azure 文件存储。

请求主体

没有。

响应

响应包括 HTTP 状态代码、一组响应标头和一个响应正文。

状态代码

成功的操作返回状态代码 200（正常）。

响应标头

此操作的响应包括以下标头。响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

响应头	DESCRIPTION
`x-ms-request-id`	唯一标识针对服务发出的请求。
`x-ms-version`	指定用于响应的作的版本。有关详细信息，请参阅 Azure 存储服务的版本控制。
`x-ms-client-request-id`	可用于对请求及其相应的响应进行故障排除。如果此标头存在于请求中，则此标头的值等于 `x-ms-client-request-id` 标头的值，并且该值包含不超过 1,024 个可见 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>

下表描述了响应正文的元素：

名称	DESCRIPTION
`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 多通道的设置。此设置有一个属性：enabled/disabled。
`Versions`	自版本 2020-04-08 起可用。允许的 SMB 版本的分号分隔列表。可能的值：`SMB2.1`、`SMB3.0` 和 `SMB3.1.1`。 `Version`如果未指定，则默认值为启用所有版本。但是，仅当存储帐户 `require secure transit` 的属性被禁用时，SMB 2.1 才可用，因为 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 的存储帐户的文件服务属性：

方法	网址	协议
获取	`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 规则和评估逻辑的详细信息，请参阅对 Azure 存储服务的 CORS 支持。

有关详细信息，请参阅存储分析。

通过