This is the Azure SDK parent repository and mostly contains documentation around guidelines and policies as well as the releases for the various languages supported by the Azure SDK.
Перейти к файлу
Heath Stewart ebd060ecef
Improve docs for Rust convenience methods (#7931)
* Improve docs for Rust convenience methods

Resolves #7928

* Document differences in approaches
2024-08-27 16:16:37 -07:00
.devcontainer Updating ruby version to 3.3 (#7606) 2024-05-30 10:59:30 -07:00
.github Sync .github/workflows directory with azure-sdk-tools repository (#7901) 2024-08-16 13:15:36 -07:00
.vscode Recommend, configure Edit csv extension (#6411) 2023-07-19 12:59:59 -07:00
_data [azure-ai-metricsadvisor] Deprecation (#7927) 2024-08-27 15:42:44 -07:00
_includes Final initial version of Rust guidelines (#7400) 2024-04-15 17:36:58 -07:00
_layouts UI improvements to AzureSDK Release Blog (#4166) 2022-04-08 19:14:30 -07:00
_posts Revert "Draft post for EngSys 2020-08-11 (#1602)" (#1641) 2020-08-10 10:41:57 +10:00
azuresdkspecs (#512) Implementation of Jekyll site (#537) 2019-08-05 07:36:50 -07:00
css Fix highligthed section issue (#4261) 2022-04-29 17:41:09 -07:00
docs Improve docs for Rust convenience methods (#7931) 2024-08-27 16:16:37 -07:00
eng Sync eng/common directory with azure-sdk-tools for PR 8875 (#7930) 2024-08-28 03:19:45 +05:30
fonts (#512) Implementation of Jekyll site (#537) 2019-08-05 07:36:50 -07:00
images UI improvements to AzureSDK Release Blog (#4166) 2022-04-08 19:14:30 -07:00
js Fix package index query parameter (#5851) 2023-03-31 08:40:41 -07:00
releases Update index.md (#7884) 2024-08-14 15:04:05 -07:00
.gitattributes Improvements to the devcontainer (#1738) 2020-08-31 12:13:22 -07:00
.gitignore Refactor the C++ guidelines (#2178) 2020-12-18 15:04:03 -08:00
CONTRIBUTING.md Updating ruby version to 3.3 (#7606) 2024-05-30 10:59:30 -07:00
Gemfile Updating ruby version to 3.3 (#7606) 2024-05-30 10:59:30 -07:00
Gemfile.lock Bump rexml from 3.3.3 to 3.3.6 (#7915) 2024-08-26 10:11:20 -07:00
LICENSE Initial commit 2018-11-08 14:03:45 -08:00
README.md Fix links to be https instead of http (#7003) 2023-11-30 14:46:21 -08:00
SECURITY.md Adding Microsoft SECURITY.MD (#4324) 2022-05-16 23:52:56 +00:00
_config.yml Fix devcontainer for azure-sdk site (#7184) 2024-02-05 12:53:12 -08:00
feed.xml (#512) Implementation of Jekyll site (#537) 2019-08-05 07:36:50 -07:00
index.md Add support for retired libraries index (#3854) 2022-02-01 16:28:09 -08:00
search.json (#512) Implementation of Jekyll site (#537) 2019-08-05 07:36:50 -07:00
sitemap.xml (#512) Implementation of Jekyll site (#537) 2019-08-05 07:36:50 -07:00

README.md

Azure SDK

The Azure SDK delivers a platform for developers to leverage the wide variety of Azure services in their language of choice. The source for the client libraries exists for the most part in repositories for each language. This repository is meant to be a jumping off point into those language specific repositories. Issues related to a specific language should be opened in the corresponding repository but cross cutting issues can be opened in this repository.

Language Design Guidelines Packages Repo Documentation
General General Design Guidelines azure-sdk Repository Official Azure Documentation
Android Design Guidelines for Android (Draft) Android Packages azure-sdk-for-android Repository Coming Soon
C# /.NET Design Guidelines for .NET .NET Packages azure-sdk-for-net Repository .NET Documentation
Go Design Guidelines for Go (Draft) Go Packages azure-sdk-for-go Repository Go Documentation
C Design Guidelines for C99 (Draft) C Packages azure-sdk-for-c Repository C Documentation
C++ Design Guidelines for C++ (Draft) C++ Packages azure-sdk-for-cpp Repository C++ Documentation
iOS Design Guidelines for iOS (Draft) iOS Packages azure-sdk-for-ios Repository Coming Soon
Java Design Guidelines for Java Java Packages azure-sdk-for-java Repository Java Documentation
JavaScript Design Guidelines for TypeScript JavaScript Packages azure-sdk-for-js Repository JavaScript Documentation
Python Design Guidelines for Python Python Packages azure-sdk-for-python Repository Python Documentation

Service teams should schedule reviews of their client libraries with the Azure SDK Architecture Board. See the Review Process for more information.

Terminology

  • SDK: Software Development Kit. This refers to the entire Azure SDK for a single language, itself broken up into numerous Azure SDK Client Libraries (as defined below).

  • Client Library. This refers to a library (and associated tools, documentation, and samples) that customers/developers use to ease working with an Azure service. There is often one client library per service and per programming language. Sometimes a single client library will contain the ability to connect to multiple services. Each client library is published separately to the appropriate language-specific package repository. These releases are performed exclusively by the Azure SDK engineering systems team. Customers/Developers consume and use each client library separately as necessary to solve their use case.

  • Package. This refers to a client library after it has been packaged for distribution for customer-developers to consume. Examples are:

    • A NuGet package for a .NET client library
    • A Maven package for a Java library
    • An npm package for a JavaScript library
    • A Python wheel for a Python library

Contributing

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, visit https://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 repos using our CLA.

Please see our contributing guide for complete instructions on how you can contribute to the Azure SDK. For instructions on how to contribute to each individual SDK, please check the CONTRIBUTING.md in each language repo.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Internal azure-sdk DevOps Wiki

Github.io linkchecker