diff --git a/sdk/storage/azure-storage-blob/api.md b/sdk/storage/azure-storage-blob/api.md index 38f4cb567710..2d4576496cd3 100644 --- a/sdk/storage/azure-storage-blob/api.md +++ b/sdk/storage/azure-storage-blob/api.md @@ -105,7 +105,7 @@ namespace azure.storage.blob ) -> Dict[str, Any]: ... - class azure.storage.blob.AccessPolicy(GenAccessPolicy): + class azure.storage.blob.AccessPolicy(_BackCompatMixin): expiry: Optional[Union[datetime, str]] permission: Optional[Union[ContainerSasPermissions, str]] start: Optional[Union[datetime, str]] @@ -198,13 +198,17 @@ namespace azure.storage.blob def from_string(cls, permission: str) -> AccountSasPermissions: ... - class azure.storage.blob.ArrowDialect(ArrowField): + class azure.storage.blob.ArrowDialect(_BackCompatMixin): + name: Optional[str] + precision: Optional[int] + scale: Optional[int] + type: str def __eq__(self, other: Any) -> bool: ... def __init__( self, - type: ArrowType, + type: str, *, name: Optional[str] = ..., precision: Optional[int] = ..., @@ -260,7 +264,7 @@ namespace azure.storage.blob TIMESTAMP_MS = "timestamp[ms]" - class azure.storage.blob.BlobAnalyticsLogging(GeneratedLogging): + class azure.storage.blob.BlobAnalyticsLogging(_BackCompatMixin): delete: bool = False read: bool = False retention_policy: RetentionPolicy @@ -324,13 +328,13 @@ namespace azure.storage.blob size: int state: BlockState - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__( self, @@ -338,39 +342,39 @@ namespace azure.storage.blob state: BlockState = BlockState.LATEST ) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.BlobClient(StorageAccountHostsMixin, StorageEncryptionMixin): implements ContextManager @@ -399,6 +403,8 @@ namespace azure.storage.blob max_single_put_size: Optional[int] = ..., min_large_block_upload_threshold: Optional[int] = ..., secondary_hostname: Optional[str] = ..., + session_account_name: Optional[str] = ..., + session_provider: SessionProvider = ..., use_byte_buffer: Optional[bool] = ..., version_id: Optional[str] = ..., **kwargs: Any @@ -1196,7 +1202,7 @@ namespace azure.storage.blob ) -> None: ... - class azure.storage.blob.BlobPrefix(ItemPaged, DictMixin): + class azure.storage.blob.BlobPrefix(ItemPaged[BlobProperties], DictMixin): command: Callable container: str current_page: Optional[List[BlobProperties]] @@ -1209,13 +1215,13 @@ namespace azure.storage.blob results_per_page: Optional[int] service_endpoint: Optional[str] - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__( self, @@ -1223,37 +1229,37 @@ namespace azure.storage.blob **kwargs: Any ) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.BlobProperties(DictMixin): @@ -1295,49 +1301,49 @@ namespace azure.storage.blob tag_count: Optional[int] tags: Optional[Dict[str, str]] - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__(self, **kwargs: Any) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.BlobQueryError: @@ -1444,7 +1450,10 @@ namespace azure.storage.blob max_single_put_size: Optional[int] = ..., min_large_block_upload_threshold: Optional[int] = ..., secondary_hostname: Optional[str] = ..., + session_account_name: Optional[str] = ..., + session_provider: SessionProvider = ..., use_byte_buffer: Optional[bool] = ..., + use_session: Optional[bool] = ..., **kwargs: Any ) -> None: ... @@ -1621,7 +1630,10 @@ namespace azure.storage.blob max_single_put_size: Optional[int] = ..., min_large_block_upload_threshold: Optional[int] = ..., secondary_hostname: Optional[str] = ..., + session_account_name: Optional[str] = ..., + session_provider: SessionProvider = ..., use_byte_buffer: Optional[bool] = ..., + use_session: Optional[bool] = ..., **kwargs: Any ) -> None: ... @@ -1922,49 +1934,49 @@ namespace azure.storage.blob public_access: Optional[str] version: Optional[str] - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__(self, **kwargs: Any) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.ContainerSasPermissions: @@ -2006,6 +2018,28 @@ namespace azure.storage.blob def from_string(cls, permission: str) -> ContainerSasPermissions: ... + class azure.storage.blob.ContainerSessionProvider: + + def __init__( + self, + service_url: str, + credential: TokenCredential, + *, + api_version: Optional[str] = ..., + **kwargs: Any + ) -> None: ... + + def get_session(self, request: PipelineRequest) -> Optional[Session]: ... + + def invalidate_session( + self, + request: PipelineRequest, + current: Session + ) -> None: ... + + def is_request_eligible(self, request: PipelineRequest) -> bool: ... + + class azure.storage.blob.ContentSettings(DictMixin): cache_control: Optional[str] content_disposition: Optional[str] @@ -2014,13 +2048,13 @@ namespace azure.storage.blob content_md5: Optional[bytearray] content_type: Optional[str] - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__( self, @@ -2033,39 +2067,39 @@ namespace azure.storage.blob **kwargs: Any ) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.CopyProperties(DictMixin): @@ -2078,52 +2112,52 @@ namespace azure.storage.blob status: Optional[str] status_description: Optional[str] - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__(self, **kwargs: Any) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... - class azure.storage.blob.CorsRule(GeneratedCorsRule): + class azure.storage.blob.CorsRule(_BackCompatMixin): allowed_headers: str allowed_methods: str allowed_origins: str @@ -2196,13 +2230,13 @@ namespace azure.storage.blob class azure.storage.blob.DelimitedJsonDialect(DictMixin): - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__( self, @@ -2211,50 +2245,50 @@ namespace azure.storage.blob **kwargs: Any ) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.DelimitedTextDialect(DictMixin): - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__( self, @@ -2267,39 +2301,39 @@ namespace azure.storage.blob **kwargs: Any ) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.ExponentialRetry(StorageRetryPolicy): @@ -2343,62 +2377,62 @@ namespace azure.storage.blob name: str tags: Optional[Dict[str, str]] - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__(self, **kwargs: Any) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.ImmutabilityPolicy(DictMixin): expiry_time: Optional[datetime] policy_mode: Optional[str] - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__( self, @@ -2407,39 +2441,39 @@ namespace azure.storage.blob **kwargs: Any ) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.LeaseProperties(DictMixin): @@ -2447,49 +2481,49 @@ namespace azure.storage.blob state: str status: str - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__(self, **kwargs: Any) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.LinearRetry(StorageRetryPolicy): @@ -2531,7 +2565,7 @@ namespace azure.storage.blob SECONDARY = secondary - class azure.storage.blob.Metrics(GeneratedMetrics): + class azure.storage.blob.Metrics(_BackCompatMixin): enabled: bool = False include_apis: Optional[bool] retention_policy: RetentionPolicy @@ -2592,98 +2626,98 @@ namespace azure.storage.blob policy_id: str rules: List[ObjectReplicationRule] - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__(self, **kwargs: Any) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.ObjectReplicationRule(DictMixin): rule_id: str status: str - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__(self, **kwargs: Any) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.PageRange(DictMixin): @@ -2691,13 +2725,13 @@ namespace azure.storage.blob end: Optional[int] start: Optional[int] - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__( self, @@ -2707,39 +2741,39 @@ namespace azure.storage.blob cleared: bool = False ) -> None: ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.PartialBatchErrorException(HttpResponseError): @@ -2799,7 +2833,7 @@ namespace azure.storage.blob def from_string(cls, string: str) -> ResourceTypes: ... - class azure.storage.blob.RetentionPolicy(GeneratedRetentionPolicy): + class azure.storage.blob.RetentionPolicy(_BackCompatMixin): days: Optional[int] enabled: bool = False @@ -2872,6 +2906,86 @@ namespace azure.storage.blob def from_string(cls, string: str) -> Services: ... + class azure.storage.blob.Session: + REFRESH_BUFFER: timedelta + + def __init__( + self, + session_token: Optional[str], + session_key: Optional[str], + expires_at: datetime, + is_fallback: bool = False + ) -> None: ... + + def expired(self) -> bool: ... + + + class azure.storage.blob.SessionProvider(Protocol): + + def get_session(self, request: PipelineRequest) -> Optional[Session]: ... + + def invalidate_session( + self, + request: PipelineRequest, + current: Session + ) -> None: ... + + def is_request_eligible(self, request: PipelineRequest) -> bool: ... + + + class azure.storage.blob.SignedIdentifier(DictMixin): + access_policy: Optional[AccessPolicy] + id: str + + def __contains__(self, key: object) -> bool: ... + + def __delitem__(self, key: str) -> None: ... + + def __eq__(self, other: object) -> bool: ... + + def __getitem__(self, key: str) -> Any: ... + + def __init__( + self, + id: str, + access_policy: Optional[AccessPolicy] = None + ) -> None: ... + + def __len__(self) -> int: ... + + def __ne__(self, other: object) -> bool: ... + + def __repr__(self) -> str: ... + + def __setitem__( + self, + key: str, + item: Any + ) -> None: ... + + def __str__(self) -> str: ... + + def get( + self, + key: str, + default: Any = None + ) -> Any: ... + + def has_key(self, k: object) -> bool: ... + + def items(self) -> list[tuple[str, Any]]: ... + + def keys(self) -> list[str]: ... + + def update( + self, + *args: Any, + **kwargs: Any + ) -> None: ... + + def values(self) -> list[Any]: ... + + class azure.storage.blob.StandardBlobTier(str, Enum, metaclass=CaseInsensitiveEnumMeta): ARCHIVE = "Archive" COLD = "Cold" @@ -2880,7 +2994,7 @@ namespace azure.storage.blob SMART = "Smart" - class azure.storage.blob.StaticWebsite(GeneratedStaticWebsite): + class azure.storage.blob.StaticWebsite(_BackCompatMixin): default_index_document_path: Optional[str] enabled: bool = False error_document404_path: Optional[str] @@ -2973,6 +3087,7 @@ namespace azure.storage.blob DESTINATION_PATH_IS_BEING_DELETED = "DestinationPathIsBeingDeleted" DIRECTORY_NOT_EMPTY = "DirectoryNotEmpty" EMPTY_METADATA_KEY = "EmptyMetadataKey" + FEATURE_NOT_ENABLED = "FeatureNotEnabled" FEATURE_VERSION_MISMATCH = "FeatureVersionMismatch" FILE_LOCK_CONFLICT = "FileLockConflict" FILE_SHARE_PROVISIONED_BANDWIDTH_DOWNGRADE_NOT_ALLOWED = "FileShareProvisionedBandwidthDowngradeNotAllowed" @@ -3076,6 +3191,7 @@ namespace azure.storage.blob SEQUENCE_NUMBER_CONDITION_NOT_MET = "SequenceNumberConditionNotMet" SEQUENCE_NUMBER_INCREMENT_TOO_LARGE = "SequenceNumberIncrementTooLarge" SERVER_BUSY = "ServerBusy" + SESSIONS_UNAVAILABLE = "SessionOperationsTemporarilyUnavailable" SHARE_ALREADY_EXISTS = "ShareAlreadyExists" SHARE_BEING_DELETED = "ShareBeingDeleted" SHARE_DISABLED = "ShareDisabled" @@ -3232,7 +3348,10 @@ namespace azure.storage.blob.aio max_single_put_size: Optional[int] = ..., min_large_block_upload_threshold: Optional[int] = ..., secondary_hostname: Optional[str] = ..., + session_account_name: Optional[str] = ..., + session_provider: SessionProvider = ..., use_byte_buffer: Optional[bool] = ..., + use_session: Optional[bool] = ..., version_id: Optional[str] = ..., **kwargs: Any ) -> None: ... @@ -4036,13 +4155,13 @@ namespace azure.storage.blob.aio results_per_page: Optional[int] service_endpoint: Optional[str] - def __contains__(self, key): ... + def __contains__(self, key: object) -> bool: ... - def __delitem__(self, key): ... + def __delitem__(self, key: str) -> None: ... - def __eq__(self, other): ... + def __eq__(self, other: object) -> bool: ... - def __getitem__(self, key): ... + def __getitem__(self, key: str) -> Any: ... def __init__( self, @@ -4050,39 +4169,39 @@ namespace azure.storage.blob.aio **kwargs ): ... - def __len__(self): ... + def __len__(self) -> int: ... - def __ne__(self, other): ... + def __ne__(self, other: object) -> bool: ... - def __repr__(self): ... + def __repr__(self) -> str: ... def __setitem__( self, - key, - item - ): ... + key: str, + item: Any + ) -> None: ... - def __str__(self): ... + def __str__(self) -> str: ... def get( self, - key, - default = None - ): ... + key: str, + default: Any = None + ) -> Any: ... - def has_key(self, k): ... + def has_key(self, k: object) -> bool: ... - def items(self): ... + def items(self) -> list[tuple[str, Any]]: ... - def keys(self): ... + def keys(self) -> list[str]: ... def update( self, - *args, - **kwargs - ): ... + *args: Any, + **kwargs: Any + ) -> None: ... - def values(self): ... + def values(self) -> list[Any]: ... class azure.storage.blob.aio.BlobServiceClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, StorageEncryptionMixin): implements AsyncContextManager @@ -4108,7 +4227,10 @@ namespace azure.storage.blob.aio max_single_put_size: Optional[int] = ..., min_large_block_upload_threshold: Optional[int] = ..., secondary_hostname: Optional[str] = ..., + session_account_name: Optional[str] = ..., + session_provider: SessionProvider = ..., use_byte_buffer: Optional[bool] = ..., + use_session: Optional[bool] = ..., **kwargs: Any ) -> None: ... @@ -4273,7 +4395,10 @@ namespace azure.storage.blob.aio max_single_put_size: Optional[int] = ..., min_large_block_upload_threshold: Optional[int] = ..., secondary_hostname: Optional[str] = ..., + session_account_name: Optional[str] = ..., + session_provider: SessionProvider = ..., use_byte_buffer: Optional[bool] = ..., + use_session: Optional[bool] = ..., **kwargs: Any ) -> None: ... @@ -4549,6 +4674,30 @@ namespace azure.storage.blob.aio ) -> AsyncItemPaged[Union[BlobProperties, BlobPrefix]]: ... + class azure.storage.blob.aio.ContainerSessionProvider: implements AsyncContextManager + + def __init__( + self, + service_url: str, + credential: AsyncTokenCredential, + *, + api_version: Optional[str] = ..., + **kwargs: Any + ) -> None: ... + + async def close(self) -> None: ... + + async def get_session(self, request: PipelineRequest) -> Optional[Session]: ... + + async def invalidate_session( + self, + request: PipelineRequest, + current: Session + ) -> None: ... + + def is_request_eligible(self, request: PipelineRequest) -> bool: ... + + class azure.storage.blob.aio.ExponentialRetry(AsyncStorageRetryPolicy): increment_base: int initial_backoff: int @@ -4619,6 +4768,19 @@ namespace azure.storage.blob.aio ): ... + class azure.storage.blob.aio.SessionProvider(Protocol): + + async def get_session(self, request: PipelineRequest) -> Optional[Session]: ... + + async def invalidate_session( + self, + request: PipelineRequest, + current: Session + ) -> None: ... + + def is_request_eligible(self, request: PipelineRequest) -> bool: ... + + class azure.storage.blob.aio.StorageStreamDownloader(Generic[T]): container: str name: str diff --git a/sdk/storage/azure-storage-blob/api.metadata.yml b/sdk/storage/azure-storage-blob/api.metadata.yml index 4d9417b9e97f..5868fe41ea43 100644 --- a/sdk/storage/azure-storage-blob/api.metadata.yml +++ b/sdk/storage/azure-storage-blob/api.metadata.yml @@ -1,5 +1,5 @@ -apiHash: 1aa9a41876d0be96d35f66712bb6f992726f12ccfb2935c14b46856622419620 +apiHash: 80e4671bc82b63fd45cd845a1ca610e347896e18a84106976f0125ac5a8af063 packageRelativePath: sdk/storage/azure-storage-blob -packageVersion: 12.31.0 +packageVersion: 12.33.0b1 parserVersion: 0.3.31 pythonVersion: 3.12.15