# Microsoft Azure SDK for Python
This is the Microsoft Azure Storage Management Client Library.
This package has been tested with Python 3.7+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).
## _Disclaimer_
_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_
# Usage
To learn how to use this package, see the [quickstart guide](https://aka.ms/azsdk/python/mgmt)
For docs and references, see [Python SDK References](https://docs.microsoft.com/python/api/overview/azure/storage?view=azure-python-preview)
Code samples for this package can be found at [Storage Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com.
Additional code samples for different Azure services are available at [Samples Repo](https://github.com/Azure-Samples/azure-samples-python-management/tree/main/samples/storage)
# Provide Feedback
If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project.

# Release History
## 21.0.0 (2022-11-15)
### Features Added
- Model ManagementPolicyBaseBlob has a new parameter tier_to_cold
- Model ManagementPolicyBaseBlob has a new parameter tier_to_hot
- Model ManagementPolicySnapShot has a new parameter tier_to_cold
- Model ManagementPolicySnapShot has a new parameter tier_to_hot
- Model ManagementPolicyVersion has a new parameter tier_to_cold
- Model ManagementPolicyVersion has a new parameter tier_to_hot
### Breaking Changes
- Operation EncryptionScopesOperations.list has a new parameter filter
- Operation EncryptionScopesOperations.list has a new parameter include
- Operation EncryptionScopesOperations.list has a new parameter maxpagesize
- Operation StorageAccountsOperations.begin_failover has a new parameter failover_type
## 20.1.0 (2022-08-09)
**Features**
- Added model AllowedMethods
- Added model LeaseContainerRequestEnum
## 20.0.0 (2022-04-06)
**Features**
- Model BlobInventoryPolicyFilter has a new parameter exclude_prefix
- Model BlobInventoryPolicyFilter has a new parameter include_deleted
- Model BlobInventoryPolicySchema has a new parameter destination
- Model DateAfterCreation has a new parameter days_after_last_tier_change_greater_than
- Model DateAfterModification has a new parameter days_after_creation_greater_than
- Model DateAfterModification has a new parameter days_after_last_tier_change_greater_than
- Model DeleteRetentionPolicy has a new parameter allow_permanent_delete
- Model KeyVaultProperties has a new parameter current_versioned_key_expiration_timestamp
- Model StorageAccount has a new parameter dns_endpoint_type
- Model StorageAccount has a new parameter storage_account_sku_conversion_status
- Model StorageAccountCreateParameters has a new parameter dns_endpoint_type
- Model StorageAccountUpdateParameters has a new parameter dns_endpoint_type
- Model Table has a new parameter signed_identifiers
**Breaking changes**
- Operation TableOperations.create has a new signature
- Operation TableOperations.update has a new signature
## 19.1.0 (2022-02-15)
**Features**
- Added operation group LocalUsersOperations
- Model ActiveDirectoryProperties has a new parameter account_type
- Model ActiveDirectoryProperties has a new parameter sam_account_name
- Model EncryptionIdentity has a new parameter encryption_federated_identity_client_id
- Model StorageAccount has a new parameter allowed_copy_scope
- Model StorageAccount has a new parameter is_local_user_enabled
- Model StorageAccount has a new parameter is_sftp_enabled
- Model StorageAccountCreateParameters has a new parameter allowed_copy_scope
- Model StorageAccountCreateParameters has a new parameter is_local_user_enabled
- Model StorageAccountCreateParameters has a new parameter is_sftp_enabled
- Model StorageAccountUpdateParameters has a new parameter allowed_copy_scope
- Model StorageAccountUpdateParameters has a new parameter is_local_user_enabled
- Model StorageAccountUpdateParameters has a new parameter is_sftp_enabled
## 19.0.0 (2021-09-14)
**Features**
- Model BlobContainer has a new parameter enable_nfs_v3_root_squash
- Model BlobContainer has a new parameter enable_nfs_v3_all_squash
- Model UpdateHistoryProperty has a new parameter allow_protected_append_writes
- Model UpdateHistoryProperty has a new parameter allow_protected_append_writes_all
- Model StorageAccountUpdateParameters has a new parameter default_to_o_auth_authentication
- Model StorageAccountUpdateParameters has a new parameter public_network_access
- Model StorageAccountUpdateParameters has a new parameter immutable_storage_with_versioning
- Model ImmutabilityPolicy has a new parameter allow_protected_append_writes_all
- Model StorageAccountCreateParameters has a new parameter default_to_o_auth_authentication
- Model StorageAccountCreateParameters has a new parameter public_network_access
- Model StorageAccountCreateParameters has a new parameter immutable_storage_with_versioning
- Model ListContainerItem has a new parameter enable_nfs_v3_root_squash
- Model ListContainerItem has a new parameter enable_nfs_v3_all_squash
- Model LegalHoldProperties has a new parameter protected_append_writes_history
- Model ImmutabilityPolicyProperties has a new parameter allow_protected_append_writes_all
- Model StorageAccount has a new parameter default_to_o_auth_authentication
- Model StorageAccount has a new parameter public_network_access
- Model StorageAccount has a new parameter immutable_storage_with_versioning
- Model LegalHold has a new parameter allow_protected_append_writes_all
- Added operation StorageAccountsOperations.begin_abort_hierarchical_namespace_migration
- Added operation StorageAccountsOperations.begin_hierarchical_namespace_migration
**Breaking changes**
- Model AccessPolicy has a new signature
## 18.0.0 (2021-05-13)
**Features**
- Model StorageAccountUpdateParameters has a new parameter allow_cross_tenant_replication
- Model BlobContainer has a new parameter immutable_storage_with_versioning
- Model FileShareItem has a new parameter lease_state
- Model FileShareItem has a new parameter lease_duration
- Model FileShareItem has a new parameter lease_status
- Model FileShareItem has a new parameter signed_identifiers
- Model FileShare has a new parameter lease_state
- Model FileShare has a new parameter lease_duration
- Model FileShare has a new parameter lease_status
- Model FileShare has a new parameter signed_identifiers
- Model StorageAccountCreateParameters has a new parameter allow_cross_tenant_replication
- Model AzureFilesIdentityBasedAuthentication has a new parameter default_share_permission
- Model StorageAccount has a new parameter allow_cross_tenant_replication
- Model ListContainerItem has a new parameter immutable_storage_with_versioning
- Added operation BlobContainersOperations.begin_object_level_worm
- Added operation FileSharesOperations.lease
**Breaking changes**
- Operation FileSharesOperations.delete has a new signature
- Model BlobInventoryPolicySchema no longer has parameter destination
- Model BlobInventoryPolicyRule has a new required parameter destination
- Model BlobInventoryPolicyDefinition has a new signature
## 17.1.0 (2021-04-13)
**Features**
- Model StorageAccountKey has a new parameter creation_time
- Model StorageAccountUpdateParameters has a new parameter sas_policy
- Model StorageAccountUpdateParameters has a new parameter key_policy
- Model StorageAccountCreateParameters has a new parameter sas_policy
- Model StorageAccountCreateParameters has a new parameter key_policy
- Model StorageAccount has a new parameter sas_policy
- Model StorageAccount has a new parameter key_policy
- Model StorageAccount has a new parameter key_creation_time
## 17.0.0 (2021-02-20)
**Features**
- Model Encryption has a new parameter encryption_identity
- Model Identity has a new parameter user_assigned_identities
- Model ManagementPolicyBaseBlob has a new parameter enable_auto_tier_to_hot_from_cool
- Model EncryptionScope has a new parameter require_infrastructure_encryption
- Model StorageAccount has a new parameter extended_location
- Model StorageAccount has a new parameter allow_shared_key_access
- Model StorageAccount has a new parameter enable_nfs_v3
- Model EncryptionScopeKeyVaultProperties has a new parameter current_versioned_key_identifier
- Model EncryptionScopeKeyVaultProperties has a new parameter last_key_rotation_timestamp
- Model DateAfterModification has a new parameter days_after_last_access_time_greater_than
- Model StorageAccountUpdateParameters has a new parameter allow_shared_key_access
- Model BlobServiceProperties has a new parameter last_access_time_tracking_policy
- Model ChangeFeed has a new parameter retention_in_days
- Model FileShare has a new parameter snapshot_time
- Model ManagementPolicyAction has a new parameter version
- Model StorageAccountCreateParameters has a new parameter extended_location
- Model StorageAccountCreateParameters has a new parameter allow_shared_key_access
- Model StorageAccountCreateParameters has a new parameter enable_nfs_v3
- Model FileShareItem has a new parameter snapshot_time
- Model FileServiceProperties has a new parameter protocol_settings
- Model ManagementPolicySnapShot has a new parameter tier_to_archive
- Model ManagementPolicySnapShot has a new parameter tier_to_cool
- Model NetworkRuleSet has a new parameter resource_access_rules
- Added operation group BlobInventoryPoliciesOperations
- Added operation group DeletedAccountsOperations
**Breaking changes**
- Operation FileSharesOperations.create has a new signature
- Operation FileSharesOperations.delete has a new signature
- Operation FileSharesOperations.get has a new signature
- Model ErrorResponse has a new signature
## 16.0.0 (2020-09-15)
**Features**
- Model RestorePolicyProperties has a new parameter min_restore_time
**Breaking changes**
- Operation ManagementPoliciesOperations.create_or_update has a new signature
- Operation ManagementPoliciesOperations.delete has a new signature
- Operation ManagementPoliciesOperations.get has a new signature
## 16.0.0b2 (2020-06-29)
This is beta preview version.
For detailed changelog please refer to equivalent stable version 11.1.0 (https://pypi.org/project/azure-mgmt-storage/11.1.0/)
## 16.0.0b1 (2020-06-17)
This is beta preview version.
This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).
**General breaking changes**
- Credential system has been completly revamped:
- `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/
- `credentials` parameter has been renamed `credential`
- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of
supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- You can't import a `version` module anymore, use `__version__` instead
- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).
- Most of the operation kwarg have changed. Some of the most noticeable:
- `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user
- For a complete set of
supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
**General new features**
- Type annotations support using `typing`. SDKs are mypy ready.
- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.
- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.
## 10.0.0 (2020-05-07)
**Features**
- Model ManagementPolicyFilter has a new parameter blob_index_match
- Model FileShareItem has a new parameter access_tier_status
- Model FileShareItem has a new parameter share_usage_bytes
- Model FileShareItem has a new parameter deleted
- Model FileShareItem has a new parameter deleted_time
- Model FileShareItem has a new parameter access_tier
- Model FileShareItem has a new parameter version
- Model FileShareItem has a new parameter root_squash
- Model FileShareItem has a new parameter enabled_protocols
- Model FileShareItem has a new parameter access_tier_change_time
- Model FileShareItem has a new parameter remaining_retention_days
- Model RestorePolicyProperties has a new parameter last_enabled_time
- Model FileShare has a new parameter access_tier_status
- Model FileShare has a new parameter share_usage_bytes
- Model FileShare has a new parameter deleted
- Model FileShare has a new parameter deleted_time
- Model FileShare has a new parameter access_tier
- Model FileShare has a new parameter version
- Model FileShare has a new parameter root_squash
- Model FileShare has a new parameter enabled_protocols
- Model FileShare has a new parameter access_tier_change_time
- Model FileShare has a new parameter remaining_retention_days
- Added operation FileSharesOperations.restore
- Added operation PrivateEndpointConnectionsOperations.list
- Added operation group ObjectReplicationPoliciesOperations
**Breaking changes**
- Operation FileSharesOperations.update has a new signature
- Operation FileSharesOperations.create has a new signature
- Operation FileSharesOperations.get has a new signature
- Operation FileSharesOperations.list has a new signature
- Operation FileSharesOperations.update has a new signature
- Operation FileSharesOperations.create has a new signature
## 9.0.0 (2020-03-27)
**Features**
- Model BlobContainer has a new parameter default_encryption_scope
- Model BlobContainer has a new parameter deny_encryption_scope_override
- Model ListContainerItem has a new parameter default_encryption_scope
- Model ListContainerItem has a new parameter deny_encryption_scope_override
- Model KeyVaultProperties has a new parameter last_key_rotation_timestamp
- Model KeyVaultProperties has a new parameter current_versioned_key_identifier
**Breaking changes**
- Operation BlobContainersOperations.update has a new signature
- Operation BlobContainersOperations.create has a new signature
- Operation BlobContainersOperations.update has a new signature
- Operation BlobContainersOperations.create has a new signature
## 8.0.0 (2020-02-27)
**Features**
- Model ImmutabilityPolicyProperties has a new parameter allow_protected_append_writes
- Model BlobServiceProperties has a new parameter container_delete_retention_policy
- Model BlobServiceProperties has a new parameter is_versioning_enabled
- Model ImmutabilityPolicy has a new parameter allow_protected_append_writes
- Added operation group EncryptionScopesOperations
**Breaking changes**
- Operation BlobContainersOperations.create_or_update_immutability_policy has a new signature
- Operation BlobContainersOperations.extend_immutability_policy has a new signature
- Operation BlobContainersOperations.create_or_update_immutability_policy has a new signature
## 7.2.0 (2020-02-10)
**Features**
- Model BlobServiceProperties has a new parameter restore_policy
- Model StorageAccount has a new parameter blob_restore_status
- Added operation StorageAccountsOperations.restore_blob_ranges
## 7.1.0 (2020-01-09)
**Features**
- Model EncryptionService has a new parameter key_type
## 7.0.0 (2019-12-04)
**Features**
- Model StorageAccountCreateParameters has a new parameter
routing_preference
- Model BlobServiceProperties has a new parameter sku
- Model FileServiceProperties has a new parameter
share_delete_retention_policy
- Model FileServiceProperties has a new parameter sku
- Model StorageAccount has a new parameter routing_preference
- Model StorageAccountUpdateParameters has a new parameter
routing_preference
- Model Endpoints has a new parameter internet_endpoints
- Model Endpoints has a new parameter microsoft_endpoints
**Breaking changes**
- Operation FileServicesOperations.set_service_properties has a new
signature
- Model Sku has a new signature
## 6.0.0 (2019-10-25)
**Features**
- Model StorageAccount has a new parameter
private_endpoint_connections
- Added operation group PrivateEndpointConnectionsOperations
- Added operation group PrivateLinkResourcesOperations
**Breaking changes**
- Operation FileSharesOperations.list has a new signature
- Operation BlobContainersOperations.list has a new signature
## 5.0.0 (2019-10-21)
**Features**
- Model AzureFilesIdentityBasedAuthentication has a new parameter
active_directory_properties
**Breaking changes**
- Operation StorageAccountsOperations.list_keys has a new signature
## 4.2.0 (2019-10-07)
**Features**
- Model StorageAccountCreateParameters has a new parameter
large_file_shares_state
- Model StorageAccountUpdateParameters has a new parameter
large_file_shares_state
- Model StorageAccount has a new parameter large_file_shares_state
## 4.1.0 (2019-09-27)
**Features**
- Model BlobServiceProperties has a new parameter change_feed
- Added operation BlobServicesOperations.list
- Added operation group FileServicesOperations
- Added operation group FileSharesOperations
## 4.0.0 (2019-06-12)
**Features**
- Model StorageAccount has a new parameter
azure_files_identity_based_authentication
- Model StorageAccountCreateParameters has a new parameter
azure_files_identity_based_authentication
- Model StorageAccountUpdateParameters has a new parameter
azure_files_identity_based_authentication
**Breaking changes**
- Model StorageAccount no longer has parameter
enable_azure_files_aad_integration
- Model StorageAccountCreateParameters no longer has parameter
enable_azure_files_aad_integration
- Model StorageAccountUpdateParameters no longer has parameter
enable_azure_files_aad_integration
**Breaking changes**
**General Breaking changes**
This version uses a next-generation code generator that *might*
introduce breaking changes while using imports. In summary, some modules
were incorrectly visible/importable and have been renamed. This fixed
several issues caused by usage of classes that were not supposed to be
used in the first place.
- StorageManagementClient cannot be imported from
`azure.mgmt.storage.storage_management_client` anymore (import
from `azure.mgmt.storage` works like before)
- StorageManagementClientConfiguration import has been moved from
`azure.mgmt.storage.network_management_client` to
`azure.mgmt.storage`
- StorageManagementClient cannot be imported from
`azure.mgmt.storage.v20xx_yy_zz.network_management_client`
anymore (import from `azure.mgmt.storage.v20xx_yy_zz` works like
before)
- StorageManagementClientConfiguration import has been moved from
`azure.mgmt.storage.v20xx_yy_zz.network_management_client` to
`azure.mgmt.storage.v20xx_yy_zz`
- A model `MyClass` from a "models" sub-module cannot be imported
anymore using `azure.mgmt.storage.v20xx_yy_zz.models.my_class`
(import from `azure.mgmt.storage.v20xx_yy_zz.models` works like
before)
- An operation class `MyClassOperations` from an `operations`
sub-module cannot be imported anymore using
`azure.mgmt.storage.v20xx_yy_zz.operations.my_class_operations`
(import from `azure.mgmt.storage.v20xx_yy_zz.operations` works
like before)
Last but not least, HTTP connection pooling is now enabled by default.
You should always use a client as a context manager, or call close(), or
use no more than one storage mgmt client per process.
## 3.3.0 (2019-04-22)
**Features**
- Model BlobServiceProperties has a new parameter
automatic_snapshot_policy_enabled
- Added operation
StorageAccountsOperations.revoke_user_delegation_keys
- Added operation BlobContainerOperations.lease
## 3.2.0 (2019-04-10)
**Features**
- Added operation BlobContainersOperations.lease for API versions
2018_02_01 and later
## 3.1.1 (2019-01-02)
**Bugfixes**
- Fix #4013 - "use_sub_domain" should be "use_sub_domain_name"
## 3.1.0 (2018-11-15)
**Features**
- Model StorageAccount has a new parameter geo_replication_stats
- Model StorageAccount has a new parameter failover_in_progress
- Added operation StorageAccountsOperations.failover
- Added operation group BlobServicesOperations
- Operation StorageAccountsOperations.get_properties now support
expand parameter
## 3.0.0 (2018-09-27)
**Features**
- Model StorageAccount has a new parameter
enable_azure_files_aad_integration
- Model StorageAccountCreateParameters has a new parameter
enable_azure_files_aad_integration
- Model StorageAccountUpdateParameters has a new parameter
enable_azure_files_aad_integration
- Added operation group ManagementPoliciesOperations. This is
considered preview and breaking changes might happen.
**Breaking changes**
- "usage" has been renamed "usages", and the "list" operation has been
replaced by "list_by_location". Ability to make usage requests
locally is not available anymore.
**Note**
- azure-mgmt-nspkg is not installed anymore on Python 3 (PEP420-based
namespace package)
## 2.0.0 (2018-08-01)
**Bugfixes**
- Set the signed resource as optional instead of required
## 2.0.0rc4 (2018-06-26)
**Features (2018-02-01/2018-03-01-preview)**
Support HDFS feature and web endpoint in Account properties
- Model StorageAccountCreateParameters has a new parameter
is_hns_enabled
- Model Endpoints has a new parameter web
- Model Endpoints has a new parameter dfs
- Model StorageAccount has a new parameter is_hns_enabled
## 2.0.0rc3 (2018-05-30)
**Features**
- Add preview version of management policy (API 2018-03-01-preview
only). This is considered preview and breaking changes might happen
if you opt in for that Api Version.
**Bugfixes**
- Correct azure-common dependency
## 2.0.0rc2 (2018-05-16)
**Bugfixes**
- Fix default "models" import to 2018-02-01
## 2.0.0rc1 (2018-05-11)
**Features**
- Add blob containers operations, immutability policy
- Add usage.list_by_location
- Client now supports Azure profiles.
- Client class can be used as a context manager to keep the underlying
HTTP session open for performance
**General Breaking changes**
This version uses a next-generation code generator that *might*
introduce breaking changes.
- Model signatures now use only keyword-argument syntax. All
positional arguments must be re-written as keyword-arguments. To
keep auto-completion in most cases, models are now generated for
Python 2 and Python 3. Python 3 uses the "*" syntax for
keyword-only arguments.
- Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
improve the behavior when unrecognized enum values are encountered.
While this is not a breaking change, the distinctions are important,
and are documented here:
<https://docs.python.org/3/library/enum.html#others> At a glance:
- "is" should not be used at all.
- "format" will return the string value, where "%s" string
formatting will return `NameOfEnum.stringvalue`. Format syntax
should be prefered.
- New Long Running Operation:
- Return type changes from
`msrestazure.azure_operation.AzureOperationPoller` to
`msrest.polling.LROPoller`. External API is the same.
- Return type is now **always** a `msrest.polling.LROPoller`,
regardless of the optional parameters used.
- The behavior has changed when using `raw=True`. Instead of
returning the initial call result as `ClientRawResponse`,
without polling, now this returns an LROPoller. After polling,
the final resource will be returned as a `ClientRawResponse`.
- New `polling` parameter. The default behavior is
`Polling=True` which will poll using ARM algorithm. When
`Polling=False`, the response of the initial call will be
returned without polling.
- `polling` parameter accepts instances of subclasses of
`msrest.polling.PollingMethod`.
- `add_done_callback` will no longer raise if called after
polling is finished, but will instead execute the callback right
away.
## 1.5.0 (2017-12-12)
**Features**
- Add StorageV2 as valid kind
- Add official support for API version 2017-10-01
## 1.4.0 (2017-09-26)
**Bug fixes**
- Add skus operations group to the generic client
**Features**
- Add official support for API version 2016-01-01
## 1.3.0 (2017-09-08)
**Features**
- Adds list_skus operation (2017-06-01)
**Breaking changes**
- Rename the preview attribute "network_acls" to "network_rule_set"
## 1.2.1 (2017-08-14)
**Bugfixes**
- Remove "tests" packaged by mistake (#1365)
## 1.2.0 (2017-07-19)
**Features**
- Api version 2017-06-01 is now the default
- This API version adds Network ACLs objects (2017-06-01 as preview)
## 1.1.0 (2017-06-28)
- Added support for https traffic only (2016-12-01)
## 1.0.0 (2017-05-15)
- Tag 1.0.0rc1 as stable (same content)
## 1.0.0rc1 (2017-04-11)
**Features**
To help customers with sovereign clouds (not general Azure), this
version has official multi ApiVersion support for 2015-06-15 and
2016-12-01
## 0.31.0 (2017-01-19)
- New `list_account_sas` operation
- New `list_service_sas` operation
- Name syntax are now checked before RestAPI call, not the server
(exception changed)
Based on API version 2016-12-01.
## 0.30.0 (2016-11-14)
- Initial release. Based on API version 2016-01-01 Note that this is
the same content as 0.30.0rc6, committed as 0.30.0.
## 0.20.0 (2015-08-31)
- Initial preview release. Based on API version 2015-05-01-preview.