FileShares interface
FileShares を表すインターフェイス。
メソッド
| create(string, string, string, File |
要求本文で説明されているように、指定したアカウントの下に新しい共有を作成します。 共有リソースには、その共有のメタデータとプロパティが含まれます。 共有に含まれるファイルの一覧は含まれません。 |
| delete(string, string, string, File |
アカウントで指定した共有を削除します。 |
| get(string, string, string, File |
指定した共有のプロパティを取得します。 |
| lease(string, string, string, File |
リース共有操作は、削除操作の共有に対するロックを確立および管理します。 ロック期間は、15 ～ 60 秒にすることも、無限にすることもできます。 |
| list(string, string, File |
すべての共有を一覧表示します。 |
| restore(string, string, string, Deleted |
共有の論理的な削除が有効になっている場合、有効な保持期間内にファイル共有を復元する |
| update(string, string, string, File |
更新要求本文で指定されているプロパティを共有します。 要求に記載されていないプロパティは変更されません。 指定した共有がまだ存在しない場合、更新は失敗します。 |
メソッドの詳細
create(string, string, string, FileShare, FileSharesCreateOptionalParams)
要求本文で説明されているように、指定したアカウントの下に新しい共有を作成します。 共有リソースには、その共有のメタデータとプロパティが含まれます。 共有に含まれるファイルの一覧は含まれません。
function create(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesCreateOptionalParams): Promise<FileShare>パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。
- accountName
-
string
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。
- shareName
-
string
指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字にする必要があり、数字、小文字、ダッシュ (-) のみを使用してください。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
- fileShare
- FileShare
作成するファイル共有のプロパティ。
- options
- FileSharesCreateOptionalParams
options パラメーター。
戻り値
Promise<FileShare>
delete(string, string, string, FileSharesDeleteOptionalParams)
アカウントで指定した共有を削除します。
function delete(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。
- accountName
-
string
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。
- shareName
-
string
指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字にする必要があり、数字、小文字、ダッシュ (-) のみを使用してください。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
- options
- FileSharesDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, FileSharesGetOptionalParams)
指定した共有のプロパティを取得します。
function get(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesGetOptionalParams): Promise<FileShare>パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。
- accountName
-
string
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。
- shareName
-
string
指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字にする必要があり、数字、小文字、ダッシュ (-) のみを使用してください。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
- options
- FileSharesGetOptionalParams
options パラメーター。
戻り値
Promise<FileShare>
lease(string, string, string, FileSharesLeaseOptionalParams)
リース共有操作は、削除操作の共有に対するロックを確立および管理します。 ロック期間は、15 ～ 60 秒にすることも、無限にすることもできます。
function lease(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesLeaseOptionalParams): Promise<FileSharesLeaseResponse>パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。
- accountName
-
string
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。
- shareName
-
string
指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字にする必要があり、数字、小文字、ダッシュ (-) のみを使用してください。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
- options
- FileSharesLeaseOptionalParams
options パラメーター。
戻り値
Promise<FileSharesLeaseResponse>
list(string, string, FileSharesListOptionalParams)
すべての共有を一覧表示します。
function list(resourceGroupName: string, accountName: string, options?: FileSharesListOptionalParams): PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。
- accountName
-
string
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。
- options
- FileSharesListOptionalParams
options パラメーター。
戻り値
restore(string, string, string, DeletedShare, FileSharesRestoreOptionalParams)
共有の論理的な削除が有効になっている場合、有効な保持期間内にファイル共有を復元する
function restore(resourceGroupName: string, accountName: string, shareName: string, deletedShare: DeletedShare, options?: FileSharesRestoreOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。
- accountName
-
string
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。
- shareName
-
string
指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字にする必要があり、数字、小文字、ダッシュ (-) のみを使用してください。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
- deletedShare
- DeletedShare
復元する削除された共有。
- options
- FileSharesRestoreOptionalParams
options パラメーター。
戻り値
Promise<void>
update(string, string, string, FileShare, FileSharesUpdateOptionalParams)
更新要求本文で指定されているプロパティを共有します。 要求に記載されていないプロパティは変更されません。 指定した共有がまだ存在しない場合、更新は失敗します。
function update(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesUpdateOptionalParams): Promise<FileShare>パラメーター
- resourceGroupName
-
string
ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。
- accountName
-
string
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。
- shareName
-
string
指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字にする必要があり、数字、小文字、ダッシュ (-) のみを使用してください。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
- fileShare
- FileShare
ファイル共有用に更新するプロパティ。
- options
- FileSharesUpdateOptionalParams
options パラメーター。
戻り値
Promise<FileShare>