ファイル サービス REST APIFile service REST API

サーバー メッセージ ブロック (SMB) プロトコルは、現在オンプレミスで使用されている優先ファイル共有プロトコルです。The Server Message Block (SMB) protocol is the preferred file share protocol used on-premises today. Microsoft Azure ファイル サービスでは、Azure のクラウドの "サービスとしてのインフラストラクチャ (IaaS)" の可用性と拡張性を利用できます。SMB クライアント アプリケーションを作成し直す必要はありません。The Microsoft Azure File service enables customers to leverage the availability and scalability of Azure’s Cloud Infrastructure as a Service (IaaS) SMB without having to rewrite SMB client applications.

従来の Direct Attached Storage (DAS) および Storage Area Network (SAN) ソリューションは、インストール、構成、操作が複雑で高価な場合もよくありますが、Azure ファイル サービスは、こうしたソリューションの代替としても利用できます。The Azure File service also offers a compelling alternative to traditional Direct Attached Storage (DAS) and Storage Area Network (SAN) solutions, which are often complex and expensive to install, configure, and operate. 新しい Azure ファイル サービスの料金は既存の Azure ストレージ サービスに一致し、記憶域容量とトランザクションを単位として課金されます。Pricing for the new Azure File service is consistent with existing Azure Storage services and is charged in units of storage capacity and transactions. 詳細については、Azure ストレージの料金のページを参照してください。See the Azure Storage Pricing page for details.

Azure ファイル サービスに保存されているファイルは、エンドポイント http|https://<account>.file.core.windows.net で SMB プロトコルだけでなく、REST API を介してアクセスすることもできます。Files stored in Azure File service shares are accessible via the SMB protocol, and also via REST APIs, at the endpoint http|https://<account>.file.core.windows.net. HTTPS が推奨されます。HTTPS is recommended.

Azure ファイル サービスの REST API は Azure BLOB Service の REST API と似ていますが、基礎になるファイル システムをサービスがモデル化するしくみにわずかな違いがあります。While the Azure File service REST APIs are similar to the Azure Blob service REST APIs, there are minor differences related to how the service models the underlying file system. これらの違いについて次の操作表で説明します。These differences are noted in the operations table below.

ファイル サービス REST 操作File service REST operations

Azure File サービスには、ストレージ アカウント、共有、ディレクトリ、ファイルの 4 つのリソースが用意されています。The Azure File service offers the following four resources: the storage account, shares, directories, and files. 共有によって複数のファイルを整理することができます。また、クラウドでホストされる SMB ファイル共有としてマウントすることもできます。Shares provide a way to organize sets of files and also can be mounted as an SMB file share that is hosted in the cloud.

ファイル サービス REST API は、HTTP/HTTPS 操作経由で共有、ディレクトリ、ファイル リソースを使用する方法を提供します。The File service REST API provides a way to work with share, directory, and file resources via HTTP/HTTPS operations. ファイル サービス操作はストレージ サービスの 2014-02-14 以降のバージョンでのみ利用できます。File service operations are available only in version 2014-02-14 of the storage services or later.

ファイル サービス REST API には次の表に示す操作が含まれています。The File service REST API includes the operations listed in the table below.

