FileSharesOperations クラス

警告

このクラスを直接インスタンス化しないでください。

代わりに、次の操作にアクセスする必要があります。

StorageManagementClient's

<xref:file_shares> 属性を使用する。

継承

builtins.object

FileSharesOperations

コンストラクター

FileSharesOperations(*args, **kwargs)

メソッド

create	要求本文で説明されているように、指定したアカウントの下に新しい共有を作成します。 共有リソースには、その共有のメタデータとプロパティが含まれます。 共有に含まれるファイルの一覧は含まれません。
delete	そのアカウントで指定された共有を削除します。
get	指定した共有のプロパティを取得します。
lease	リース共有操作は、削除操作の共有に対するロックを確立して管理します。 ロック期間は、15 ～ 60 秒にすることも、無限にすることもできます。
list	すべての共有を一覧表示します。
restore	共有の論理的な削除が有効になっている場合は、有効な保持期間内にファイル共有を復元します。
update	更新要求本文で指定されたプロパティを共有します。 要求に記載されていないプロパティは変更されません。 指定した共有がまだ存在しない場合、更新は失敗します。

create

要求本文で説明されているように、指定したアカウントの下に新しい共有を作成します。 共有リソースには、その共有のメタデータとプロパティが含まれます。 共有に含まれるファイルの一覧は含まれません。

create(resource_group_name: str, account_name: str, share_name: str, file_share: _models.FileShare, expand: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FileShare

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

share_name

str

必須

指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。

file_share

FileShare または IO

必須

作成するファイル共有のプロパティ。 FileShare 型または IO 型です。 必須です。

expand

str

必須

オプション。共有のプロパティ内のプロパティを展開するために使用されます。 有効な値はスナップショットです。 区切り記号 ',' を含む文字列として渡す必要があります。 既定値は [なし] です。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

FileShare または cls(response) の結果

の戻り値の型 :

FileShare

例外

HttpResponseError

delete

そのアカウントで指定された共有を削除します。

delete(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: str | None = None, include: str | None = None, **kwargs: Any) -> None

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

share_name

str

必須

指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。

x_ms_snapshot

str

必須

省略可能。スナップショットの削除に使用されます。 既定値は [なし] です。

include

str

必須

省略可能。 有効な値は、スナップショット、leased-snapshots、none です。 既定値はスナップショットです。 "スナップショット" の場合、すべてのファイル共有スナップショットを含むファイル共有が削除されます。 ファイル共有にリーススナップショットが含まれている場合、削除は失敗します。 'leased-snapshots' の場合、ファイル共有は削除され、すべてのファイル共有スナップショット (リース済み/未リリース) が含まれます。 'none' の場合、共有スナップショットがない場合、ファイル共有は削除されます。 ファイル共有にスナップショット (リース済みまたは未リリース) が含まれている場合、削除は失敗します。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

なし、または cls(response) の結果

の戻り値の型 :

None

例外

HttpResponseError

get

指定した共有のプロパティを取得します。

get(resource_group_name: str, account_name: str, share_name: str, expand: str | None = None, x_ms_snapshot: str | None = None, **kwargs: Any) -> FileShare

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

share_name

str

必須

指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。

expand

str

必須

オプション。共有のプロパティ内のプロパティを展開するために使用されます。 有効な値は、stats です。区切り記号 ',' を含む文字列として渡す必要があります。 既定値は [なし] です。

x_ms_snapshot

str

必須

省略可能。スナップショットのプロパティを取得するために使用します。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

FileShare または cls(response) の結果

の戻り値の型 :

FileShare

例外

HttpResponseError

lease

リース共有操作は、削除操作の共有に対するロックを確立して管理します。 ロック期間は、15 ～ 60 秒にすることも、無限にすることもできます。

lease(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: str | None = None, parameters: _models.LeaseShareRequest | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LeaseShareResponse

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

share_name

str

必須

指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。

x_ms_snapshot

str

必須

省略可能。 スナップショットをリースするスナップショット時間を指定します。 既定値は [なし] です。

parameters

LeaseShareRequest または IO

必須

共有要求本文をリースします。 LeaseShareRequest 型または IO 型です。 既定値は [なし] です。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

LeaseShareResponse または cls(response) の結果

の戻り値の型 :

LeaseShareResponse

例外

HttpResponseError

list

すべての共有を一覧表示します。

list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, expand: str | None = None, **kwargs: Any) -> Iterable[FileShareItem]

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

maxpagesize

str

必須

省略可能。 リストに含めることができる共有の最大数を指定します。 既定値は [なし] です。

filter

str

必須

省略可能。 指定すると、フィルターで始まる共有名のみが一覧表示されます。 既定値は [なし] です。

expand

str

必須

オプション。共有のプロパティ内のプロパティを展開するために使用されます。 有効な値は、削除済み、スナップショットです。 区切り記号 ',' を含む文字列として渡す必要があります。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

FileShareItem のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

ItemPaged[FileShareItem]

例外

HttpResponseError

restore

共有の論理的な削除が有効になっている場合は、有効な保持期間内にファイル共有を復元します。

restore(resource_group_name: str, account_name: str, share_name: str, deleted_share: _models.DeletedShare, *, content_type: str = 'application/json', **kwargs: Any) -> None

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

share_name

str

必須

指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。

deleted_share

DeletedShare または IO

必須

DeletedShare 型または IO 型です。 必須です。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

なし、または cls(response) の結果

の戻り値の型 :

None

例外

HttpResponseError

update

更新要求本文で指定されたプロパティを共有します。 要求に記載されていないプロパティは変更されません。 指定した共有がまだ存在しない場合、更新は失敗します。

update(resource_group_name: str, account_name: str, share_name: str, file_share: _models.FileShare, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FileShare

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

share_name

str

必須

指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。

file_share

FileShare または IO

必須

ファイル共有の更新するプロパティ。 FileShare 型または IO 型です。 必須です。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

FileShare または cls(response) の結果

の戻り値の型 :

FileShare

例外

HttpResponseError

属性

models

models = <module 'azure.mgmt.storage.v2021_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2021_08_01\\models\\__init__.py'>