AccessPolicy クラス

各サービスで set メソッドと get acl メソッドによって使用されるアクセス ポリシー クラス。

保存されているアクセス ポリシーでは、関連付けられている共有アクセス署名の開始時刻、有効期限、およびアクセス許可を指定できます。 リソースへのアクセスを制御する方法に応じて、格納されているアクセス ポリシー内でこれらのパラメーターをすべて指定し、Shared Access Signature の URL から省略できます。 これにより、関連付けられた署名の動作をいつでも変更または取り消しできます。 また、保存されているアクセス ポリシー内で 1 つ以上のアクセス ポリシー パラメーターを指定し、残りのパラメーターを URL で指定することもできます。 すべてのパラメーターを URL で指定することもできます。 この場合、保存されているアクセス ポリシーを使用して署名を取り消すことができますが、署名の動作を変更することはできません。

共有アクセス署名と保存されているアクセス ポリシーの組み合わせには、署名を認証するために必要なすべてのフィールドが含まれている必要があります。 必須フィールドが欠落している場合、要求は失敗します。 同様に、共有アクセス署名の URL と保存されているアクセス ポリシーの両方で同じフィールドが指定されている場合、ステータス コード 400 (Bad Request) が返されて要求は失敗します。

継承

azure.storage.fileshare._generated.models._models_py3.AccessPolicy

AccessPolicy

コンストラクター

AccessPolicy(permission=None, expiry=None, start=None)

パラメーター

名前	説明
permission	str または FileSasPermissions または ShareSasPermissions 共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 既定値: None
expiry	datetime または str 共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 既定値: None
start	datetime または str 共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure は常に値を UTC に変換します。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 既定値: None

メソッド

as_dict	json.dump を使用してシリアル化できる dict を返します。 高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。 キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。 返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。 このファイルの 3 つの例を参照してください。 attribute_transformer full_restapi_key_transformer last_restapi_key_transformer XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。
deserialize	RestAPI 構文を使用して str を解析し、モデルを返します。
enable_additional_properties_sending
from_dict	指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。 既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください
is_xml_model
serialize	このモデルから Azure に送信される JSON を返します。 これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。 XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。

as_dict

json.dump を使用してシリアル化できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。

このファイルの 3 つの例を参照してください。

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

パラメーター

名前	説明
key_transformer	<xref:function> キー トランスフォーマー関数。
keep_readonly	既定値: True

戻り値

型	説明
dict	dict JSON 互換オブジェクト

deserialize

RestAPI 構文を使用して str を解析し、モデルを返します。

deserialize(data: Any, content_type: str | None = None) -> ModelType

パラメーター

名前	説明
data 必須	str RestAPI 構造体を使用する str。 既定では JSON。
content_type	str JSON は既定で、application/xml if XML を設定します。 既定値: None

戻り値

型	説明
	このモデルのインスタンス

例外

型	説明
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。

既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

パラメーター

名前	説明
data 必須	dict RestAPI 構造体を使用したディクテーション
content_type	str JSON は既定で、application/xml if XML を設定します。 既定値: None
key_extractors	既定値: None

戻り値

型	説明
	このモデルのインスタンス

例外

型	説明
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

このモデルから Azure に送信される JSON を返します。

これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。

XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

パラメーター

名前	説明
keep_readonly	bool readonly 属性をシリアル化する場合 既定値: False

戻り値

型	説明
dict	dict JSON 互換オブジェクト