FileSharesOperations クラス

  • リファレンス

警告

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

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

StorageManagementClient's

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

継承
builtins.object
FileSharesOperations

コンストラクター

FileSharesOperations(*args, **kwargs)

メソッド

create

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

アカウントで指定した共有を削除します。
get

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

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

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

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

create

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

create(resource_group_name: str, account_name: str, share_name: str, file_share: _models.FileShare, expand: Literal['snapshots'] = 'snapshots', *, 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
必須

省略可能。スナップショットの作成に使用されます。 既知の値は、"スナップショット" と "なし" です。 既定値は "snapshots" です。

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, **kwargs: Any) -> None

パラメーター

resource_group_name
str
必須

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

account_name
str
必須

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

share_name
str
必須

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

x_ms_snapshot
str
必須

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

cls
callable

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

戻り値

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

の戻り値の型 :

None

例外

HttpResponseError

get

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

get(resource_group_name: str, account_name: str, share_name: str, expand: Literal['stats'] = 'stats', 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" と None です。 既定値は "stats" です。

x_ms_snapshot
str
必須

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

cls
callable

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

戻り値

FileShare または cls(response) の結果

の戻り値の型 :

FileShare

例外

HttpResponseError

list

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

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

パラメーター

resource_group_name
str
必須

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

account_name
str
必須

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

maxpagesize
str
必須

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

filter
str
必須

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

expand
str または ListSharesExpand
必須

省略可能。共有のプロパティ内のプロパティを展開するために使用されます。 既知の値は、"deleted" と "snapshots" です。 既定値は [なし] です。

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.v2020_08_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2020_08_01_preview\\models\\__init__.py'>