Developers like to learn by looking at code, and so the Azure SDK comes with a myriad of code samples in the form of short code snippets, sample applications, and how-to guides. This document describes where to find all these resources.
The Azure SDK repository is organized in the following folder structure, with the main sample locations highlighted using bold font.
/samples
(this folder)
README.md
(this file)
/sdk
(folder containing sources, samples, test for all SDK packages)
/<samples>
/<service>
(e.g. iot)
/<package>
(e.g. hub)
README.md
(package READMEs contain hello world samples)
src
(source files for samples)
Each package folder contains a package-specific README.md
file. Most of these README
files contain Hello World
code samples illustrating basic usage of the the APIs contained in the package.
Under the /sdk/samples
directory, each service has a set of subfolders with samples for each package. These samples can either be short programs contained in *.c
files, or more complete how-to guides (code samples and some commentary) contained in *.md
files. You can find shortcuts to the main how-to guides in the How-To Guides List section below.
This section lists how-to guides for the most commonly used APIs and most common scenarios, i.e. this section does not attempt to be a complete directory of guides contained in this repository.