OperationOperation リソースの種類Resource Type REST 動詞REST Verb 説明Description 対応する BLOB サービス操作との違いDifferences with corresponding Blob service operation
共有のリストList Shares ストレージ アカウントStorage account GETGET ストレージ アカウントのすべてのファイル共有を一覧表示するLists all the file shares in a storage account なしNone
ファイル サービスのプロパティを取得するGet File Service Properties ストレージ アカウントStorage account GETGET ストレージ アカウントのファイル サービスプロパティを取得します。Gets the File service properties for the storage account なしNone
Set File Service PropertiesSet File Service Properties ストレージ アカウントStorage account PUTPUT ストレージ アカウントのファイル サービスプロパティを設定します。Sets the File service properties for the storage account なしNone
Preflight File RequestPreflight File Request ストレージ アカウントStorage account OPTIONSOPTIONS 実際の要求を送信する前に、ファイル サービスのクロス オリジン リソース共有 (CORS) ルールを照会します。Queries the Cross-Origin Resource Sharing (CORS) rules for the File service prior to sending the actual request. なしNone
共有を作成するCreate Share 共有Share PUTPUT ストレージ アカウントで新しい共有を作成します。Creates a new share in a storage account. 要求ヘッダーRequest header
スナップショット共有 (Snapshot Share)Snapshot Share 共有Share PUTPUT ストレージ アカウント内の既存の共有の新しい共有スナップショットを作成します。Creates a new share snapshot for an existing share in a storage account. 要求ヘッダーRequest header
Get Share ACLGet Share ACL 共有Share GET/HEADGET/HEAD 共有に指定された保存済みアクセス ポリシーに関する情報を返します。Returns information about stored access policies specified on the share. 応答本文Response body
共有 ACL の設定Set Share ACL 共有Share PUTPUT 共有アクセス署名で使用する、保存されたアクセス ポリシーを設定します。Sets a stored access policy for use with shared access signatures. 要求本文Request body
共有のプロパティの取得Get Share Properties 共有Share GET/HEADGET/HEAD 共有のすべてのユーザー定義メタデータとシステム プロパティを返します。Returns all user-defined metadata and system properties of a share. なしNone
共有のプロパティの設定Set Share Properties 共有Share PUTPUT 共有のシステム プロパティを設定します。Sets system properties for a share. 該当なしN/A
共有メタデータの取得Get Share Metadata 共有Share GET/HEADGET/HEAD 共有のユーザー定義メタデータのみを返します。Returns only user-defined metadata of a share. なしNone
共有メタデータの設定Set Share Metadata 共有Share PUTPUT 共有のユーザー定義メタデータを設定します。Sets user-defined metadata of a share. なしNone
共有の統計の取得Get Share Stats 共有Share GETGET 共有に関連する統計情報を取得します。Retrieves statistics related to the share. 該当なしN/A
共有の削除Delete Share 共有Share DELETEDELETE 共有とそれに含まれるファイルとディレクトリを削除します。Deletes the share and any files and directories that it contains. なしNone
ディレクトリとファイルのリストList Directories and Files ディレクトリDirectory GETGET 共有または指定したディレクトリ内のファイルとディレクトリを一覧表示します。Lists files and directories within the share or specified directory. クエリ文字列パラメーター、応答本文Query String Params, Response Body
ディレクトリの作成Create Directory ディレクトリDirectory PUTPUT 共有または親ディレクトリでディレクトリを作成します。Creates a directory in the share or parent directory. 新規New
ディレクトリ プロパティの取得Get Directory Properties ディレクトリDirectory GET/HEADGET/HEAD ディレクトリのシステム定義プロパティを返します。Returns system defined properties of a directory. この操作により、ユーザーはディレクトリの存在を確認できます。This operation allows users to check for directory existence. 新規New
ディレクトリメタデータの取得Get Directory Metadata ディレクトリDirectory GET/HEADGET/HEAD ディレクトリ上のすべてのユーザー定義メタデータを取得します。Retrieves all user-defined metadata on the directory. 新規New
ディレクトリのメタデータの設定Set Directory Metadata ディレクトリDirectory PUTPUT 既存のディレクトリのユーザー定義メタデータを設定します。Sets user-defined metadata of an existing directory. 新規New
ディレクトリの削除Delete Directory ディレクトリDirectory DELETEDELETE ディレクトリを削除します。Deletes the directory. 空のディレクトリのみでサポートされます。Only supported for empty directories. 新規New
ファイルの作成Create File ファイルFile PUTPUT 新しいファイルを作成するか、ディレクトリまたは共有内の既存のファイルを置き換えます。Creates a new file or replaces an existing file within a directory or share. 名前Name

要求ヘッダーRequest Headers
Get FileGet File ファイルFile GETGET ファイル サービスから、ユーザー定義メタデータとシステム プロパティも含めて、ファイルを読み込むか、ダウンロードします。Reads or downloads a file from the File service, including its user-defined metadata and system properties. 名前、応答ヘッダーName, Response Headers
ファイルプロパティの設定Set File Properties ファイルFile PUTPUT 既存のファイルに対して定義されたシステム プロパティを設定します。Sets system properties defined for an existing file. 名前、Name,

要求&応答ヘッダーRequest & Response Headers
ファイルプロパティの取得Get File Properties ファイルFile HEADHEAD ファイルのすべてのシステム プロパティとユーザー定義メタデータを返します。Returns all system properties and user-defined metadata on the file. 名前、応答ヘッダーName, Response Headers
ファイルメタデータの取得Get File Metadata ファイルFile GET/HEADGET/HEAD ファイルのすべてのユーザー定義メタデータを取得します。Retrieves all user-defined metadata on the file. [名前のみ]Name only
Set File MetadataSet File Metadata ファイルFile PUTPUT 既存のファイルのユーザー定義メタデータを設定します。Sets user-defined metadata of an existing file. [名前のみ]Name only
ファイルの削除Delete File ファイルFile DELETEDELETE 永久的にファイルを削除します。Deletes the file permanently. [名前のみ]Name only
ファイルのコピーCopy File ファイルFile PUTPUT ソース BLOB またはファイルをこのストレージ アカウントのコピー先ファイルにコピーします。Copies a source blob or file to a destination file in this storage account. 名前、パラム、レスポンスヘッダーName, Param, Response Headers
Abort Copy FileAbort Copy File ファイルFile PUTPUT 保留中のファイルのコピー操作を中止し、長さがゼロで完全なメタデータを持つコピー先ファイルを残します。Aborts a pending Copy File operation, and leaves a destination file with zero length and full metadata. 名前、パラム、レスポンスヘッダーName, Param, Response Headers
Put RangePut Range ファイルFile PUTPUT ファイルにデータの範囲を入力するか、ファイルに入力されている範囲を消去します。Puts a range of data into a file, or clears a range in the file. 名前、Name,

クエリ文字列パラメーター、応答ヘッダー&本文Query String Param, Response Header & Body
リスト範囲List Ranges ファイルFile GETGET ファイルのアクティブな範囲の一覧を返します。Returns a list of active ranges for the file. アクティブな範囲は、Put Range API を使用してデータが設定された範囲です。Active ranges are those ranges that have been populated with data using Put Range API. 名前、Name,

クエリ文字列パラメーター、応答本文Query String Param, Response Body

このセクションの内容In this section

このセクションでは、次のトピックを扱います。This section contains the following topics.

関連項目See also

ストレージ サービス RESTStorage Services REST