Repository files navigation

This repository is for the active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting ourpublic developer docs or our versioneddeveloper docs.

For your convenience, each service has a separate set of libraries that you can choose to use instead of one, large Azure package. To get started with a specific library, see theREADME.md (orREADME.rst) file located in the library's project folder.

You can find service libraries in the/sdk directory.

The client libraries are supported on Python 3.9 or later. For more details, please read our page onAzure SDK for Python version support policy.

Each service might have a number of libraries available from each of the following categories:

• Client - New Releases
• Client - Previous Versions
• Management - New Releases
• Management - Previous Versions

New wave of packages that we are announcing asGA and several that are currently releasing inpreview. These libraries allow you to use and consume existing resources and interact with them, for example: upload a blob. These libraries share several core functionalities such as: retries, logging, transport protocols, authentication protocols, etc. that can be found in theazure-core library. You can learn more about these libraries by reading guidelines that they followhere.

You can find themost up to date list of all of the new packages on our page

NOTE: If you need to ensure your code is ready for production use one of the stable, non-preview libraries.

Last stable versions of packages that have been provided for usage with Azure and are production-ready. These libraries provide you with similar functionalities to the Preview ones as they allow you to use and consume existing resources and interact with them, for example: upload a blob. They might not implement theguidelines or have the same feature set as the November releases. They do however offer wider coverage of services.

A new set of management libraries that follow theAzure SDK Design Guidelines for Python are now available. These new libraries provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more.Documentation and code samples for these new libraries can be foundhere. In addition, a migration guide that shows how to transition from older versions of libraries is locatedhere.

You can find themost up to date list of all of the new packages on our page

NOTE: If you need to ensure your code is ready for production use one of the stable, non-preview libraries. Also, if you are experiencing authentication issues with the management libraries after upgrading certain packages, it's possible that you upgraded to the new versions of SDK without changing the authentication code, please refer to the migration guide mentioned above for proper instructions.

For a complete list of management libraries that enable you to provision and manage Azure resources, pleasecheck here. They might not have the same feature set as the new releases but they do offer wider coverage of services.Management libraries can be identified by namespaces that start withazure-mgmt-, e.g.azure-mgmt-compute

• For detailed documentation visit ourAzure SDK for Python documentation
• File an issue viaGitHub Issues
• Checkprevious questions or ask new ones on StackOverflow usingazure andpython tags.

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described below. You can learn more about data collection and use in the help documentation and Microsoft’sprivacy statement. For more information on the data collected by the Azure SDK, please visit theTelemetry Guidelines page.

Telemetry collection is on by default.

To opt out, you can disable telemetry at client construction. Define aNoUserAgentPolicy class that is a subclass ofUserAgentPolicy with anon_request method that does nothing. Then pass instance of this class as kwargsuser_agent_policy=NoUserAgentPolicy() during client creation. This will disable telemetry for all methods in the client. Do this for every new client.

The example below uses theazure-storage-blob package. In your code, you can replaceazure-storage-blob with the package you are using.

importosfromazure.identityimportManagedIdentityCredentialfromazure.storage.blobimportBlobServiceClientfromazure.core.pipeline.policiesimportUserAgentPolicy# Create your credential you want to usemi_credential=ManagedIdentityCredential()account_url="https://<storageaccountname>.blob.core.windows.net"# Set up user-agent overrideclassNoUserAgentPolicy(UserAgentPolicy):defon_request(self,request):pass# Create the BlobServiceClient objectblob_service_client=BlobServiceClient(account_url,credential=mi_credential,user_agent_policy=NoUserAgentPolicy())container_client=blob_service_client.get_container_client(container=<container_name>)# TODO: do something with the container client like download blob to a file

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC)secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in theSecurity TechCenter.

For details on contributing to this repository, see thecontributing guide.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visithttps://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted theMicrosoft Open Source Code of Conduct.For more information see theCode of Conduct FAQor contactopencode@microsoft.com with any additional questions or comments.