取得檔案服務屬性

發行項
08/05/2023

作業會 Get File Service Properties 使用 FileREST API 取得資源的屬性 FileService 。雖然完全支援此 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-kibibyte (KiB) 字元儲存體分析限制。強烈建議您使用此標頭，將用戶端活動與伺服器收到的要求相互關聯。如需詳細資訊，請參閱監視Azure 檔案儲存體。

要求本文

無。

回應

回應包括 HTTP 狀態碼、一組回應標頭和回應主體。

狀態碼

成功的作業會傳回狀態碼 200 (OK)。

回應標頭

這項作業的回應包括下列標頭。回應也可能包括其他標準 HTTP 標頭。所有標準標頭都符合 HTTP/1.1 通訊協定規格。

回應標頭	描述
`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-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 多重通道的設定。此設定有一個屬性：已啟用/停用。
`Version`	自 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之儲存體帳戶的檔案服務屬性：

方法	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 規則和評估邏輯的詳細資訊，請參閱 Azure 儲存體服務的 CORS 支援。

如需詳細資訊，請參閱儲存體分析。

共用方式為